PacketType.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_Packets_PacketType_
#define HH_SENF_Packets_PacketType_ 1

// Custom includes
#include <iosfwd>
#include "PacketTypes.hh"
#include "PacketData.hh"
#include "PacketParser.hh"
#include "Packet.hh"

//#include "PacketType.mpp"
//-/////////////////////////////////////////////////////////////////////////////////////////////////

namespace senf {

    struct PacketTypeBase
    {
        typedef Packet packet;

        typedef senf::detail::packet::iterator iterator;
        typedef senf::detail::packet::const_iterator const_iterator;
        typedef senf::detail::packet::size_type size_type;
        typedef senf::detail::packet::difference_type difference_type;
        typedef senf::detail::packet::byte byte;

        typedef PacketInterpreterBase::range range;
        typedef PacketInterpreterBase::optional_range optional_range;
        typedef PacketInterpreterBase::factory_t factory_t;

        static optional_range no_range();
        static factory_t no_factory();
        template <class PacketType> static factory_t factory();

        typedef VoidPacketParser parser;

        static size_type initSize();

        static size_type initHeadSize();

        static void init(packet p);

        static optional_range nextPacketRange(packet p);

        static factory_t nextPacketType(packet p);

        static void finalize(packet p);

        static void dump(packet p, std::ostream & os);

    };


    template <class Self, class Registry=void>
    class PacketTypeMixin
    {
    public:
        typedef typename Registry::key_t key_t;
        typedef boost::optional<key_t> optional_key_t;

        static optional_key_t key (Packet const & p); 

        static PacketTypeBase::factory_t lookup (key_t key); 

        //\{

        static PacketInterpreterBase::optional_range nextPacketRange (ConcretePacket<Self> const & p);
        static PacketInterpreterBase::factory_t      nextPacketType  (ConcretePacket<Self> const & p);
        static PacketInterpreterBase::size_type      initSize        ();
        static void                                  init            (ConcretePacket<Self> const & p);

        //\}
    };

#   ifndef DOXYGEN

    template <class Self>
    class PacketTypeMixin<Self,void>
    {
    public:
        static PacketInterpreterBase::optional_range nextPacketRange (ConcretePacket<Self> const & p);
        static PacketInterpreterBase::size_type      initSize        ();
        static void                                  init            (ConcretePacket<Self> const & p);
    };

#   endif

}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
#endif
#if !defined(HH_SENF_Packets_Packets__decls_) && !defined(HH_SENF_Packets_PacketType_i_)
#define HH_SENF_Packets_PacketType_i_
#include "PacketType.cci"
#include "PacketType.ct"
#include "PacketType.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: