Fix documentation build under maverick (doxygen 1.7.1)
[senf.git] / senf / Packets / PacketType.ct
1 // $Id$
2 //
3 // Copyright (C) 2008
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 PacketType non-inline template implementation  */
25
26 //#include "PacketType.ih"
27
28 // Custom includes
29
30 #define prefix_
31 //-/////////////////////////////////////////////////////////////////////////////////////////////////
32
33 //-/////////////////////////////////////////////////////////////////////////////////////////////////
34 // senf::PacketTypeMixin<Self,void>
35
36 template <class Self>
37 prefix_ senf::PacketInterpreterBase::optional_range
38 senf::PacketTypeMixin<Self,void>::nextPacketRange(ConcretePacket<Self> const & p)
39 {
40     typename Self::size_type sz (Self::initHeadSize());
41     ///\idea This if condition could be replaced with a compile time switch by checking, whether
42     /// (the function address) Self::initHeadSize is different from PacketTypeBase::initHeadSize
43     if (sz == PacketTypeBase::size_type(-1)) {
44         typename Self::size_type headsz (bytes(p.parser()));
45         return p.data().size() < headsz ?
46             PacketTypeBase::no_range() :
47             PacketInterpreterBase::optional_range(
48                 PacketTypeBase::range(boost::next(p.data().begin(), headsz),
49                                       p.data().end()));
50     }
51     else
52         // If we have a trailer, we do *not* use the 'bytes' value but initSize/initHeadSize, this
53         // is much safer since the bytes() value will probably not be very correct anyways (what
54         // should it return ? the size of the header only, the combined size of header and trailer
55         // or the size of the packet from header to trailer including payload?).
56         //
57         // So, the helper only works with fixed-size parsers if the packet has a trailer.
58         return p.data().size() < Self::initSize() ?
59             PacketTypeBase::no_range() :
60             PacketInterpreterBase::optional_range(
61                 PacketTypeBase::range(boost::next(p.data().begin(),sz),
62                                       boost::prior(p.data().end(),Self::initSize()-sz)));
63 }
64
65 //-/////////////////////////////////////////////////////////////////////////////////////////////////
66 #undef prefix_
67
68 \f
69 // Local Variables:
70 // mode: c++
71 // fill-column: 100
72 // comment-column: 40
73 // c-file-style: "senf"
74 // indent-tabs-mode: nil
75 // ispell-local-dictionary: "american"
76 // compile-command: "scons -u test"
77 // End: