A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
ns3::SocketAddressTag Class Reference

This class implements a tag that carries an address of a packet across the socket interface. More...

#include <socket.h>

+ Inheritance diagram for ns3::SocketAddressTag:
+ Collaboration diagram for ns3::SocketAddressTag:

Public Member Functions

 SocketAddressTag ()
 
virtual void Deserialize (TagBuffer i)
 
Address GetAddress (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
virtual uint32_t GetSerializedSize (void) const
 
virtual void Print (std::ostream &os) const
 
virtual void Serialize (TagBuffer i) const
 
void SetAddress (Address addr)
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~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_address
 

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 an address of a packet across the socket interface.

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 847 of file socket.h.

Constructor & Destructor Documentation

ns3::SocketAddressTag::SocketAddressTag ( )

Definition at line 516 of file socket.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::SocketAddressTag::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 564 of file socket.cc.

References ns3::Address::Deserialize(), m_address, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Address ns3::SocketAddressTag::GetAddress ( void  ) const

Definition at line 529 of file socket.cc.

References m_address, and NS_LOG_FUNCTION.

Referenced by PrintReceivedPacket(), ns3::UdpSocketImpl::RecvFrom(), ns3::NscTcpSocketImpl::RecvFrom(), and ns3::PacketSocket::RecvFrom().

+ Here is the caller graph for this function:

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

References GetTypeId().

+ Here is the call graph for this function:

uint32_t ns3::SocketAddressTag::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 552 of file socket.cc.

References ns3::Address::GetSerializedSize(), m_address, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

TypeId ns3::SocketAddressTag::GetTypeId ( void  )
static

Definition at line 538 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:

void ns3::SocketAddressTag::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 570 of file socket.cc.

References m_address, and NS_LOG_FUNCTION.

void ns3::SocketAddressTag::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 558 of file socket.cc.

References m_address, NS_LOG_FUNCTION, and ns3::Address::Serialize().

+ Here is the call graph for this function:

void ns3::SocketAddressTag::SetAddress ( Address  addr)

Definition at line 522 of file socket.cc.

References m_address, and NS_LOG_FUNCTION.

Referenced by ns3::UdpSocketImpl::ForwardUp(), ns3::PacketSocket::ForwardUp(), ns3::UdpSocketImpl::ForwardUp6(), ns3::NscTcpSocketImpl::ReadPendingData(), and ns3::TcpSocketBase::Recv().

+ Here is the caller graph for this function:

Member Data Documentation

Address ns3::SocketAddressTag::m_address
private

Definition at line 862 of file socket.h.

Referenced by Deserialize(), GetAddress(), GetSerializedSize(), Print(), Serialize(), and SetAddress().

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