Packet header for PPP. More...
#include "ppp-header.h"
Public Member Functions | |
PppHeader () | |
Construct a PPP header. | |
~PppHeader () override | |
Destroy a PPP header. | |
uint32_t | Deserialize (Buffer::Iterator start) override |
TypeId | GetInstanceTypeId () const override |
Get the TypeId of the instance. | |
uint16_t | GetProtocol () const |
Get the protocol type carried by this PPP packet. | |
uint32_t | GetSerializedSize () const override |
void | Print (std::ostream &os) const override |
void | Serialize (Buffer::Iterator start) const override |
void | SetProtocol (uint16_t protocol) |
Set the protocol type carried by this PPP packet. | |
Public Member Functions inherited from ns3::Header | |
~Header () override | |
uint32_t | Deserialize (Buffer::Iterator start) override=0 |
virtual uint32_t | Deserialize (Buffer::Iterator start)=0 |
Deserialize the object from a buffer iterator. | |
virtual uint32_t | Deserialize (Buffer::Iterator start, Buffer::Iterator end) |
Deserialize the object from a buffer iterator. | |
virtual uint32_t | GetSerializedSize () const =0 |
void | Print (std::ostream &os) const override=0 |
virtual void | Serialize (Buffer::Iterator start) const =0 |
virtual uint32_t | Deserialize (Buffer::Iterator start)=0 |
Deserialize the object from a buffer iterator. | |
virtual uint32_t | Deserialize (Buffer::Iterator start, Buffer::Iterator end) |
Deserialize the object from a buffer iterator. | |
virtual void | Print (std::ostream &os) const =0 |
Print the object contents. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
virtual TypeId | GetInstanceTypeId () const =0 |
Get the most derived TypeId for this Object. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Get the TypeId. | |
Static Public Member Functions inherited from ns3::Header | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Chunk | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Private Attributes | |
uint16_t | m_protocol |
The PPP protocol type of the payload packet. | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
Packet header for PPP.
Introspection did not find any typical Config paths.
This class can be used to add a header to PPP packet. Currently we do not implement any of the state machine in RFC 1661, we just encapsulate the inbound packet send it on. The goal here is not really to implement the point-to-point protocol, but to encapsulate our packets in a known protocol so packet sniffers can parse them.
if PPP is transmitted over a serial link, it will typically be framed in some way derivative of IBM SDLC (HDLC) with all that that entails. Thankfully, we don't have to deal with all of that – we can use our own protocol for getting bits across the serial link which we call an ns3 Packet. What we do have to worry about is being able to capture PPP frames which are understandable by Wireshark. All this means is that we need to teach the PcapWriter about the appropriate data link type (DLT_PPP = 9), and we need to add a PPP header to each packet. Since we are not using framed PPP, this just means prepending the sixteen bit PPP protocol number to the packet. The ns-3 way to do this is via a class that inherits from class Header.
No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 16 bytes (on a 64-bit architecture).
Definition at line 48 of file ppp-header.h.
ns3::PppHeader::PppHeader | ( | ) |
Construct a PPP header.
Definition at line 34 of file ppp-header.cc.
|
override |
Destroy a PPP header.
Definition at line 38 of file ppp-header.cc.
|
overridevirtual |
start | an iterator which points to where the header should read from. |
This method is used by Packet::RemoveHeader to re-create a header from the byte buffer of a packet. The data read is expected to match bit-for-bit the representation of this header in real networks.
Note that data is not actually removed from the buffer to which the iterator points. Both Packet::RemoveHeader() and Packet::PeekHeader() call Deserialize(), but only the RemoveHeader() has additional statements to remove the header bytes from the underlying buffer and associated metadata.
Implements ns3::Header.
Definition at line 90 of file ppp-header.cc.
References GetSerializedSize(), and m_protocol.
|
overridevirtual |
Get the TypeId of the instance.
Implements ns3::ObjectBase.
Definition at line 53 of file ppp-header.cc.
References GetTypeId().
uint16_t ns3::PppHeader::GetProtocol | ( | ) | const |
Get the protocol type carried by this PPP packet.
The type numbers to be used are defined in RFC 3818
Definition at line 103 of file ppp-header.cc.
References m_protocol.
Referenced by ns3::PointToPointNetDevice::ProcessHeader().
|
overridevirtual |
This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. This method should return the number of bytes which are needed to store the full header data by Serialize.
Implements ns3::Header.
Definition at line 78 of file ppp-header.cc.
Referenced by Deserialize().
|
static |
Get the TypeId.
Definition at line 43 of file ppp-header.cc.
References ns3::TypeId::SetParent().
Referenced by GetInstanceTypeId().
|
overridevirtual |
os | output stream This method is used by Packet::Print to print the content of a header as ascii data to a c++ output stream. Although the header is free to format its output as it wishes, it is recommended to follow a few rules to integrate with the packet pretty printer: start with flags, small field values located between a pair of parens. Values should be separated by whitespace. Follow the parens with the important fields, separated by whitespace. i.e.: (field1 val1 field2 val2 field3 val3) field4 val4 field5 val5 |
Implements ns3::Header.
Definition at line 59 of file ppp-header.cc.
References m_protocol, and NS_ASSERT_MSG.
|
overridevirtual |
start | an iterator which points to where the header should be written. |
This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. The data written is expected to match bit-for-bit the representation of this header in a real network.
Implements ns3::Header.
Definition at line 84 of file ppp-header.cc.
References m_protocol.
void ns3::PppHeader::SetProtocol | ( | uint16_t | protocol | ) |
Set the protocol type carried by this PPP packet.
The type numbers to be used are defined in RFC 3818
protocol | the protocol type being carried |
Definition at line 97 of file ppp-header.cc.
References m_protocol.
Referenced by ns3::PointToPointNetDevice::AddHeader().
|
private |
The PPP protocol type of the payload packet.
Definition at line 102 of file ppp-header.h.
Referenced by Deserialize(), GetProtocol(), Print(), Serialize(), and SetProtocol().