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 template <class Other>
 132 prefix_ void senf::Packet::finalizeTo()
 133 {
 134     Packet p (find<Other>(nothrow));
 135     ptr()->finalizeTo(p ? p.ptr() : last().ptr());
 136 }
 137
 138 ///////////////////////////////////////////////////////////////////////////
 139 // senf::ConcretePacket<PacketType>
 140
 141 // structors and default members
 142
 143 template <class PacketType>
 144 prefix_ senf::ConcretePacket<PacketType>::ConcretePacket()
 145 {}
 146
 147 template <class PacketType>
 148 prefix_ typename senf::ConcretePacket<PacketType>::factory_t
 149 senf::ConcretePacket<PacketType>::factory()
 150 {
 151     return interpreter::factory();
 152 }
 153
 154 // Create completely new packet
 155
 156 template <class PacketType>
 157 prefix_ senf::ConcretePacket<PacketType>
 158 senf::ConcretePacket<PacketType>::create()
 159 {
 160     return ConcretePacket(interpreter::create());
 161 }
 162
 163 template <class PacketType>
 164 prefix_ senf::ConcretePacket<PacketType>
 165 senf::ConcretePacket<PacketType>::create(senf::NoInit_t)
 166 {
 167     return ConcretePacket(interpreter::create(senf::noinit));
 168 }
 169
 170 template <class PacketType>
 171 prefix_ senf::ConcretePacket<PacketType>
 172 senf::ConcretePacket<PacketType>::create(size_type size)
 173 {
 174     return ConcretePacket(interpreter::create(size));
 175 }
 176
 177 template <class PacketType>
 178 prefix_ senf::ConcretePacket<PacketType>
 179 senf::ConcretePacket<PacketType>::create(size_type size, senf::NoInit_t)
 180 {
 181     return ConcretePacket(interpreter::create(size,senf::noinit));
 182 }
 183
 184 #ifndef DOXYGEN
 185
 186 template <class PacketType>
 187 template <class ForwardReadableRange>
 188 prefix_ senf::ConcretePacket<PacketType> senf::ConcretePacket<PacketType>::
 189 create(ForwardReadableRange const & range,
 190        typename boost::disable_if< boost::is_integral<ForwardReadableRange> >::type *)
 191 {
 192     return ConcretePacket(interpreter::create(range));
 193 }
 194
 195 #endif
 196
 197 // Create packet as new packet after a given packet
 198
 199 template <class PacketType>
 200 prefix_ senf::ConcretePacket<PacketType>
 201 senf::ConcretePacket<PacketType>::createAfter(Packet packet)
 202 {
 203     return ConcretePacket(interpreter::createAfter(packet.ptr()));
 204 }
 205
 206 template <class PacketType>
 207 prefix_ senf::ConcretePacket<PacketType>
 208 senf::ConcretePacket<PacketType>::createAfter(Packet packet, senf::NoInit_t)
 209 {
 210     return ConcretePacket(interpreter::createAfter(packet.ptr(),senf::noinit));
 211 }
 212
 213 template <class PacketType>
 214 prefix_ senf::ConcretePacket<PacketType>
 215 senf::ConcretePacket<PacketType>::createAfter(Packet packet, size_type size)
 216 {
 217     return ConcretePacket(interpreter::createAfter(packet.ptr(), size));
 218 }
 219
 220 template <class PacketType>
 221 prefix_ senf::ConcretePacket<PacketType>
 222 senf::ConcretePacket<PacketType>::createAfter(Packet packet, size_type size, senf::NoInit_t)
 223 {
 224     return ConcretePacket(interpreter::createAfter(packet.ptr(), size, senf::noinit));
 225 }
 226
 227 #ifndef DOXYGEN
 228
 229 template <class PacketType>
 230 template <class ForwardReadableRange>
 231 prefix_ senf::ConcretePacket<PacketType> senf::ConcretePacket<PacketType>::
 232 createAfter(Packet packet, ForwardReadableRange const & range,
 233             typename boost::disable_if< boost::is_integral<ForwardReadableRange> >::type *)
 234 {
 235     return ConcretePacket(interpreter::createAfter(packet.ptr(), range));
 236 }
 237
 238 #endif
 239
 240 // Create packet as new packet (header) before a given packet
 241
 242 template <class PacketType>
 243 prefix_ senf::ConcretePacket<PacketType>
 244 senf::ConcretePacket<PacketType>::createBefore(Packet packet)
 245 {
 246     return ConcretePacket(interpreter::createBefore(packet.ptr()));
 247 }
 248
 249 template <class PacketType>
 250 prefix_ senf::ConcretePacket<PacketType>
 251 senf::ConcretePacket<PacketType>::createBefore(Packet packet, senf::NoInit_t)
 252 {
 253     return ConcretePacket(interpreter::createBefore(packet.ptr(), senf::noinit));
 254 }
 255
 256 // Create a clone of the current packet
 257
 258 template <class PacketType>
 259 prefix_ senf::ConcretePacket<PacketType>
 260 senf::ConcretePacket<PacketType>::clone()
 261     const
 262 {
 263     return ConcretePacket(ptr()->clone());
 264 }
 265
 266 // Field access
 267
 268 template <class PacketType>
 269 prefix_ typename senf::ConcretePacket<PacketType>::Parser *
 270 senf::ConcretePacket<PacketType>::operator->()
 271     const
 272 {
 273     return ptr()->fields_p();
 274 }
 275
 276 template <class PacketType>
 277 prefix_ typename senf::ConcretePacket<PacketType>::Parser
 278 senf::ConcretePacket<PacketType>::parser()
 279     const
 280 {
 281     return ptr()->fields();
 282 }
 283
 284 // private members
 285
 286 template <class PacketType>
 287 prefix_ senf::ConcretePacket<PacketType>::ConcretePacket(typename interpreter::ptr packet_)
 288     : Packet(packet_)
 289 {}
 290
 291 template <class PacketType>
 292 prefix_ typename senf::ConcretePacket<PacketType>::interpreter::ptr
 293 senf::ConcretePacket<PacketType>::ptr()
 294     const
 295 {
 296     return boost::static_pointer_cast< PacketInterpreter<PacketType> >(Packet::ptr());
 297 }
 298
 299 ///////////////////////////////cti.e///////////////////////////////////////
 300 #undef prefix_
 301
 302 \f
 303 // Local Variables:
 304 // mode: c++
 305 // fill-column: 100
 306 // c-file-style: "senf"
 307 // indent-tabs-mode: nil
 308 // ispell-local-dictionary: "american"
 309 // compile-command: "scons -u test"
 310 // comment-column: 40
 311 // End: