Fix documentation build under maverick (doxygen 1.7.1)
[senf.git] / senf / Packets / DefaultBundle / EthernetPacket.cc
1 // $Id$
2 //
3 // Copyright (C) 2006
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 EthernetPacket non-inline non-template implementation */
25
26 #include "EthernetPacket.hh"
27 //#include "EthernetPacket.ih"
28
29 // Custom includes
30 #include "LlcSnapPacket.hh"
31 #include <iomanip>
32 #include <boost/io/ios_state.hpp>
33 #include <senf/Utils/Format.hh>
34
35 #define prefix_
36 //-/////////////////////////////////////////////////////////////////////////////////////////////////
37
38 namespace {
39     SENF_PACKET_REGISTRY_REGISTER( senf::EtherTypes, 0x8100, senf::EthVLanPacket);
40 }
41
42 //-/////////////////////////////////////////////////////////////////////////////////////////////////
43 // senf::EthernetPacketType
44
45 prefix_ void senf::EthernetPacketType::dump(packet p, std::ostream & os)
46 {
47     boost::io::ios_all_saver ias(os);
48     if (p->type_length() <= 1500)
49         os << "Ethernet 802.3";
50     else if (p->type_length() >= 0x600)
51         os << "Ethernet II (DIX)";
52     else
53         os << "Ethernet 802.3 (bad ethertype >1500 and <1536)";
54     os <<     ": \n"
55        << senf::fieldName("destination")               << p->destination() << "\n"
56        << senf::fieldName("source")                    << p->source() << "\n"
57        << senf::fieldName("type/length")               << senf::format::dumpint(p->type_length().value()) << "\n";
58 }
59
60 prefix_ senf::PacketInterpreterBase::factory_t senf::EthernetPacketType::nextPacketType(packet p)
61 {
62     if      (p->type_length() >= 1536) return lookup(p->type_length());
63     else if (p->type_length() <= 1500) return LlcSnapPacket::factory();
64     else                               return no_factory();
65 }
66
67 prefix_ void senf::EthernetPacketType::finalize(packet p)
68 {
69     Packet n (p.next(nothrow));
70     if (n) {
71         optional_key_t k (key(n));
72         if (k)
73             p->type_length() << k;
74         else if (n.is<LlcSnapPacket>())
75             p->type_length() << n.data().size();
76     }
77     // Do NOT reset type_length if the type is not known ... doing this will destroy read packets
78 }
79
80 prefix_ void senf::EthVLanPacketType::dump(packet p, std::ostream & os)
81 {
82     boost::io::ios_all_saver ias(os);
83     os << "Ethernet 802.1q (VLAN):\n"
84        << senf::fieldName("priority")                  << p->priority() << "\n"
85        << senf::fieldName("cfi")                       << p->cfi() << "\n"
86        << senf::fieldName("vlan-ID")                   << p->vlanId() << "\n"
87        << senf::fieldName("ethertype")
88        << " 0x" << std::hex << std::setw(4) << std::setfill('0') << p->type() << "\n";
89 }
90
91 prefix_ void senf::EthVLanPacketType::finalize(packet p)
92 {
93     p->type() << key(p.next(nothrow));
94 }
95
96
97 //-/////////////////////////////////////////////////////////////////////////////////////////////////
98 #undef prefix_
99
100 \f
101 // Local Variables:
102 // mode: c++
103 // fill-column: 100
104 // c-file-style: "senf"
105 // indent-tabs-mode: nil
106 // ispell-local-dictionary: "american"
107 // compile-command: "scons -u test"
108 // comment-column: 40
109 // End: