A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::SocketPriorityTag Class Reference

indicates whether the socket has a priority set. More...

#include "socket.h"

+ Inheritance diagram for ns3::SocketPriorityTag:
+ Collaboration diagram for ns3::SocketPriorityTag:

Public Member Functions

 SocketPriorityTag ()
 
void Deserialize (TagBuffer i) override
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object.
 
uint8_t GetPriority () const
 Get the tag's priority.
 
uint32_t GetSerializedSize () const override
 
void Print (std::ostream &os) const override
 
void Serialize (TagBuffer i) const override
 
void SetPriority (uint8_t priority)
 Set the tag's priority.
 
virtual void Deserialize (TagBuffer i)=0
 
virtual uint32_t GetSerializedSize () const =0
 
virtual void Print (std::ostream &os) const =0
 
virtual void Serialize (TagBuffer i) const =0
 
- 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 type ID.
 
- Static Public Member Functions inherited from ns3::Tag
static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID.
 

Private Attributes

uint8_t m_priority
 the priority carried by the tag
 

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

indicates whether the socket has a priority set.

Definition at line 1317 of file socket.h.

Constructor & Destructor Documentation

◆ SocketPriorityTag()

ns3::SocketPriorityTag::SocketPriorityTag ( )

Definition at line 849 of file socket.cc.

Member Function Documentation

◆ Deserialize()

void ns3::SocketPriorityTag::Deserialize ( TagBuffer  i)
overridevirtual
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 894 of file socket.cc.

References m_priority, and ns3::TagBuffer::ReadU8().

+ Here is the call graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::SocketPriorityTag::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 876 of file socket.cc.

References GetTypeId().

+ Here is the call graph for this function:

◆ GetPriority()

uint8_t ns3::SocketPriorityTag::GetPriority ( ) const

Get the tag's priority.

Returns
the priority

Definition at line 860 of file socket.cc.

References m_priority.

Referenced by ns3::PfifoFastQueueDisc::DoEnqueue(), ns3::PrioQueueDisc::DoEnqueue(), ns3::MeshWifiInterfaceMac::ForwardDown(), UdpSocketImplTest::GetPriority(), and ns3::QosUtilsGetTidForPacket().

+ Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::SocketPriorityTag::GetSerializedSize ( ) const
overridevirtual
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 882 of file socket.cc.

◆ GetTypeId()

TypeId ns3::SocketPriorityTag::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 866 of file socket.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

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

◆ Print()

void ns3::SocketPriorityTag::Print ( std::ostream &  os) const
overridevirtual
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 900 of file socket.cc.

References m_priority.

◆ Serialize()

void ns3::SocketPriorityTag::Serialize ( TagBuffer  i) const
overridevirtual
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 888 of file socket.cc.

References m_priority, and ns3::TagBuffer::WriteU8().

+ Here is the call graph for this function:

◆ SetPriority()

Member Data Documentation

◆ m_priority

uint8_t ns3::SocketPriorityTag::m_priority
private

the priority carried by the tag

Definition at line 1358 of file socket.h.

Referenced by Deserialize(), GetPriority(), Print(), Serialize(), and SetPriority().


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