MIHPacket.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_80221Bundle_MIHPacket_
#define HH_SENF_Packets_80221Bundle_MIHPacket_ 1

// Custom includes
#include <senf/Packets/Packets.hh>
#include <senf/Packets/DefaultBundle/Registries.hh>
#include "TLVParser.hh"
#include "MIHMessageRegistry.hh"

//#include "MIHPacket.mpp"
//-/////////////////////////////////////////////////////////////////////////////////////////////////

namespace senf {

    struct MIHPacketParser : public PacketParserBase
    {
    #   include SENF_PARSER()

        SENF_PARSER_BITFIELD_RO( version,       4,  unsigned );
        SENF_PARSER_BITFIELD   ( ackRequest,    1,  bool     );
        SENF_PARSER_BITFIELD   ( ackResponse,   1,  bool     );
        SENF_PARSER_BITFIELD   ( uir,           1,  bool     );
        SENF_PARSER_BITFIELD   ( moreFragment,  1,  bool     );
        SENF_PARSER_BITFIELD   ( fragmentNr,    7,  unsigned );
        SENF_PARSER_SKIP_BITS  ( 1                           );

        // MIH message ID (MID)
        SENF_PARSER_FIELD   ( messageId, UInt16Parser ); //<pkgdraw:hide
        SENF_PARSER_GOTO    ( messageId               );
        SENF_PARSER_BITFIELD( sid,     4,  unsigned   );
        SENF_PARSER_BITFIELD( opcode,  2,  unsigned   );
        SENF_PARSER_BITFIELD( aid,    10,  unsigned   );

        SENF_PARSER_SKIP_BITS( 4                           );
        SENF_PARSER_BITFIELD ( transactionId, 12, unsigned );
        SENF_PARSER_FIELD_RO ( payloadLength, UInt16Parser );

        SENF_PARSER_GOTO_OFFSET( 8, 8); // just to limit the offset calculation

        // Source MIHF Id
        SENF_PARSER_FIELD( src_mihfId, MIHFSrcIdTLVParser );
        // Destination MIHF Id
        SENF_PARSER_FIELD( dst_mihfId, MIHFDstIdTLVParser );

        SENF_PARSER_FINALIZE( MIHPacketParser );

        SENF_PARSER_INIT() {
            defaultInit();
            version_() = 1;
        }

        friend struct MIHPacketType;
    };

    struct MIHPacketType
        : public PacketTypeBase,
          public PacketTypeMixin<MIHPacketType, MIHMessageRegistry>
    {
        typedef PacketTypeMixin<MIHPacketType, MIHMessageRegistry> mixin;
        typedef ConcretePacket<MIHPacketType> packet; 
        typedef MIHPacketParser parser;               

        using mixin::nextPacketRange;
        using mixin::init;
        using mixin::initSize;

        static void dump(packet p, std::ostream & os);
        static void finalize(packet p);
        static factory_t nextPacketType(packet p);
        static void validate(packet p);

        static const EtherTypes::key_t etherType = 0x8917;
    };

    typedef ConcretePacket<MIHPacketType> MIHPacket;
    SENF_PACKET_PREVENT_TEMPLATE_INSTANTIATION( MIHPacket );


    struct MIHGenericPayloadPacketParser : public PacketParserBase
    {
    #   include SENF_PARSER()
        SENF_PARSER_TLV_LIST( tlvList, packetSize(), MIHGenericTLVParser );
        SENF_PARSER_FINALIZE( MIHGenericPayloadPacketParser );
    };

    struct MIHGenericPayloadPacketType
        : public PacketTypeBase,
          public PacketTypeMixin<MIHGenericPayloadPacketType>
    {
        typedef PacketTypeMixin<MIHGenericPayloadPacketType> mixin;
        typedef ConcretePacket<MIHGenericPayloadPacketType> packet; 
        typedef MIHGenericPayloadPacketParser parser; 

        using mixin::nextPacketRange;
        using mixin::init;
        using mixin::initSize;

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

    typedef ConcretePacket<MIHGenericPayloadPacketType> MIHGenericPayloadPacket;
    SENF_PACKET_PREVENT_TEMPLATE_INSTANTIATION( MIHGenericPayloadPacket );
}


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