A Discrete-Event Network Simulator
API
BenchTag< N > Class Template Reference

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

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

Public Member Functions

 BenchTag ()
 
void Deserialize (TagBuffer buf) override
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object. More...
 
uint32_t GetSerializedSize () const override
 
void Print (std::ostream &os) const override
 
void Serialize (TagBuffer buf) const override
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static std::string GetName ()
 Get the bench tag name. More...
 
static TypeId GetTypeId ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::Tag
static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

template<int N>
class BenchTag< N >

BenchTag class used for benchmarking packet serialization/deserialization.

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

Constructor & Destructor Documentation

◆ BenchTag()

template<int N>
BenchTag< N >::BenchTag ( )
inline

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

Member Function Documentation

◆ Deserialize()

template<int N>
void BenchTag< N >::Deserialize ( TagBuffer  i)
inlineoverridevirtual
Parameters
ithe buffer to read data from.

Read the content of the tag from the provided tag buffer. DO NOT attempt to read more bytes than you wrote with Tag::Serialize.

Implements ns3::Tag.

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

References ns3::TagBuffer::ReadU8().

+ Here is the call graph for this function:

◆ GetInstanceTypeId()

template<int N>
TypeId BenchTag< N >::GetInstanceTypeId ( ) const
inlineoverridevirtual

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 180 of file bench-packets.cc.

References BenchTag< N >::GetTypeId().

+ Here is the call graph for this function:

◆ GetName()

template<int N>
static std::string BenchTag< N >::GetName ( )
inlinestatic

Get the bench tag name.

Returns
the name.

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

Referenced by BenchTag< N >::GetTypeId().

+ Here is the caller graph for this function:

◆ GetSerializedSize()

template<int N>
uint32_t BenchTag< N >::GetSerializedSize ( ) const
inlineoverridevirtual
Returns
the number of bytes required to serialize the data of the tag.

This method is typically invoked by Packet::AddPacketTag or Packet::AddByteTag just prior to calling Tag::Serialize.

Implements ns3::Tag.

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

◆ GetTypeId()

template<int N>
static TypeId BenchTag< N >::GetTypeId ( void  )
inlinestatic

Register this type.

Returns
The TypeId.

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

References BenchTag< N >::GetName(), and ns3::TypeId::SetParent().

Referenced by BenchTag< N >::GetInstanceTypeId().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ Print()

template<int N>
void BenchTag< N >::Print ( std::ostream &  os) const
inlineoverridevirtual
Parameters
osthe stream to print to

This method is typically invoked from the Packet::PrintByteTags or Packet::PrintPacketTags methods.

Implements ns3::Tag.

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

◆ Serialize()

template<int N>
void BenchTag< N >::Serialize ( TagBuffer  i) const
inlineoverridevirtual
Parameters
ithe buffer to write data into.

Write the content of the tag in the provided tag buffer. DO NOT attempt to write more bytes than you requested with Tag::GetSerializedSize.

Implements ns3::Tag.

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

References ns3::TagBuffer::WriteU8().

+ Here is the call graph for this function:

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