SocketProtocol.hh

Go to the documentation of this file.

//
// Copyright (c) 2020 Fraunhofer Institute for Applied Information Technology (FIT)
//                    Network Research Group (NET)
//                    Schloss Birlinghoven, 53754 Sankt Augustin, GERMANY
//                    Contact: support@wiback.org
//
// This file is part of the SENF code tree.
// It is licensed under the 3-clause BSD License (aka New BSD License).
// See LICENSE.txt in the top level directory for details or visit
// https://opensource.org/licenses/BSD-3-Clause
//


// The private inheritance idea should indeed work very well: We just need to change the
// implementations of body() and protocol() and that of the ProtocolClient/ServerSocketHandle
// constructors and the SocketBody constructor. The body and the protocol would still be visible
// like several instances because of the private inheritance but we would save the backwards
// pointer.

#ifndef HH_SENF_Socket_SocketProtocol_
#define HH_SENF_Socket_SocketProtocol_ 1

// Custom includes
#include <boost/noncopyable.hpp>
// Hrmpf ... I have tried very hard, but I just can't find a nice, generic way to clean
// up this include
#include "SocketHandle.ih"

//#include "SocketProtocol.mpp"
//-/////////////////////////////////////////////////////////////////////////////////////////////////

namespace senf {

    //\{

    struct SocketPolicyBase;

    class SocketProtocol
        : boost::noncopyable
    {
    public:
        //-////////////////////////////////////////////////////////////////////////
        // Types

        //-////////////////////////////////////////////////////////////////////////
        //\{

        SocketProtocol();
        virtual ~SocketProtocol() = 0;

        // default default constructor
        // no copy
        // no conversion constructors

        //\}
        //-////////////////////////////////////////////////////////////////////////

        virtual SocketPolicyBase const & policy() const = 0;

        //-////////////////////////////////////////////////////////////////////////
        // Virtual interface

        virtual unsigned available() const = 0;

        virtual bool eof() const = 0;   

        virtual void close();           

        virtual void terminate() const; 

        virtual void state(SocketStateMap & map, unsigned lod) const;

        int fd() const;                 

    protected:
        FileHandle fh() const;          

        void fd(int) const;             

    private:
        virtual std::unique_ptr<SocketBody> clone(bool isServer) const = 0;
        virtual std::unique_ptr<SocketBody> clone(int fd, bool isServer) const = 0;
        virtual SocketBody & body() const = 0;

        friend class SocketBody;
    };

    template <class SPolicy> class ClientSocketHandle;
    template <class SPolicy> class ServerSocketHandle;

    template <class SocketPolicy, class Self>
    class ConcreteSocketProtocol
        : public virtual SocketProtocol
    {
    public:
        //-////////////////////////////////////////////////////////////////////////
        // Types

        typedef SocketPolicy Policy;    

        //-////////////////////////////////////////////////////////////////////////
        //\{

        ~ConcreteSocketProtocol() = 0;

        // no default constructor
        // no copy
        // no conversion constructors

        //\}
        //-////////////////////////////////////////////////////////////////////////

        Policy const & policy() const;

    protected:
        ClientSocketHandle<Policy> clientHandle() const;

        ServerSocketHandle<Policy> serverHandle() const;

    private:
        virtual std::unique_ptr<SocketBody> clone(bool isServer) const;
        virtual std::unique_ptr<SocketBody> clone(int fd, bool isServer) const;
        virtual SocketBody & body() const;

        Policy policy_;
    };

    //\}
}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
#include "SocketProtocol.cci"
//#include "SocketProtocol.ct"
#include "SocketProtocol.cti"
#endif


// Local Variables:
// mode: c++
// fill-column: 100
// c-file-style: "senf"
// indent-tabs-mode: nil
// ispell-local-dictionary: "american"
// compile-command: "scons -u test"
// comment-column: 40
// End: