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

A server using PacketSocket. More...

#include "packet-socket-server.h"

+ Inheritance diagram for ns3::PacketSocketServer:
+ Collaboration diagram for ns3::PacketSocketServer:

Public Member Functions

 PacketSocketServer ()
 
virtual ~PacketSocketServer ()
 
void SetLocal (PacketSocketAddress addr)
 set the local address and protocol to be used More...
 
- 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...
 
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 HandleRead (Ptr< Socket > socket)
 Handle a packet received by the application. More...
 
virtual void StartApplication (void)
 Application specific startup code. More...
 
virtual void StopApplication (void)
 Application specific shutdown code. More...
 

Private Attributes

uint32_t m_bytesRx
 Total bytes received. More...
 
PacketSocketAddress m_localAddress
 Local address. More...
 
bool m_localAddressSet
 Sanity check. More...
 
uint32_t m_pktRx
 The number of received packets. More...
 
TracedCallback< Ptr< const Packet >, const Address & > m_rxTrace
 Traced Callback: received packets, source address. More...
 
Ptr< Socketm_socket
 Socket. More...
 

Additional Inherited Members

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

A server using PacketSocket.


Receives packets using PacketSocket. It does not require (or use) IP. The application has the same requirements as the PacketSocket for what concerns the underlying NetDevice and the Address scheme. It is meant to be used in ns-3 tests.

Provides a "Rx" Traced Callback (received packets, source address)

Config Paths

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

  • "/NodeList/[i]/ApplicationList/[i]/$ns3::PacketSocketServer"

No Attributes are defined for this type.

Attributes defined in parent class ns3::Application

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

TraceSources

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

Definition at line 46 of file packet-socket-server.h.

Constructor & Destructor Documentation

◆ PacketSocketServer()

ns3::PacketSocketServer::PacketSocketServer ( )

Definition at line 56 of file packet-socket-server.cc.

References m_bytesRx, m_localAddressSet, m_pktRx, m_socket, and NS_LOG_FUNCTION.

◆ ~PacketSocketServer()

ns3::PacketSocketServer::~PacketSocketServer ( )
virtual

Definition at line 65 of file packet-socket-server.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

void ns3::PacketSocketServer::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 71 of file packet-socket-server.cc.

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

+ Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::PacketSocketServer::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

Definition at line 43 of file packet-socket-server.cc.

References m_rxTrace, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ HandleRead()

void ns3::PacketSocketServer::HandleRead ( Ptr< Socket socket)
private

Handle a packet received by the application.

Parameters
socketthe receiving socket

Definition at line 110 of file packet-socket-server.cc.

References ns3::PacketSocketAddress::ConvertFrom(), ns3::Packet::GetSize(), ns3::PacketSocketAddress::IsMatchingType(), m_bytesRx, m_pktRx, m_rxTrace, ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_INFO, and ns3::Socket::RecvFrom().

Referenced by StartApplication().

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

◆ SetLocal()

void ns3::PacketSocketServer::SetLocal ( PacketSocketAddress  addr)

set the local address and protocol to be used

Parameters
addrlocal address

Definition at line 102 of file packet-socket-server.cc.

References m_localAddress, m_localAddressSet, and NS_LOG_FUNCTION.

Referenced by PacketSocketAppsTest::DoRun(), Bug730TestCase::DoRun(), PreservePacketsInAmpdus::DoRun(), BlockAckAggregationDisabledTest::DoRun(), QosFragmentationTestCase::DoRun(), Bug2222TestCase::DoRun(), and OcbWifiMacTestCase::PostDeviceConfiguration().

+ Here is the caller graph for this function:

◆ StartApplication()

void ns3::PacketSocketServer::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 78 of file packet-socket-server.cc.

References ns3::Socket::Bind(), ns3::Socket::CreateSocket(), ns3::Application::GetNode(), HandleRead(), ns3::TypeId::LookupByName(), m_localAddress, m_localAddressSet, m_socket, ns3::MakeCallback(), NS_ASSERT_MSG(), NS_LOG_FUNCTION, and ns3::Socket::SetRecvCallback().

+ Here is the call graph for this function:

◆ StopApplication()

void ns3::PacketSocketServer::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 94 of file packet-socket-server.cc.

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

+ Here is the call graph for this function:

Member Data Documentation

◆ m_bytesRx

uint32_t ns3::PacketSocketServer::m_bytesRx
private

Total bytes received.

Definition at line 80 of file packet-socket-server.h.

Referenced by HandleRead(), and PacketSocketServer().

◆ m_localAddress

PacketSocketAddress ns3::PacketSocketServer::m_localAddress
private

Local address.

Definition at line 83 of file packet-socket-server.h.

Referenced by SetLocal(), and StartApplication().

◆ m_localAddressSet

bool ns3::PacketSocketServer::m_localAddressSet
private

Sanity check.

Definition at line 84 of file packet-socket-server.h.

Referenced by PacketSocketServer(), SetLocal(), and StartApplication().

◆ m_pktRx

uint32_t ns3::PacketSocketServer::m_pktRx
private

The number of received packets.

Definition at line 79 of file packet-socket-server.h.

Referenced by HandleRead(), and PacketSocketServer().

◆ m_rxTrace

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

Traced Callback: received packets, source address.

Definition at line 87 of file packet-socket-server.h.

Referenced by GetTypeId(), and HandleRead().

◆ m_socket

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

Socket.

Definition at line 82 of file packet-socket-server.h.

Referenced by PacketSocketServer(), StartApplication(), and StopApplication().


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