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

#include <packet-sink.h>

Inheritance diagram for ns3::PacketSink:

Collaboration diagram for ns3::PacketSink:

Public Member Functions
	PacketSink ()
virtual	~PacketSink ()
std::list< Ptr< Socket > >	GetAcceptedSockets (void) const
Ptr< Socket >	GetListeningSocket (void) const
uint32_t	GetTotalRx () const
Public Member Functions inherited from ns3::Application
	Application ()
virtual	~Application ()
Ptr< Node >	GetNode () const
void	SetNode (Ptr< Node > node)
void	SetStartTime (Time start)
	Specify application start time.
void	SetStopTime (Time stop)
	Specify application stop time.
Public Member Functions inherited from ns3::Object
	Object ()
virtual	~Object ()
void	AggregateObject (Ptr< Object > other)
void	Dispose (void)
AggregateIterator	GetAggregateIterator (void) const
virtual TypeId	GetInstanceTypeId (void) const
template<typename T >
Ptr< T >	GetObject (void) const
template<typename T >
Ptr< T >	GetObject (TypeId tid) const
void	Start (void)
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const
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)
	This method returns the TypeId associated to ns3::PacketSink.

Protected Member Functions
virtual void	DoDispose (void)
Protected Member Functions inherited from ns3::Application
virtual void	DoStart (void)
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
virtual void	NotifyNewAggregate (void)

Private Member Functions
void	HandleAccept (Ptr< Socket >, const Address &from)
void	HandlePeerClose (Ptr< Socket >)
void	HandlePeerError (Ptr< Socket >)
void	HandleRead (Ptr< Socket >)
virtual void	StartApplication (void)
virtual void	StopApplication (void)

Private Attributes
Address	m_local
TracedCallback< Ptr< const Packet >, const Address & >	m_rxTrace
Ptr< Socket >	m_socket
std::list< Ptr< Socket > >	m_socketList
TypeId	m_tid
uint32_t	m_totalRx

Additional Inherited Members
Protected Attributes inherited from ns3::Application
Ptr< Node >	m_node
EventId	m_startEvent
Time	m_startTime
EventId	m_stopEvent
Time	m_stopTime

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 62 of file packet-sink.cc.

References NS_LOG_FUNCTION.

ns3::PacketSink::~PacketSink ( )

virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::PacketSink::DoDispose ( void )

protectedvirtual

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.

It is safe to call GetObject from within this method.

Reimplemented from ns3::Application.

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

References NS_LOG_FUNCTION.

std::list< Ptr< Socket > > ns3::PacketSink::GetAcceptedSockets ( void ) const

Returns: list of pointers to accepted sockets

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

References NS_LOG_FUNCTION.

Ptr< Socket > ns3::PacketSink::GetListeningSocket ( void ) const

Returns: pointer to listening socket

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

References NS_LOG_FUNCTION.

uint32_t ns3::PacketSink::GetTotalRx ( ) const

Returns: the total bytes received in this sink app

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

Referenced by StaticRoutingSlash32TestCase::DoRun(), GlobalRoutingSlash32TestCase::DoRun(), and main().

Here is the caller graph for this 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]/$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

Attributes defined in parent class ns3::Application:

StartTime: Time at which the application will start
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +0.0ns
- Flags: construct write read
StopTime: Time at which the application will stop
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +0.0ns
- Flags: construct write read