|
A Discrete-Event Network Simulator
|
API |
|
|
A Discrete-Event Network Simulator
|
API |
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. More... | |
| void | SetStopTime (Time stop) |
| Specify application stop time. More... | |
| Public Member Functions inherited from ns3::Object | |
| Object () | |
| virtual | ~Object () |
| void | AggregateObject (Ptr< Object > other) |
| void | Dispose (void) |
| Run the DoDispose methods of this object and all the objects aggregated to it. More... | |
| 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 | Initialize (void) |
| This method calls the virtual DoInitialize method on all the objects aggregated to this object. More... | |
| Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
| SimpleRefCount () | |
| Constructor. More... | |
| SimpleRefCount (const SimpleRefCount &o) | |
| Copy constructor. More... | |
| uint32_t | GetReferenceCount (void) const |
| Get the reference count of the object. More... | |
| SimpleRefCount & | operator= (const SimpleRefCount &o) |
| Assignment. 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 |
| 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) |
| 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::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
| static void | Cleanup (void) |
| Noop. 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) |
| This method is called by Object::Dispose or by the object's destructor, whichever comes first. More... | |
| Protected Member Functions inherited from ns3::Application | |
| virtual void | DoInitialize (void) |
| This method is called only once by Object::Initialize. More... | |
| Protected Member Functions inherited from ns3::Object | |
| Object (const Object &o) | |
| virtual void | NotifyNewAggregate (void) |
| This method is invoked whenever two sets of objects are aggregated together. More... | |
| Protected Member Functions inherited from ns3::ObjectBase | |
| void | ConstructSelf (const AttributeConstructionList &attributes) |
| virtual void | NotifyConstructionCompleted (void) |
| This method is invoked once all member attributes have been initialized. 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... | |
| virtual void | StartApplication (void) |
| Application specific startup code. More... | |
| virtual void | StopApplication (void) |
| Application specific shutdown code. More... | |
Private Attributes | |
| Address | m_local |
| Local address to bind to. More... | |
| TracedCallback< Ptr< const Packet >, const Address & > | m_rxTrace |
| Traced Callback: received packets, source address. More... | |
| Ptr< Socket > | m_socket |
| Listening socket. More... | |
| std::list< Ptr< Socket > > | m_socketList |
| the accepted sockets More... | |
| TypeId | m_tid |
| Protocol TypeId. More... | |
| uint32_t | m_totalRx |
| Total bytes received. More... | |
Additional Inherited Members | |
| Protected Attributes inherited from ns3::Application | |
| Ptr< Node > | m_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... | |
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.
ns3::PacketSink is accessible through the following paths with Config::Set and Config::Connect:
Definition at line 68 of file packet-sink.h.
| ns3::PacketSink::PacketSink | ( | ) |
Definition at line 60 of file packet-sink.cc.
References m_socket, m_totalRx, and NS_LOG_FUNCTION.
|
virtual |
Definition at line 67 of file packet-sink.cc.
References NS_LOG_FUNCTION.
|
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 92 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:Definition at line 86 of file packet-sink.cc.
References m_socketList, and NS_LOG_FUNCTION.
Definition at line 79 of file packet-sink.cc.
References m_socket, and NS_LOG_FUNCTION.
| uint32_t ns3::PacketSink::GetTotalRx | ( | ) | const |
Definition at line 72 of file packet-sink.cc.
References m_totalRx, and NS_LOG_FUNCTION.
Referenced by StaticRoutingSlash32TestCase::DoRun(), GlobalRoutingSlash32TestCase::DoRun(), and main().
Here is the caller graph for this function:
|
static |
Get the type ID.
Definition at line 41 of file packet-sink.cc.
References ns3::UdpSocketFactory::GetTypeId(), m_local, m_rxTrace, m_tid, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().
Here is the call graph for this function:Handle an incoming connection.
| socket | the incoming connection socket |
| from | the address the connection is from |
Definition at line 200 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:Handle an connection close.
| socket | the connected socket |
Definition at line 189 of file packet-sink.cc.
References NS_LOG_FUNCTION.
Referenced by StartApplication().
Here is the caller graph for this function:Handle an connection error.
| socket | the connected socket |
Definition at line 194 of file packet-sink.cc.
References NS_LOG_FUNCTION.
Referenced by StartApplication().
Here is the caller graph for this function:Handle a packet received by the application.
| socket | the receiving socket |
Definition at line 154 of file packet-sink.cc.
References ns3::InetSocketAddress::ConvertFrom(), ns3::Inet6SocketAddress::ConvertFrom(), ns3::InetSocketAddress::GetIpv4(), ns3::Inet6SocketAddress::GetIpv6(), ns3::InetSocketAddress::GetPort(), ns3::Inet6SocketAddress::GetPort(), ns3::Packet::GetSize(), ns3::InetSocketAddress::IsMatchingType(), ns3::Inet6SocketAddress::IsMatchingType(), m_rxTrace, m_totalRx, ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_INFO, and ns3::Socket::RecvFrom().
Referenced by HandleAccept(), and StartApplication().
Here is the call graph for this function: Here is the caller graph for this function:
|
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 104 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:
|
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 138 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:
|
private |
Local address to bind to.
Definition at line 129 of file packet-sink.h.
Referenced by GetTypeId(), and StartApplication().
|
private |
Traced Callback: received packets, source address.
Definition at line 134 of file packet-sink.h.
Referenced by GetTypeId(), and HandleRead().
Listening socket.
Definition at line 126 of file packet-sink.h.
Referenced by DoDispose(), GetListeningSocket(), PacketSink(), StartApplication(), and StopApplication().
the accepted sockets
Definition at line 127 of file packet-sink.h.
Referenced by DoDispose(), GetAcceptedSockets(), HandleAccept(), and StopApplication().
|
private |
Protocol TypeId.
Definition at line 131 of file packet-sink.h.
Referenced by GetTypeId(), and StartApplication().
|
private |
Total bytes received.
Definition at line 130 of file packet-sink.h.
Referenced by GetTotalRx(), HandleRead(), and PacketSink().
1.8.6 
