#include <ppp-header.h>

Inheritance diagram for ns3::PppHeader:

Collaboration diagram for ns3::PppHeader:

Public Member Functions
	PppHeader ()
	Construct a PPP header. More...

virtual	~PppHeader ()
	Destroy a PPP header. More...

virtual uint32_t	Deserialize (Buffer::Iterator start)

virtual TypeId	GetInstanceTypeId (void) const

uint16_t	GetProtocol (void)
	Get the protocol type carried by this PPP packet. More...

virtual uint32_t	GetSerializedSize (void) const

virtual void	Print (std::ostream &os) const

virtual void	Serialize (Buffer::Iterator start) const

void	SetProtocol (uint16_t protocol)
	Set the protocol type carried by this PPP packet. More...

Public Member Functions inherited from ns3::Header
virtual	~Header ()

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

void	GetAttribute (std::string name, AttributeValue &value) const

bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const

void	SetAttribute (std::string name, const AttributeValue &value)

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::Header
static TypeId	GetTypeId (void)
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Chunk
static TypeId	GetTypeId (void)
	Get the type ID. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Private Attributes
uint16_t	m_protocol
	The PPP protocol type of the payload packet. More...

Additional Inherited Members
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Detailed Description

Packet header for PPP.

Doxygen 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.

Definition at line 48 of file ppp-header.h.

Constructor & Destructor Documentation

ns3::PppHeader::PppHeader ( )

Construct a PPP header.

Definition at line 32 of file ppp-header.cc.

ns3::PppHeader::~PppHeader ( )

virtual

Destroy a PPP header.

Definition at line 36 of file ppp-header.cc.

Member Function Documentation

uint32_t ns3::PppHeader::Deserialize ( Buffer::Iterator start )

virtual

Parameters

start an iterator which points to where the header should written.

Returns: the number of bytes read.

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.

Implements ns3::Header.

Definition at line 88 of file ppp-header.cc.

References GetSerializedSize(), m_protocol, and ns3::Buffer::Iterator::ReadNtohU16().

Here is the call graph for this function:

TypeId ns3::PppHeader::GetInstanceTypeId ( void ) const

virtual

Returns: the TypeId associated to the most-derived type of this instance.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Implements ns3::ObjectBase.

Definition at line 51 of file ppp-header.cc.

References GetTypeId().

Here is the call graph for this function:

uint16_t ns3::PppHeader::GetProtocol ( void )

Get the protocol type carried by this PPP packet.

The type numbers to be used are defined in RFC 3818

Returns: the protocol type being carried

Definition at line 101 of file ppp-header.cc.

References m_protocol.

Referenced by ns3::PointToPointNetDevice::ProcessHeader().

Here is the caller graph for this function:

uint32_t ns3::PppHeader::GetSerializedSize ( void ) const

virtual

Returns: the expected size of the header.

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 76 of file ppp-header.cc.

Referenced by Deserialize().

Here is the caller graph for this function:

TypeId ns3::PppHeader::GetTypeId ( void )

static

Definition at line 41 of file ppp-header.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::PppHeader::Print ( std::ostream & os ) const

virtual

Parameters

os output stream This method is used by Packet::Print to print the content of a trailer as ascii data to a c++ output stream. Although the trailer 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 57 of file ppp-header.cc.

References m_protocol, and NS_ASSERT_MSG.

void ns3::PppHeader::Serialize ( Buffer::Iterator start ) const

virtual

Parameters

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 82 of file ppp-header.cc.

References m_protocol, and ns3::Buffer::Iterator::WriteHtonU16().

Here is the call graph for this function: