A Discrete-Event Network Simulator
API
ethernet-trailer.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2007 Emmanuelle Laprise
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Emmanuelle Laprise <emmanuelle.laprise@bluekazoo.ca>
19  */
20 
21 #ifndef ETHERNET_TRAILER_H
22 #define ETHERNET_TRAILER_H
23 
24 #include "ns3/trailer.h"
25 #include "ns3/packet.h"
26 #include <string>
27 
28 namespace ns3 {
29 
30 
39 class EthernetTrailer : public Trailer
40 {
41 public:
45  EthernetTrailer ();
46 
51  void EnableFcs (bool enable);
52 
59  void CalcFcs (Ptr<const Packet> p);
60 
65  void SetFcs (uint32_t fcs);
66 
70  uint32_t GetFcs () const;
71 
86  bool CheckFcs (Ptr<const Packet> p) const;
87 
91  uint32_t GetTrailerSize () const;
92 
97  static TypeId GetTypeId (void);
98  virtual TypeId GetInstanceTypeId (void) const;
99  virtual void Print (std::ostream &os) const;
100  virtual uint32_t GetSerializedSize (void) const;
101  virtual void Serialize (Buffer::Iterator end) const;
102  virtual uint32_t Deserialize (Buffer::Iterator end);
103 private:
108  bool m_calcFcs;
109  uint32_t m_fcs;
110 
111 };
112 
113 } // namespace ns3
114 
115 #endif /* ETHERNET_TRAILER_H */
virtual uint32_t GetSerializedSize(void) const
void CalcFcs(Ptr< const Packet > p)
Updates the Fcs Field to the correct FCS.
void SetFcs(uint32_t fcs)
Sets the FCS to a new value.
uint32_t GetTrailerSize() const
uint32_t m_fcs
Value of the fcs contained in the trailer.
iterator in a Buffer instance
Definition: buffer.h:98
uint32_t GetFcs() const
virtual uint32_t Deserialize(Buffer::Iterator end)
static TypeId GetTypeId(void)
Get the type ID.
EthernetTrailer()
Construct a null ethernet trailer.
bool m_calcFcs
Enabled FCS calculations.
Protocol trailer serialization and deserialization.
Definition: trailer.h:40
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Packet trailer for Ethernet.
void EnableFcs(bool enable)
Enable or disable FCS checking and calculations.
virtual TypeId GetInstanceTypeId(void) const
Get the most derived TypeId for this Object.
virtual void Serialize(Buffer::Iterator end) const
bool CheckFcs(Ptr< const Packet > p) const
Calculate an FCS on the provided packet and check this value against the FCS found when the trailer w...
virtual void Print(std::ostream &os) const
a unique identifier for an interface.
Definition: type-id.h:58