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