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:

[legend]

Collaboration diagram for ns3::PacketSink:

[legend]

List of all members.

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.
Private Attributes
TypeId	m_tid

---

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.

---

Member Function Documentation

virtual 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.

static 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]/$ns3::PacketSink

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.
  • Set with class: TypeIdValue
  • Underlying type: TypeId
  • Initial value: ns3::UdpSocketFactory
  • Flags: construct write read

TraceSources defined for this type:

• Rx: A packet has been received

Reimplemented from ns3::Application.

virtual 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.

virtual 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.

---

Member Data Documentation

TypeId ns3::PacketSink::m_tid [private]

Identifies the type of this object instance.

Reimplemented from ns3::Object.

---

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

• src/applications/packet-sink/packet-sink.h
• doc/introspected-doxygen.h