Packets/Packet.cti

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@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 Packet inline template implementation */
  25
  26 //#include "Packet.ih"
  27
  28 // Custom includes
  29 #include "../Utils/Exception.hh"
  30
  31 #define prefix_ inline
  32 ///////////////////////////////cti.p///////////////////////////////////////
  33
  34 ///////////////////////////////////////////////////////////////////////////
  35 // senf::Packet
  36
  37 // conversion constructors
  38
  39 template <class PacketType>
  40 prefix_ senf::Packet::Packet(ConcretePacket<PacketType> packet)
  41     : packet_(packet.ptr())
  42 {}
  43
  44 // interpreter chain access
  45
  46 template <class OtherPacket>
  47 prefix_ OtherPacket senf::Packet::parseNextAs()
  48     const
  49 {
  50     return OtherPacket(ptr()->parseNextAs<typename OtherPacket::type>());
  51 }
  52
  53 template <class OtherPacket>
  54 prefix_ bool senf::Packet::is()
  55     const
  56 {
  57     return ptr()->is<typename OtherPacket::type>();
  58 }
  59
  60 template <class OtherPacket>
  61 prefix_ OtherPacket senf::Packet::as()
  62     const
  63 {
  64     if (!is<OtherPacket>())
  65         throw WrapException<std::bad_cast>(std::bad_cast());
  66     return OtherPacket(ptr()->as<typename OtherPacket::type>());
  67 }
  68
  69 template <class OtherPacket>
  70 prefix_ OtherPacket senf::Packet::next()
  71     const
  72 {
  73     return next().as<OtherPacket>();
  74 }
  75
  76 template <class OtherPacket>
  77 prefix_ OtherPacket senf::Packet::next(NoThrow_t)
  78     const
  79 {
  80     Packet p (next(nothrow));
  81     return p && p.is<OtherPacket>() ? p.as<OtherPacket>() : OtherPacket();
  82 }
  83
  84 template <class OtherPacket>
  85 prefix_ OtherPacket senf::Packet::find()
  86     const
  87 {
  88     OtherPacket p (find<OtherPacket>(nothrow));
  89     if (!p) throw InvalidPacketChainException();
  90     return p;
  91 }
  92
  93 template <class OtherPacket>
  94 prefix_ OtherPacket senf::Packet::prev()
  95     const
  96 {
  97     return prev().as<OtherPacket>();
  98 }
  99
 100 template <class OtherPacket>
 101 prefix_ OtherPacket senf::Packet::prev(NoThrow_t)
 102     const
 103 {
 104     Packet p (prev(nothrow));
 105     return p && p.is<OtherPacket>() ? p.as<OtherPacket>() : OtherPacket();
 106 }
 107
 108 template <class OtherPacket>
 109 prefix_ OtherPacket senf::Packet::rfind()
 110     const
 111 {
 112     OtherPacket p (rfind<OtherPacket>(nothrow));
 113     if (!p) throw InvalidPacketChainException();
 114     return p;
 115 }
 116
 117 template <class OtherPacket>
 118 prefix_ OtherPacket senf::Packet::last()
 119     const
 120 {
 121     return last().as<OtherPacket>();
 122 }
 123
 124 template <class OtherPacket>
 125 prefix_ OtherPacket senf::Packet::first()
 126     const
 127 {
 128     return first().as<OtherPacket>();
 129 }
 130
 131 ///////////////////////////////////////////////////////////////////////////
 132 // senf::ConcretePacket<PacketType>
 133
 134 // structors and default members
 135
 136 template <class PacketType>
 137 prefix_ senf::ConcretePacket<PacketType>::ConcretePacket()
 138 {}
 139
 140 template <class PacketType>
 141 prefix_ typename senf::ConcretePacket<PacketType>::factory_t
 142 senf::ConcretePacket<PacketType>::factory()
 143 {
 144     return interpreter::factory();
 145 }
 146
 147 // Create completely new packet
 148
 149 template <class PacketType>
 150 prefix_ senf::ConcretePacket<PacketType>
 151 senf::ConcretePacket<PacketType>::create()
 152 {
 153     return ConcretePacket(interpreter::create());
 154 }
 155
 156 template <class PacketType>
 157 prefix_ senf::ConcretePacket<PacketType>
 158 senf::ConcretePacket<PacketType>::create(senf::NoInit_t)
 159 {
 160     return ConcretePacket(interpreter::create(senf::noinit));
 161 }
 162
 163 template <class PacketType>
 164 prefix_ senf::ConcretePacket<PacketType>
 165 senf::ConcretePacket<PacketType>::create(size_type size)
 166 {
 167     return ConcretePacket(interpreter::create(size));
 168 }
 169
 170 template <class PacketType>
 171 prefix_ senf::ConcretePacket<PacketType>
 172 senf::ConcretePacket<PacketType>::create(size_type size, senf::NoInit_t)
 173 {
 174     return ConcretePacket(interpreter::create(size,senf::noinit));
 175 }
 176
 177 #ifndef DOXYGEN
 178
 179 template <class PacketType>
 180 template <class ForwardReadableRange>
 181 prefix_ senf::ConcretePacket<PacketType> senf::ConcretePacket<PacketType>::
 182 create(ForwardReadableRange const & range,
 183        typename boost::disable_if< boost::is_integral<ForwardReadableRange> >::type *)
 184 {
 185     return ConcretePacket(interpreter::create(range));
 186 }
 187
 188 #endif
 189
 190 // Create packet as new packet after a given packet
 191
 192 template <class PacketType>
 193 prefix_ senf::ConcretePacket<PacketType>
 194 senf::ConcretePacket<PacketType>::createAfter(Packet packet)
 195 {
 196     return ConcretePacket(interpreter::createAfter(packet.ptr()));
 197 }
 198
 199 template <class PacketType>
 200 prefix_ senf::ConcretePacket<PacketType>
 201 senf::ConcretePacket<PacketType>::createAfter(Packet packet, senf::NoInit_t)
 202 {
 203     return ConcretePacket(interpreter::createAfter(packet.ptr(),senf::noinit));
 204 }
 205
 206 template <class PacketType>
 207 prefix_ senf::ConcretePacket<PacketType>
 208 senf::ConcretePacket<PacketType>::createAfter(Packet packet, size_type size)
 209 {
 210     return ConcretePacket(interpreter::createAfter(packet.ptr(), size));
 211 }
 212
 213 template <class PacketType>
 214 prefix_ senf::ConcretePacket<PacketType>
 215 senf::ConcretePacket<PacketType>::createAfter(Packet packet, size_type size, senf::NoInit_t)
 216 {
 217     return ConcretePacket(interpreter::createAfter(packet.ptr(), size, senf::noinit));
 218 }
 219
 220 #ifndef DOXYGEN
 221
 222 template <class PacketType>
 223 template <class ForwardReadableRange>
 224 prefix_ senf::ConcretePacket<PacketType> senf::ConcretePacket<PacketType>::
 225 createAfter(Packet packet, ForwardReadableRange const & range,
 226             typename boost::disable_if< boost::is_integral<ForwardReadableRange> >::type *)
 227 {
 228     return ConcretePacket(interpreter::createAfter(packet.ptr(), range));
 229 }
 230
 231 #endif
 232
 233 // Create packet as new packet (header) before a given packet
 234
 235 template <class PacketType>
 236 prefix_ senf::ConcretePacket<PacketType>
 237 senf::ConcretePacket<PacketType>::createBefore(Packet packet)
 238 {
 239     return ConcretePacket(interpreter::createBefore(packet.ptr()));
 240 }
 241
 242 template <class PacketType>
 243 prefix_ senf::ConcretePacket<PacketType>
 244 senf::ConcretePacket<PacketType>::createBefore(Packet packet, senf::NoInit_t)
 245 {
 246     return ConcretePacket(interpreter::createBefore(packet.ptr(), senf::noinit));
 247 }
 248
 249 // Create a clone of the current packet
 250
 251 template <class PacketType>
 252 prefix_ senf::ConcretePacket<PacketType>
 253 senf::ConcretePacket<PacketType>::clone()
 254     const
 255 {
 256     return ConcretePacket(ptr()->clone());
 257 }
 258
 259 // Field access
 260
 261 template <class PacketType>
 262 prefix_ typename senf::ConcretePacket<PacketType>::Parser *
 263 senf::ConcretePacket<PacketType>::operator->()
 264     const
 265 {
 266     return ptr()->fields_p();
 267 }
 268
 269 template <class PacketType>
 270 prefix_ typename senf::ConcretePacket<PacketType>::Parser
 271 senf::ConcretePacket<PacketType>::parser()
 272     const
 273 {
 274     return ptr()->fields();
 275 }
 276
 277 // private members
 278
 279 template <class PacketType>
 280 prefix_ senf::ConcretePacket<PacketType>::ConcretePacket(typename interpreter::ptr packet_)
 281     : Packet(packet_)
 282 {}
 283
 284 template <class PacketType>
 285 prefix_ typename senf::ConcretePacket<PacketType>::interpreter::ptr
 286 senf::ConcretePacket<PacketType>::ptr()
 287     const
 288 {
 289     return boost::static_pointer_cast< PacketInterpreter<PacketType> >(Packet::ptr());
 290 }
 291
 292 ///////////////////////////////cti.e///////////////////////////////////////
 293 #undef prefix_
 294
 295 \f
 296 // Local Variables:
 297 // mode: c++
 298 // fill-column: 100
 299 // c-file-style: "senf"
 300 // indent-tabs-mode: nil
 301 // ispell-local-dictionary: "american"
 302 // compile-command: "scons -u test"
 303 // comment-column: 40
 304 // End: