switch to new MPL based Fraunhofer FOKUS Public License
[senf.git] / senf / Packets / PacketType.ct
1 // $Id$
2 //
3 // Copyright (C) 2008
4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 //
6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
7 // Version 1.0 (the "License"); you may not use this file except in compliance
8 // with the License. You may obtain a copy of the License at 
9 // http://senf.berlios.de/license.html
10 //
11 // The Fraunhofer FOKUS Public License Version 1.0 is based on, 
12 // but modifies the Mozilla Public License Version 1.1.
13 // See the full license text for the amendments.
14 //
15 // Software distributed under the License is distributed on an "AS IS" basis, 
16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 
17 // for the specific language governing rights and limitations under the License.
18 //
19 // The Original Code is Fraunhofer FOKUS code.
20 //
21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V. 
22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
23 // All Rights Reserved.
24 //
25 // Contributor(s):
26 //   Stefan Bund <g0dil@berlios.de>
27
28 /** \file
29     \brief PacketType non-inline template implementation  */
30
31 //#include "PacketType.ih"
32
33 // Custom includes
34
35 #define prefix_
36 //-/////////////////////////////////////////////////////////////////////////////////////////////////
37
38 //-/////////////////////////////////////////////////////////////////////////////////////////////////
39 // senf::PacketTypeMixin<Self,void>
40
41 template <class Self>
42 prefix_ senf::PacketInterpreterBase::optional_range
43 senf::PacketTypeMixin<Self,void>::nextPacketRange(ConcretePacket<Self> const & p)
44 {
45     typename Self::size_type sz (Self::initHeadSize());
46     ///\idea This if condition could be replaced with a compile time switch by checking, whether
47     /// (the function address) Self::initHeadSize is different from PacketTypeBase::initHeadSize
48     if (sz == PacketTypeBase::size_type(-1)) {
49         typename Self::size_type headsz (bytes(p.parser()));
50         return p.data().size() < headsz ?
51             PacketTypeBase::no_range() :
52             PacketInterpreterBase::optional_range(
53                 PacketTypeBase::range(boost::next(p.data().begin(), headsz),
54                                       p.data().end()));
55     }
56     else
57         // If we have a trailer, we do *not* use the 'bytes' value but initSize/initHeadSize, this
58         // is much safer since the bytes() value will probably not be very correct anyways (what
59         // should it return ? the size of the header only, the combined size of header and trailer
60         // or the size of the packet from header to trailer including payload?).
61         //
62         // So, the helper only works with fixed-size parsers if the packet has a trailer.
63         return p.data().size() < Self::initSize() ?
64             PacketTypeBase::no_range() :
65             PacketInterpreterBase::optional_range(
66                 PacketTypeBase::range(boost::next(p.data().begin(),sz),
67                                       boost::prior(p.data().end(),Self::initSize()-sz)));
68 }
69
70 //-/////////////////////////////////////////////////////////////////////////////////////////////////
71 #undef prefix_
72
73 \f
74 // Local Variables:
75 // mode: c++
76 // fill-column: 100
77 // comment-column: 40
78 // c-file-style: "senf"
79 // indent-tabs-mode: nil
80 // ispell-local-dictionary: "american"
81 // compile-command: "scons -u test"
82 // End: