A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
BenchHeader< N > Class Template Reference

BenchHeader class used for benchmarking packet serialization/deserialization. More...

+ Inheritance diagram for BenchHeader< N >:
+ Collaboration diagram for BenchHeader< N >:

Public Member Functions

 BenchHeader ()
 
uint32_t Deserialize (Buffer::Iterator start) override
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object.
 
uint32_t GetSerializedSize () const override
 
bool IsOk () const
 Returns true if the header has been deserialized and the deserialization was correct.
 
void Print (std::ostream &os) const override
 
void Serialize (Buffer::Iterator start) const override
 
- 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 ()
 Register this type.
 
- 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.
 

Static Private Member Functions

static std::string GetTypeName ()
 Get type name function.
 

Private Attributes

bool m_ok
 variable to track whether deserialization succeeded
 

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 BenchHeader< N >

BenchHeader class used for benchmarking packet serialization/deserialization.

Definition at line 40 of file bench-packets.cc.

Constructor & Destructor Documentation

◆ BenchHeader()

template<int N>
BenchHeader< N >::BenchHeader

Definition at line 74 of file bench-packets.cc.

Member Function Documentation

◆ Deserialize()

template<int N>
uint32_t BenchHeader< 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 137 of file bench-packets.cc.

◆ GetInstanceTypeId()

template<int N>
TypeId BenchHeader< 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 109 of file bench-packets.cc.

◆ GetSerializedSize()

template<int N>
uint32_t BenchHeader< 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 123 of file bench-packets.cc.

◆ GetTypeId()

template<int N>
TypeId BenchHeader< N >::GetTypeId
static

Register this type.

Returns
The TypeId.

Definition at line 97 of file bench-packets.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ GetTypeName()

template<int N>
std::string BenchHeader< N >::GetTypeName
staticprivate

Get type name function.

Returns
the type name string

Definition at line 88 of file bench-packets.cc.

◆ IsOk()

template<int N>
bool BenchHeader< N >::IsOk

Returns true if the header has been deserialized and the deserialization was correct.

If Deserialize() has not yet been called on the header, will return false.

Returns
true if success, false if failed or if deserialization not tried

Definition at line 81 of file bench-packets.cc.

◆ Print()

template<int N>
void BenchHeader< 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 116 of file bench-packets.cc.

References NS_ASSERT.

◆ Serialize()

template<int N>
void BenchHeader< 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 130 of file bench-packets.cc.

Member Data Documentation

◆ m_ok

template<int N>
bool BenchHeader< N >::m_ok
private

variable to track whether deserialization succeeded

Definition at line 70 of file bench-packets.cc.


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