SocketPolicy.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
//


#ifndef HH_SENF_Socket_SocketPolicy_
#define HH_SENF_Socket_SocketPolicy_ 1

// Custom includes

//#include "SocketPolicy.mpp"
//-/////////////////////////////////////////////////////////////////////////////////////////////////

namespace senf {

    //\{

    // This may be adapted to change the supported policies (however, ClientSocketHandle and
    // ServerSocketHandle will probably have to be adjusted accordingly)

#   define SENF_SOCKET_POLICIES                 \
        (AddressingPolicy)                      \
        (FramingPolicy)                         \
        (CommunicationPolicy)                   \
        (ReadPolicy)                            \
        (WritePolicy)

    // Wer define these classes explicitly (and not with some macro
    // magic) because
    // a) AddressingPolicyBase is different from all the others
    // b) We want to document each one explicitly

    struct AddressingPolicyBase
    {
        virtual ~AddressingPolicyBase();

        class Address { Address(); };
    };

    struct FramingPolicyBase
    {
        virtual ~FramingPolicyBase();
    };

    struct CommunicationPolicyBase
    {
        virtual ~CommunicationPolicyBase();
    };

    struct ReadPolicyBase
    {
        virtual ~ReadPolicyBase();

        class Buffer { Buffer(); };
    };

    struct WritePolicyBase
    {
        virtual ~WritePolicyBase();

        class Buffer { Buffer(); };
    };

    // The implementation file will for each Policy declared above
    // define the following (SomePolicy is one of the above):
    //
    // struct SomePolicyBase;
    // typedef UndefinedSomePolicy;
    // template SomePolicyIs< SocketPolicy, Axis >
    // template IfSomePolicyIs< SocketPolicy, Axis >
    // template IfSomePolicyIsNot< SocketPolicy, Axis >
    //
    // Additionally the following are defined:
    //
    // class SocketPolicyBase
    // template SocketPolicy< ..policies.. >
    // template MakeSocketPolicy< ..args.. >
    // template SocketPolicyIsBaseOf< Base, Derived >

#   ifdef DOXYGEN

    // The following stub definitions are only visible to doxygen

    typedef AddressingPolicyBase UnspecifiedAddressingPolicy;

    template <class SocketPolicy, class Trait>
    struct AddressingPolicyIs
    {};

    template <class SocketPolicy, class Trait>
    struct IfAddressingPolicyIs
    {};

    template <class SocketPolicy, class Trait>
    struct IfAddressingPolicyIsNot
    {};

    struct SocketPolicyBase
    {
        AddressingPolicyBase const & theAddressingPolicy() const = 0;

        virtual ~SocketPolicyBase();
    };

    template < class AddressingPolicy >
    struct SocketPolicy
    {
        static void checkBaseOf(SocketPolicyBase const & other);
    };

    template <class Arg1, class Arg2, class ArgN>
    struct MakeSocketPolicy
    {};

    template <class Base, class Derived>
    struct SocketPolicyIsBaseOf
    {};

#   endif

    //\}
}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
#include "SocketPolicy.ih"
//#include "SocketPolicy.cci"
#include "SocketPolicy.ct"
//#include "SocketPolicy.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: