A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ns3::PacketSocketTag Class Reference

This class implements a tag that carries the dest address of a packet and the packet type. More...

#include <packet-socket.h>

+ Inheritance diagram for ns3::PacketSocketTag:

Public Member Functions

 PacketSocketTag ()
 
virtual void Deserialize (TagBuffer i)
 
Address GetDestAddress (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
NetDevice::PacketType GetPacketType (void) const
 
virtual uint32_t GetSerializedSize (void) const
 
virtual void Print (std::ostream &os) const
 
virtual void Serialize (TagBuffer i) const
 
void SetDestAddress (Address a)
 
void SetPacketType (NetDevice::PacketType t)
 
- Public Member Functions inherited from ns3::ObjectBase
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::Tag
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Private Attributes

Address m_destAddr
 
std::string m_deviceName
 
NetDevice::PacketType m_packetType
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

Detailed Description

This class implements a tag that carries the dest address of a packet and the packet type.

Doxygen introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.

Definition at line 148 of file packet-socket.h.

Constructor & Destructor Documentation

ns3::PacketSocketTag::PacketSocketTag ( )

Create an empty PacketSocketTag

Definition at line 511 of file packet-socket.cc.

Member Function Documentation

void ns3::PacketSocketTag::Deserialize ( TagBuffer  i)
virtual
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 567 of file packet-socket.cc.

References ns3::Address::Deserialize(), and ns3::TagBuffer::ReadU8().

Address ns3::PacketSocketTag::GetDestAddress ( void  ) const

Get the destination address of the corresponding packet

Returns
the destination address of the corresponding packet

Definition at line 534 of file packet-socket.cc.

TypeId ns3::PacketSocketTag::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 551 of file packet-socket.cc.

NetDevice::PacketType ns3::PacketSocketTag::GetPacketType ( void  ) const

Get the packet type

Returns
the packet type of the corresponding packet

Definition at line 522 of file packet-socket.cc.

uint32_t ns3::PacketSocketTag::GetSerializedSize ( void  ) const
virtual
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 556 of file packet-socket.cc.

References ns3::Address::GetSerializedSize().

void ns3::PacketSocketTag::Print ( std::ostream &  os) const
virtual
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 573 of file packet-socket.cc.

void ns3::PacketSocketTag::Serialize ( TagBuffer  i) const
virtual
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 561 of file packet-socket.cc.

References ns3::Address::Serialize(), and ns3::TagBuffer::WriteU8().

void ns3::PacketSocketTag::SetDestAddress ( Address  a)

Set the destination address of the corresponding packet

Parameters
athe destination address of the corresponding packet

Definition at line 528 of file packet-socket.cc.

void ns3::PacketSocketTag::SetPacketType ( NetDevice::PacketType  t)

Set the packet type

Parameters
tthe packet type of the corresponding packet

Definition at line 516 of file packet-socket.cc.


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