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:

Classes
struct	AddressHash
	Hashing for the Address class. More...

Public Types
typedef void(*	SeqTsSizeCallback) (Ptr< const Packet > p, const Address &from, const Address &to, const SeqTsSizeHeader &header)
	TracedCallback signature for a reception with addresses and SeqTsSizeHeader.

Public Types inherited from ns3::Application
typedef void(*	DelayAddressCallback) (const Time &delay, const Address &from)
	Common callback signature for packet delay and address.

typedef void(*	StateTransitionCallback) (const std::string &oldState, const std::string &newState)
	Common signature used by callbacks to application's state transition trace source.

Public Member Functions
	PacketSink ()

	~PacketSink () override

std::list< Ptr< Socket > >	GetAcceptedSockets () const

Ptr< Socket >	GetListeningSocket () const

uint64_t	GetTotalRx () const

Public Member Functions inherited from ns3::Application
	Application ()

	~Application () override

virtual int64_t	AssignStreams (int64_t stream)
	Assign a fixed random variable stream number to the random variables used by this Application object.

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 ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Application
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Protected Member Functions
void	DoDispose () override
	Destructor implementation.

Protected Member Functions inherited from ns3::Application
void	DoDispose () override
	Destructor implementation.

void	DoInitialize () override
	Initialize() implementation.

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Private Member Functions
void	HandleAccept (Ptr< Socket > socket, const Address &from)
	Handle an incoming connection.

void	HandlePeerClose (Ptr< Socket > socket)
	Handle an connection close.

void	HandlePeerError (Ptr< Socket > socket)
	Handle an connection error.

void	HandleRead (Ptr< Socket > socket)
	Handle a packet received by the application.

void	PacketReceived (const Ptr< Packet > &p, const Address &from, const Address &localAddress)
	Packet received: assemble byte stream to extract SeqTsSizeHeader.

void	StartApplication () override
	Application specific startup code.

void	StopApplication () override
	Application specific shutdown code.

Private Attributes
std::unordered_map< Address, Ptr< Packet >, AddressHash >	m_buffer
	Buffer for received packets.

bool	m_enableSeqTsSizeHeader {false}
	Enable or disable the export of SeqTsSize header.

Address	m_local
	Local address to bind to (address and port)

uint16_t	m_localPort
	Local port to bind to.

TracedCallback< Ptr< const Packet >, const Address & >	m_rxTrace
	Traced Callback: received packets, source address.

TracedCallback< Ptr< const Packet >, const Address &, const Address & >	m_rxTraceWithAddresses
	Callback for tracing the packet Rx events, includes source and destination addresses.

TracedCallback< Ptr< const Packet >, const Address &, const Address &, const SeqTsSizeHeader & >	m_rxTraceWithSeqTsSize
	Callbacks for tracing the packet Rx events, includes source, destination addresses, and headers.

Ptr< Socket >	m_socket
	Listening socket.

std::list< Ptr< Socket > >	m_socketList
	the accepted sockets

TypeId	m_tid
	Protocol TypeId.

uint64_t	m_totalRx
	Total bytes received.

Additional Inherited Members
Protected Attributes inherited from ns3::Application
Ptr< Node >	m_node
	The node that this application is installed on.

EventId	m_startEvent
	The event that will fire at m_startTime to start the application.

Time	m_startTime
	The simulation time that the application will start.

EventId	m_stopEvent
	The event that will fire at m_stopTime to end the application.

Time	m_stopTime
	The simulation time that the application will end.

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

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. A tracing source to Receive() is also available.

Config Paths

ns3::PacketSink is accessible through the following paths with Config::Set and Config::Connect:

"/NodeList/[i]/ApplicationList/[i]/$ns3::PacketSink"

Attributes

EnableSeqTsSizeHeader: Enable optional header tracing of SeqTsSizeHeader
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: constructwriteread
Local: The Address on which to Bind the rx socket.
- Set with class: ns3::AddressValue
- Underlying type: Address
- Initial value:
- Flags: constructwriteread
Protocol: The type id of the protocol to use for the rx socket.
- Set with class: ns3::TypeIdValue
- Underlying type: TypeId
- Initial value: ns3::UdpSocketFactory
- Flags: constructwriteread

Attributes defined in parent class ns3::Application

StartTime: Time at which the application will start
- Set with class: ns3::TimeValue
- Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
- Initial value: +0ns
- Flags: constructwriteread
StopTime: Time at which the application will stop
- Set with class: ns3::TimeValue
- Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
- Initial value: +0ns
- Flags: constructwriteread

TraceSources

Rx: A packet has been received
Callback signature: ns3::Packet::AddressTracedCallback
RxWithAddresses: A packet has been received
Callback signature: ns3::Packet::TwoAddressTracedCallback
RxWithSeqTsSize: A packet with SeqTsSize header has been received
Callback signature: ns3::PacketSink::SeqTsSizeCallback

Size of this type is 296 bytes (on a 64-bit architecture).

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

Member Typedef Documentation

◆ SeqTsSizeCallback

typedef void(* ns3::PacketSink::SeqTsSizeCallback) (Ptr< const Packet > p, const Address &from, const Address &to, const SeqTsSizeHeader &header)

TracedCallback signature for a reception with addresses and SeqTsSizeHeader.

Parameters

p	The packet received (without the SeqTsSize header)
from	From address
to	Local address
header	The SeqTsSize header

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

Constructor & Destructor Documentation

◆ PacketSink()

ns3::PacketSink::PacketSink ( )

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

References m_socket, m_totalRx, and NS_LOG_FUNCTION.

◆ ~PacketSink()

ns3::PacketSink::~PacketSink ( )

override

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

void ns3::PacketSink::DoDispose ( )

overrideprotectedvirtual

Destructor implementation.

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

Subclasses are expected to implement their real destruction code in an overridden 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::Object.

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

References ns3::Application::DoDispose(), m_socket, m_socketList, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetAcceptedSockets()

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

Returns: list of pointers to accepted sockets

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

References m_socketList, and NS_LOG_FUNCTION.

◆ GetListeningSocket()

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

Returns: pointer to listening socket

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

References m_socket, and NS_LOG_FUNCTION.

◆ GetTotalRx()

uint64_t ns3::PacketSink::GetTotalRx ( ) const

Returns: the total bytes received in this sink app

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

References m_totalRx, and NS_LOG_FUNCTION.

Referenced by CalculateThroughput(), and LteAggregationThroughputScaleTestCase::GetThroughput().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::PacketSink::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

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

References ns3::UdpSocketFactory::GetTypeId(), m_enableSeqTsSizeHeader, m_local, m_rxTrace, m_rxTraceWithAddresses, m_rxTraceWithSeqTsSize, m_tid, ns3::MakeAddressAccessor(), ns3::MakeAddressChecker(), ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeTraceSourceAccessor(), ns3::MakeTypeIdAccessor(), ns3::MakeTypeIdChecker(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ HandleAccept()

void ns3::PacketSink::HandleAccept	(	Ptr< Socket >	socket,
		const Address &	from
	)

private

Handle an incoming connection.

Parameters

socket	the incoming connection socket
from	the address the connection is from

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

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

Referenced by StartApplication().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HandlePeerClose()

void ns3::PacketSink::HandlePeerClose ( Ptr< Socket > socket )

private

Handle an connection close.

Parameters

socket the connected socket

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

References NS_LOG_FUNCTION.

Referenced by StartApplication().

Here is the caller graph for this function:

◆ HandlePeerError()

void ns3::PacketSink::HandlePeerError ( Ptr< Socket > socket )

private

Handle an connection error.

Parameters

socket the connected socket

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

References NS_LOG_FUNCTION.

Referenced by StartApplication().

Here is the caller graph for this function:

◆ HandleRead()

void ns3::PacketSink::HandleRead ( Ptr< Socket > socket )

private

Handle a packet received by the application.

Parameters

socket the receiving socket

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

References ns3::Inet6SocketAddress::ConvertFrom(), ns3::InetSocketAddress::ConvertFrom(), ns3::Ipv4PacketInfoTag::GetAddress(), ns3::Ipv6PacketInfoTag::GetAddress(), ns3::InetSocketAddress::GetIpv4(), ns3::Inet6SocketAddress::GetIpv6(), ns3::InetSocketAddress::GetPort(), ns3::Inet6SocketAddress::GetPort(), ns3::Inet6SocketAddress::IsMatchingType(), ns3::InetSocketAddress::IsMatchingType(), m_enableSeqTsSizeHeader, m_localPort, m_rxTrace, m_rxTraceWithAddresses, m_rxTraceWithSeqTsSize, m_totalRx, ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_INFO, PacketReceived(), and ns3::Time::S.

Referenced by HandleAccept(), and StartApplication().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PacketReceived()

void ns3::PacketSink::PacketReceived	(	const Ptr< Packet > &	p,
		const Address &	from,
		const Address &	localAddress
	)

private

Packet received: assemble byte stream to extract SeqTsSizeHeader.

Parameters

p	received packet
from	from address
localAddress	local address

The method assembles a received byte stream and extracts SeqTsSizeHeader instances from the stream to export in a trace source.

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

References ns3::SeqTsSizeHeader::GetSerializedSize(), ns3::SeqTsSizeHeader::GetSize(), m_buffer, m_rxTraceWithSeqTsSize, NS_ABORT_IF, and NS_LOG_DEBUG.

Referenced by HandleRead().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StartApplication()

void ns3::PacketSink::StartApplication ( )

overrideprivatevirtual

Application specific startup code.

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

Reimplemented from ns3::Application.

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

References ns3::Socket::Bind(), ns3::Inet6SocketAddress::ConvertFrom(), ns3::InetSocketAddress::ConvertFrom(), ns3::Socket::CreateSocket(), ns3::Application::GetNode(), ns3::InetSocketAddress::GetPort(), ns3::Inet6SocketAddress::GetPort(), HandleAccept(), HandlePeerClose(), HandlePeerError(), HandleRead(), ns3::Address::IsInvalid(), ns3::Inet6SocketAddress::IsMatchingType(), ns3::InetSocketAddress::IsMatchingType(), ns3::addressUtils::IsMulticast(), ns3::Socket::Listen(), m_local, m_localPort, m_socket, m_tid, ns3::MakeCallback(), ns3::MakeNullCallback(), NS_ABORT_MSG_IF, NS_FATAL_ERROR, NS_LOG_FUNCTION, ns3::Socket::SetAcceptCallback(), ns3::Socket::SetCloseCallbacks(), ns3::Socket::SetRecvCallback(), ns3::Socket::SetRecvPktInfo(), and ns3::Socket::ShutdownSend().

Here is the call graph for this function:

◆ StopApplication()

void ns3::PacketSink::StopApplication ( )

overrideprivatevirtual

Application specific shutdown code.

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

Reimplemented from ns3::Application.

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

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

Here is the call graph for this function:

Member Data Documentation

◆ m_buffer

std::unordered_map<Address, Ptr<Packet>, AddressHash> ns3::PacketSink::m_buffer

private

Buffer for received packets.

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

Referenced by PacketReceived().

◆ m_enableSeqTsSizeHeader

bool ns3::PacketSink::m_enableSeqTsSizeHeader {false}

private

Enable or disable the export of SeqTsSize header.

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

Referenced by GetTypeId(), and HandleRead().

◆ m_local

Address ns3::PacketSink::m_local

private

Local address to bind to (address and port)

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

Referenced by GetTypeId(), and StartApplication().

◆ m_localPort

uint16_t ns3::PacketSink::m_localPort

private

Local port to bind to.

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

Referenced by HandleRead(), and StartApplication().

◆ m_rxTrace

TracedCallback<Ptr<const Packet>, const Address&> ns3::PacketSink::m_rxTrace

private

Traced Callback: received packets, source address.

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

Referenced by GetTypeId(), and HandleRead().

◆ m_rxTraceWithAddresses

TracedCallback<Ptr<const Packet>, const Address&, const Address&> ns3::PacketSink::m_rxTraceWithAddresses

private

Callback for tracing the packet Rx events, includes source and destination addresses.

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

Referenced by GetTypeId(), and HandleRead().

◆ m_rxTraceWithSeqTsSize

TracedCallback<Ptr<const Packet>, const Address&, const Address&, const SeqTsSizeHeader&> ns3::PacketSink::m_rxTraceWithSeqTsSize

private

Callbacks for tracing the packet Rx events, includes source, destination addresses, and headers.

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

Referenced by GetTypeId(), HandleRead(), and PacketReceived().

◆ m_socket

Ptr<Socket> ns3::PacketSink::m_socket

private

Listening socket.

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

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

◆ m_socketList

std::list<Ptr<Socket> > ns3::PacketSink::m_socketList

private

the accepted sockets

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

Referenced by DoDispose(), GetAcceptedSockets(), HandleAccept(), and StopApplication().

◆ m_tid

TypeId ns3::PacketSink::m_tid

private

Protocol TypeId.

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

Referenced by GetTypeId(), and StartApplication().

◆ m_totalRx

uint64_t ns3::PacketSink::m_totalRx

private

Total bytes received.

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

Referenced by PacketSink(), GetTotalRx(), and HandleRead().

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

src/applications/model/packet-sink.h
src/applications/model/packet-sink.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Attributes defined in parent class ns3::Application

TraceSources

Member Typedef Documentation

◆ SeqTsSizeCallback

Constructor & Destructor Documentation

◆ PacketSink()

◆ ~PacketSink()

Member Function Documentation

◆ DoDispose()

◆ GetAcceptedSockets()

◆ GetListeningSocket()

◆ GetTotalRx()

◆ GetTypeId()

◆ HandleAccept()

◆ HandlePeerClose()

◆ HandlePeerError()

◆ HandleRead()

◆ PacketReceived()

◆ StartApplication()

◆ StopApplication()

Member Data Documentation

◆ m_buffer

◆ m_enableSeqTsSizeHeader

◆ m_local

◆ m_localPort

◆ m_rxTrace

◆ m_rxTraceWithAddresses

◆ m_rxTraceWithSeqTsSize

◆ m_socket

◆ m_socketList

◆ m_tid

◆ m_totalRx