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:
Inheritance graph
[legend]
Collaboration diagram for ns3::SocketAddressTag:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 SocketAddressTag ()
void SetAddress (Address addr)
Address GetAddress (void) const
virtual TypeId GetInstanceTypeId (void) const
virtual uint32_t GetSerializedSize (void) const
virtual void Serialize (TagBuffer i) const
virtual void Deserialize (TagBuffer i)
virtual void Print (std::ostream &os) const

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::ObjectBase.

Private Attributes

Address m_address

Detailed Description

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

Definition at line 517 of file socket.h.


Constructor & Destructor Documentation

ns3::SocketAddressTag::SocketAddressTag (  ) 

Definition at line 259 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 301 of file socket.cc.

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

Address ns3::SocketAddressTag::GetAddress ( void   )  const
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 286 of file socket.cc.

References GetTypeId().

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::AddTag just prior to calling Tag::Serialize.

Implements ns3::Tag.

Definition at line 291 of file socket.cc.

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

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

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

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

Reimplemented from ns3::Tag.

Definition at line 277 of file socket.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

void ns3::SocketAddressTag::Print ( std::ostream &  os  )  const [virtual]
Parameters:
os the stream to print to

This method is typically invoked from the Packet::PrintTags method

Implements ns3::Tag.

Definition at line 306 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 296 of file socket.cc.

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

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

Member Data Documentation

Definition at line 532 of file socket.h.

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


The documentation for this class was generated from the following files:
Generated on Thu Dec 3 14:12:08 2009 for NS-3 by  doxygen 1.6.3