A Discrete-Event Network Simulator
API
ns3::PacketSink Class Reference

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. More...
 
- Public Types inherited from ns3::Application
typedef void(* DelayAddressCallback) (const Time &delay, const Address &from)
 Common callback signature for packet delay and address. More...
 
typedef void(* StateTransitionCallback) (const std::string &oldState, const std::string &newState)
 Common signature used by callbacks to application's state transition trace source. More...
 

Public Member Functions

 PacketSink ()
 
virtual ~PacketSink ()
 
std::list< Ptr< Socket > > GetAcceptedSockets (void) const
 
Ptr< SocketGetListeningSocket (void) const
 
uint64_t GetTotalRx () const
 
- Public Member Functions inherited from ns3::Application
 Application ()
 
virtual ~Application ()
 
Ptr< NodeGetNode () const
 
void SetNode (Ptr< Node > node)
 
void SetStartTime (Time start)
 Specify application start time. More...
 
void SetStopTime (Time stop)
 Specify application stop time. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Application
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Protected Member Functions

virtual void DoDispose (void)
 Destructor implementation. More...
 
- Protected Member Functions inherited from ns3::Application
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Private Member Functions

void HandleAccept (Ptr< Socket > socket, const Address &from)
 Handle an incoming connection. More...
 
void HandlePeerClose (Ptr< Socket > socket)
 Handle an connection close. More...
 
void HandlePeerError (Ptr< Socket > socket)
 Handle an connection error. More...
 
void HandleRead (Ptr< Socket > socket)
 Handle a packet received by the application. More...
 
void PacketReceived (const Ptr< Packet > &p, const Address &from, const Address &localAddress)
 Packet received: assemble byte stream to extract SeqTsSizeHeader. More...
 
virtual void StartApplication (void)
 Application specific startup code. More...
 
virtual void StopApplication (void)
 Application specific shutdown code. More...
 

Private Attributes

std::unordered_map< Address, Ptr< Packet >, AddressHashm_buffer
 Buffer for received packets. More...
 
bool m_enableSeqTsSizeHeader {false}
 Enable or disable the export of SeqTsSize header. More...
 
Address m_local
 Local address to bind to. More...
 
TracedCallback< Ptr< const Packet >, const Address & > m_rxTrace
 Traced Callback: received packets, source address. More...
 
TracedCallback< Ptr< const Packet >, const Address &, const Address & > m_rxTraceWithAddresses
 Callback for tracing the packet Rx events, includes source and destination addresses. More...
 
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. More...
 
Ptr< Socketm_socket
 Listening socket. More...
 
std::list< Ptr< Socket > > m_socketList
 the accepted sockets More...
 
TypeId m_tid
 Protocol TypeId. More...
 
uint64_t m_totalRx
 Total bytes received. More...
 

Additional Inherited Members

- Protected Attributes inherited from ns3::Application
Ptr< Nodem_node
 The node that this application is installed on. More...
 
EventId m_startEvent
 The event that will fire at m_startTime to start the application. More...
 
Time m_startTime
 The simulation time that the application will start. More...
 
EventId m_stopEvent
 The event that will fire at m_stopTime to end the application. More...
 
Time m_stopTime
 The simulation time that the application will end. More...
 

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

  • 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.
  • EnableSeqTsSizeHeader: Enable optional header tracing of SeqTsSizeHeader
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: construct write read

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: construct write read
  • 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: construct write read

TraceSources

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

Definition at line 71 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
pThe packet received (without the SeqTsSize header)
fromFrom address
toLocal address
headerThe SeqTsSize header

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

Constructor & Destructor Documentation

◆ PacketSink()

ns3::PacketSink::PacketSink ( )

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

References m_socket, m_totalRx, and NS_LOG_FUNCTION.

◆ ~PacketSink()

ns3::PacketSink::~PacketSink ( )
virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

void ns3::PacketSink::DoDispose ( void  )
protectedvirtual

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::Application.

Definition at line 111 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 ( void  ) const
Returns
list of pointers to accepted sockets

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

References m_socketList, and NS_LOG_FUNCTION.

◆ GetListeningSocket()

Ptr< Socket > ns3::PacketSink::GetListeningSocket ( void  ) const
Returns
pointer to listening socket

Definition at line 98 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 91 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()

◆ HandleAccept()

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

Handle an incoming connection.

Parameters
socketthe incoming connection socket
fromthe address the connection is from

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

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

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
socketthe connected socket

Definition at line 258 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
socketthe connected socket

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

References NS_LOG_FUNCTION.

Referenced by StartApplication().

+ Here is the caller graph for this function:

◆ HandleRead()

◆ 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
preceived packet
fromfrom address
localAddresslocal address

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

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

References ns3::Packet::AddAtEnd(), ns3::Packet::CreateFragment(), ns3::SeqTsSizeHeader::GetSerializedSize(), ns3::SeqTsSizeHeader::GetSize(), ns3::Packet::GetSize(), m_buffer, m_rxTraceWithSeqTsSize, NS_ABORT_IF, NS_LOG_DEBUG, ns3::Packet::PeekHeader(), and ns3::Packet::RemoveAtStart().

Referenced by HandleRead().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ StartApplication()

void ns3::PacketSink::StartApplication ( void  )
privatevirtual

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

References ns3::Socket::Bind(), ns3::Socket::CreateSocket(), ns3::Application::GetNode(), HandleAccept(), HandlePeerClose(), HandlePeerError(), HandleRead(), ns3::addressUtils::IsMulticast(), ns3::Socket::Listen(), m_local, m_socket, m_tid, ns3::MakeCallback(), ns3::MakeNullCallback(), NS_FATAL_ERROR, NS_LOG_FUNCTION, ns3::Socket::SetAcceptCallback(), ns3::Socket::SetCloseCallbacks(), ns3::Socket::SetRecvCallback(), and ns3::Socket::ShutdownSend().

+ Here is the call graph for this function:

◆ StopApplication()

void ns3::PacketSink::StopApplication ( void  )
privatevirtual

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 160 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 172 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 183 of file packet-sink.h.

Referenced by GetTypeId(), and HandleRead().

◆ m_local

Address ns3::PacketSink::m_local
private

Local address to bind to.

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

Referenced by GetTypeId(), and StartApplication().

◆ m_rxTrace

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

Traced Callback: received packets, source address.

Definition at line 186 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 188 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 190 of file packet-sink.h.

Referenced by GetTypeId(), and PacketReceived().

◆ m_socket

Ptr<Socket> ns3::PacketSink::m_socket
private

Listening socket.

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

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

◆ m_socketList

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

the accepted sockets

Definition at line 177 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 181 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 180 of file packet-sink.h.

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


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