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)

Static Public Member Functions
static TypeId	GetTypeId (void)
	This method returns the TypeId associated to ns3::SocketAddressTag.

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.

Definition at line 644 of file socket.h.

Constructor & Destructor Documentation

ns3::SocketAddressTag::SocketAddressTag

(

)

Definition at line 357 of file socket.cc.

Member Function Documentation

void ns3::SocketAddressTag::Deserialize ( TagBuffer  i )

virtual

Parameters

i	the 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 400 of file socket.cc.

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

Here is the call graph for this function:

Address ns3::SocketAddressTag::GetAddress

(

void

)

const

Definition at line 368 of file socket.cc.

References m_address.

Referenced by 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 385 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 390 of file socket.cc.

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

Here is the call graph for this function:

TypeId ns3::SocketAddressTag::GetTypeId ( void  )

static

This method returns the TypeId associated to ns3::SocketAddressTag.

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::Tag.

Definition at line 376 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

os	the stream to print to

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

Implements ns3::Tag.

Definition at line 405 of file socket.cc.

References m_address.

void ns3::SocketAddressTag::Serialize ( TagBuffer  i ) const

virtual

Parameters

i	the 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 395 of file socket.cc.

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

Here is the call graph for this function:

void ns3::SocketAddressTag::SetAddress

(

Address

addr

)

Definition at line 362 of file socket.cc.

References m_address.

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

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

---

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

• src/network/model/socket.h
• doc/introspected-doxygen.h
• src/network/model/socket.cc