A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Applications

This section documents the API of the ns-3 applications module. More...

+ Collaboration diagram for Applications:

Modules

 BulkSendApplication
 This traffic generator simply sends data as fast as possible up to MaxBytes or until the application is stopped (if MaxBytes is zero).
 
 OnOffApplication
 This traffic generator follows an On/Off pattern: after Application::StartApplication is called, "On" and "Off" states alternate.
 
 PacketSink
 This application was written to complement OnOffApplication, but it is more general so a PacketSink name was selected.
 
 UdpClientServer
 
 UdpEcho
 

Detailed Description

This section documents the API of the ns-3 applications module.

Class ns3::Application can be used as a base class for ns3 applications.

For a generic functional description, please refer to the ns-3 manual.

Applications are associated with individual nodes. Each node holds a list of references (smart pointers) to its applications.

Conceptually, an application has zero or more ns3::Socket objects associated with it, that are created using the Socket creation API of the Kernel capability. The Socket object API is modeled after the well-known BSD sockets interface, although it is somewhat simplified for use with ns3. Further, any socket call that would normally "block" in normal sockets will return immediately in ns3. A set of "upcalls" are defined that will be called when the previous blocking call would normally exit. THis is documented in more detail Socket class in socket.h.

The main purpose of the base class application public API is to provide a uniform way to start and stop applications.