Packets/80221Bundle/MIHPacket.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2009
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Thorsten Horstmann <tho@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \file
  24     \brief MIH protocol public header */
  25
  26 #ifndef HH_SENF_Packets_80221Bundle_MIHPacket_
  27 #define HH_SENF_Packets_80221Bundle_MIHPacket_ 1
  28
  29 // Custom includes
  30 #include "../../Packets/Packets.hh"
  31 #include "../../Socket/Protocols/Raw/MACAddress.hh"
  32 #include "../../Socket/Protocols/INet/INet4Address.hh"
  33 #include "../../Socket/Protocols/INet/INet6Address.hh"
  34 #include "TLVPacket.hh"
  35 #include <boost/function_output_iterator.hpp>
  36 #include <boost/iterator/filter_iterator.hpp>
  37
  38
  39 //#include "MIHPacket.mpp"
  40 ///////////////////////////////hh.p////////////////////////////////////////
  41
  42 namespace senf {
  43
  44     /** \brief Parse a MIHF_ID
  45
  46          the maximum length of a MIHF_ID is 253 octets (see F.3.11 in 802.21)
  47          we could set maxLengthValue in init(), but for the most MIHF_IDs the default
  48          maximum length of 127 should be enough.
  49
  50          \note you must call mihfIdPacket.maxLengthValue( 253) *before*
  51          setting longer MIHF_IDs values.
  52     */
  53     class MIHFId_TLVParser : public BaseTLVPacketParser
  54     {
  55     #   include SENF_PARSER()
  56         SENF_PARSER_INHERIT  ( BaseTLVPacketParser );
  57         SENF_PARSER_SKIP     ( length(), 0         );
  58         SENF_PARSER_FINALIZE ( MIHFId_TLVParser    );
  59
  60         std::string asString() const;
  61         void setString(std::string const &id);
  62
  63         senf::MACAddress asMACAddress() const;
  64         void setMACAddress(senf::MACAddress const &mac);
  65
  66         senf::INet4Address asINet4Address() const;
  67         void setINet4Address(senf::INet4Address const &addr);
  68
  69         senf::INet6Address asINet6Address() const;
  70         void setINet6Address(senf::INet6Address const &addr);
  71
  72     private:
  73         template <class OutputIterator>
  74         struct binaryNAIEncoder {
  75             binaryNAIEncoder(OutputIterator &i) : i_(i) {}
  76             void operator()(const boost::uint8_t &v) const {
  77                 *i_++ = '\\';
  78                 *i_++ = v;
  79             }
  80             OutputIterator &i_;
  81         };
  82         template <class OutputIterator>
  83         static boost::function_output_iterator<binaryNAIEncoder<OutputIterator> > getNAIEncodedOutputIterator(OutputIterator i) {
  84             return boost::make_function_output_iterator(binaryNAIEncoder<OutputIterator>(i));
  85         }
  86
  87         struct binaryNAIDecoder {
  88             binaryNAIDecoder() : readNextByte_(true) {}
  89             bool operator()(const boost::uint8_t &v) {
  90                 readNextByte_ = readNextByte_ ? false : true;
  91                 return readNextByte_;
  92             }
  93             bool readNextByte_;
  94         };
  95         template <class Iterator>
  96         static boost::filter_iterator<binaryNAIDecoder, Iterator> getNAIDecodedIterator(Iterator begin, Iterator end) {
  97             return boost::make_filter_iterator<binaryNAIDecoder>(begin, end);
  98         }
  99     };
 100
 101     /** \brief Parse a MIH packet
 102
 103         Parser implementing the MIH header. The fields implemented are:
 104         \image html MIHPacket.png
 105
 106         \see MIHPacketType
 107      */
 108     struct MIHPacketParser : public PacketParserBase
 109     {
 110     #   include SENF_PARSER()
 111
 112         SENF_PARSER_BITFIELD_RO ( version,       4,  unsigned );
 113         SENF_PARSER_BITFIELD    ( ackRequest,    1,  bool     );
 114         SENF_PARSER_BITFIELD    ( ackResponse,   1,  bool     );
 115         SENF_PARSER_BITFIELD    ( uir,           1,  bool     );
 116         SENF_PARSER_BITFIELD    ( moreFragment,  1,  bool     );
 117         SENF_PARSER_BITFIELD    ( fragmentNr,    7,  unsigned );
 118         SENF_PARSER_SKIP_BITS   ( 1                           );
 119
 120         // MIH message ID (MID)
 121         SENF_PARSER_BITFIELD ( sid,     4,  unsigned );
 122         SENF_PARSER_BITFIELD ( opcode,  2,  unsigned );
 123         SENF_PARSER_BITFIELD ( aid,    10,  unsigned );
 124
 125         SENF_PARSER_SKIP_BITS ( 4                           );
 126         SENF_PARSER_BITFIELD  ( transactionId, 12, unsigned );
 127         SENF_PARSER_FIELD_RO  ( payloadLength, UInt16Parser );
 128
 129         // Source MIHF Id
 130         SENF_PARSER_FIELD ( src_mihfId, MIHFId_TLVParser );
 131         // Destination MIHF Id
 132         SENF_PARSER_FIELD ( dst_mihfId, MIHFId_TLVParser );
 133
 134         SENF_PARSER_FINALIZE ( MIHPacketParser );
 135
 136         SENF_PARSER_INIT() {
 137             version_() = 1;
 138             src_mihfId().type() = 1;
 139             dst_mihfId().type() = 2;
 140         }
 141
 142         friend class MIHPacketType;
 143     };
 144
 145     /** \brief MIH packet
 146
 147         \par Packet type (typedef):
 148             \ref MIHPacket
 149
 150         \par Fields:
 151             \ref MIHPacketParser
 152
 153         \ingroup protocolbundle_80221
 154      */
 155     struct MIHPacketType
 156         : public PacketTypeBase,
 157           public PacketTypeMixin<MIHPacketType>
 158     {
 159 #ifndef DOXYGEN
 160         typedef PacketTypeMixin<MIHPacketType> mixin;
 161 #endif
 162         typedef ConcretePacket<MIHPacketType> packet; ///< MIH packet typedef
 163         typedef MIHPacketParser parser;               ///< typedef to the parser of MIH packet
 164
 165         using mixin::nextPacketRange;
 166         using mixin::init;
 167         using mixin::initSize;
 168
 169         /** \brief Dump given MIH packet in readable form to given output stream */
 170         static void dump(packet p, std::ostream &os);
 171         static void finalize(packet p);
 172         static factory_t nextPacketType(packet p);
 173     };
 174
 175     /** \brief MIH packet typedef */
 176     typedef ConcretePacket<MIHPacketType> MIHPacket;
 177
 178
 179     struct MIHPayloadPacketParser : public PacketParserBase
 180     {
 181     #   include SENF_PARSER()
 182         SENF_PARSER_LIST ( tlv_list, packetSize(), GenericTLVPacketParser );
 183
 184         SENF_PARSER_FINALIZE ( MIHPayloadPacketParser );
 185     };
 186
 187     struct MIHPayloadPacketType
 188         : public PacketTypeBase,
 189           public PacketTypeMixin<MIHPayloadPacketType>
 190     {
 191 #ifndef DOXYGEN
 192         typedef PacketTypeMixin<MIHPayloadPacketType> mixin;
 193 #endif
 194         typedef ConcretePacket<MIHPayloadPacketType> packet; ///< MIH Payload packet typedef
 195         typedef MIHPayloadPacketParser parser; ///< typedef to the parser of MIH Payload packet
 196
 197         using mixin::nextPacketRange;
 198         using mixin::init;
 199         using mixin::initSize;
 200
 201         /** \brief Dump given MIHPayload in readable form to given output stream */
 202         static void dump(packet p, std::ostream &os);
 203     };
 204
 205      /** \brief MIH Payload packet typedef */
 206     typedef ConcretePacket<MIHPayloadPacketType> MIHPayloadPacket;
 207 }
 208
 209
 210 ///////////////////////////////hh.e////////////////////////////////////////
 211 #endif
 212 #ifndef SENF_PACKETS_DECL_ONLY
 213 //#include "MIHPacket.cci"
 214 //#include "MIHPacket.ct"
 215 //#include "MIHPacket.cti"
 216 #endif
 217
 218
 219 // Local Variables:
 220 // mode: c++
 221 // fill-column: 100
 222 // c-file-style: "senf"
 223 // indent-tabs-mode: nil
 224 // ispell-local-dictionary: "american"
 225 // compile-command: "scons -u test"
 226 // comment-column: 40
 227 // End: