ns3::PacketSink Class Reference
[PacketSink]

Receive and consume traffic generated to an IP address and port. More...

#include <packet-sink.h>

Inheritance diagram for ns3::PacketSink:
Inheritance graph
[legend]
Collaboration diagram for ns3::PacketSink:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 PacketSink ()
virtual ~PacketSink ()

Static Public Member Functions

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

Protected Member Functions

virtual void DoDispose (void)

Private Member Functions

virtual void StartApplication (void)
 Application specific startup code.
virtual void StopApplication (void)
 Application specific shutdown code.
void HandleRead (Ptr< Socket > socket)
void HandleAccept (Ptr< Socket >, const Address &from)

Private Attributes

Ptr< Socketm_socket
std::list< Ptr< Socket > > m_socketList
Address m_local
TypeId m_tid
TracedCallback< Ptr< const
Packet >, const Address & > 
m_rxTrace

Detailed Description

Receive and consume traffic generated to an IP address and port.

This application was written to complement OnOffApplication, but it is more general so a PacketSink name was selected. Functionally it is important to use in multicast situations, so that reception of the layer-2 multicast frames of interest are enabled, but it is also useful for unicast as an example of how you can write something simple to receive packets at the application layer. Also, if an IP stack generates ICMP Port Unreachable errors, receiving applications will be needed.

The constructor specifies the Address (IP address and port) and the transport protocol to use. A virtual Receive () method is installed as a callback on the receiving socket. By default, when logging is enabled, it prints out the size of packets and their address, but we intend to also add a tracing source to Receive() at a later date.

Definition at line 68 of file packet-sink.h.


Constructor & Destructor Documentation

ns3::PacketSink::PacketSink (  ) 

Definition at line 59 of file packet-sink.cc.

References m_socket, and NS_LOG_FUNCTION.

ns3::PacketSink::~PacketSink (  )  [virtual]

Definition at line 65 of file packet-sink.cc.

References NS_LOG_FUNCTION.


Member Function Documentation

void ns3::PacketSink::DoDispose ( void   )  [protected, virtual]

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e., for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose method.

Reimplemented from ns3::Application.

Definition at line 71 of file packet-sink.cc.

References m_socket, and NS_LOG_FUNCTION.

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

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

This object is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/ApplicationList/[i]/$ns3PacketSink

Attributes defined for this type:

  • Local: The Address on which to Bind the rx socket.
    • Set with class: AddressValue
    • Underlying type: Address
    • Initial value: 00-00-00
    • Flags: construct write read
  • Protocol: The type id of the protocol to use for the rx socket.

TraceSources defined for this type:

  • Rx: A packet has been received

Reimplemented from ns3::Application.

Definition at line 40 of file packet-sink.cc.

References ns3::TypeId::AddAttribute(), ns3::TypeId::AddTraceSource(), ns3::UdpSocketFactory::GetTypeId(), m_local, m_rxTrace, m_tid, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

void ns3::PacketSink::HandleAccept ( Ptr< Socket s,
const Address from 
) [private]

Definition at line 137 of file packet-sink.cc.

References HandleRead(), m_socketList, ns3::MakeCallback(), and NS_LOG_FUNCTION.

Referenced by StartApplication().

void ns3::PacketSink::HandleRead ( Ptr< Socket socket  )  [private]
void ns3::PacketSink::StartApplication ( void   )  [private, virtual]

Application specific startup code.

The StartApplication method is called at the start time specifed by Start This method should be overridden by all or most application subclasses.

Reimplemented from ns3::Application.

Definition at line 82 of file packet-sink.cc.

References ns3::Socket::CreateSocket(), ns3::Application::GetNode(), HandleAccept(), HandleRead(), m_local, m_socket, m_tid, ns3::MakeCallback(), ns3::MakeNullCallback(), and NS_LOG_FUNCTION.

void ns3::PacketSink::StopApplication ( void   )  [private, virtual]

Application specific shutdown code.

The StopApplication method is called at the stop time specifed by Stop This method should be overridden by all or most application subclasses.

Reimplemented from ns3::Application.

Definition at line 99 of file packet-sink.cc.

References m_socket, m_socketList, ns3::MakeNullCallback(), and NS_LOG_FUNCTION.


Member Data Documentation

Definition at line 91 of file packet-sink.h.

Referenced by GetTypeId(), and StartApplication().

Definition at line 93 of file packet-sink.h.

Referenced by GetTypeId(), and HandleRead().

Definition at line 88 of file packet-sink.h.

Referenced by DoDispose(), PacketSink(), StartApplication(), and StopApplication().

std::list<Ptr<Socket> > ns3::PacketSink::m_socketList [private]

Definition at line 89 of file packet-sink.h.

Referenced by HandleAccept(), and StopApplication().

Identifies the type of this object instance.

Reimplemented from ns3::Object.

Definition at line 92 of file packet-sink.h.

Referenced by GetTypeId(), and StartApplication().


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