A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
anonymous_namespace{packet-metadata-test.cc}::HistoryHeader< N > Class Template Reference

Template header-type class to check the proper header concatenation. More...

+ Inheritance diagram for anonymous_namespace{packet-metadata-test.cc}::HistoryHeader< N >:
+ Collaboration diagram for anonymous_namespace{packet-metadata-test.cc}::HistoryHeader< N >:

Public Member Functions

 HistoryHeader ()
 
uint32_t Deserialize (Buffer::Iterator start) override
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object.
 
uint32_t GetSerializedSize () const override
 
void Print (std::ostream &os) const override
 
void Serialize (Buffer::Iterator start) const override
 
- Public Member Functions inherited from ns3::Header
 ~Header () override
 
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator.
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor.
 
void GetAttribute (std::string name, AttributeValue &value, bool permissive=false) 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.
 
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 type ID.
 
- 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.
 

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.
 

Detailed Description

template<int N>
class anonymous_namespace{packet-metadata-test.cc}::HistoryHeader< N >

Template header-type class to check the proper header concatenation.

Note
Class internal to packet-metadata-test.cc

Definition at line 89 of file packet-metadata-test.cc.

Constructor & Destructor Documentation

◆ HistoryHeader()

template<int N>
anonymous_namespace{packet-metadata-test.cc}::HistoryHeader< N >::HistoryHeader ( )

Definition at line 106 of file packet-metadata-test.cc.

Member Function Documentation

◆ Deserialize()

template<int N>
uint32_t anonymous_namespace{packet-metadata-test.cc}::HistoryHeader< N >::Deserialize ( Buffer::Iterator start)
overridevirtual
Parameters
startan iterator which points to where the header should read from.
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.

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 152 of file packet-metadata-test.cc.

◆ GetInstanceTypeId()

template<int N>
TypeId anonymous_namespace{packet-metadata-test.cc}::HistoryHeader< N >::GetInstanceTypeId ( ) const
overridevirtual

Get the most derived TypeId for this Object.

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

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

Implements ns3::ObjectBase.

Definition at line 124 of file packet-metadata-test.cc.

◆ GetSerializedSize()

template<int N>
uint32_t anonymous_namespace{packet-metadata-test.cc}::HistoryHeader< N >::GetSerializedSize ( ) const
overridevirtual
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 138 of file packet-metadata-test.cc.

◆ GetTypeId()

template<int N>
TypeId anonymous_namespace{packet-metadata-test.cc}::HistoryHeader< N >::GetTypeId ( )
static

Get the type ID.

Returns
The object TypeId.

Definition at line 113 of file packet-metadata-test.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ Print()

template<int N>
void anonymous_namespace{packet-metadata-test.cc}::HistoryHeader< N >::Print ( std::ostream & os) const
overridevirtual
Parameters
osoutput 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 131 of file packet-metadata-test.cc.

References NS_ASSERT.

◆ Serialize()

template<int N>
void anonymous_namespace{packet-metadata-test.cc}::HistoryHeader< N >::Serialize ( Buffer::Iterator start) const
overridevirtual
Parameters
startan 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 145 of file packet-metadata-test.cc.


The documentation for this class was generated from the following file: