A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
ns3::UdpClient Class Reference
UdpClientServer

A Udp client. More...

#include <udp-client.h>

+ Inheritance diagram for ns3::UdpClient:
+ Collaboration diagram for ns3::UdpClient:

Public Member Functions

 UdpClient ()
 
virtual ~UdpClient ()
 
void SetRemote (Ipv4Address ip, uint16_t port)
 set the remote address and port More...
 
void SetRemote (Ipv6Address ip, uint16_t port)
 set the remote address and port More...
 
void SetRemote (Address ip, uint16_t port)
 set the remote address and port More...
 
- 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)
 
- 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 Send (void)
 Send a packet. More...
 
virtual void StartApplication (void)
 Application specific startup code. More...
 
virtual void StopApplication (void)
 Application specific shutdown code. More...
 

Private Attributes

uint32_t m_count
 Maximum number of packets the application will send. More...
 
Time m_interval
 Packet inter-send time. More...
 
Address m_peerAddress
 Remote peer address. More...
 
uint16_t m_peerPort
 Remote peer port. More...
 
EventId m_sendEvent
 Event to send the next packet. More...
 
uint32_t m_sent
 Counter for sent packets. More...
 
uint32_t m_size
 Size of the sent packet (including the SeqTsHeader) More...
 
Ptr< Socket > m_socket
 Socket. More...
 

Additional Inherited Members

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

Detailed Description

A Udp client.

Config Paths

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

  • /NodeList/[i]/ApplicationList/[i]/$ns3::UdpClient

Attributes

  • MaxPackets: The maximum number of packets the application will send
  • Interval: The time to wait between packets
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +1000000000.0ns
    • Flags: construct write read
  • RemoteAddress: The destination Address of the outbound packets
    • Set with class: AddressValue
    • Underlying type: Address
    • Initial value: 00-00-00
    • Flags: construct write read
  • RemotePort: The destination port of the outbound packets
  • PacketSize: Size of packets generated. The minimum packet size is 12 bytes which is the size of the header carrying the sequence number and the time stamp.

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

No TraceSources are defined for this type.

Sends UDP packet carrying sequence number and time stamp in their payloads

Definition at line 43 of file udp-client.h.

Constructor & Destructor Documentation

ns3::UdpClient::UdpClient ( )

Definition at line 76 of file udp-client.cc.

References m_sendEvent, m_sent, m_socket, and NS_LOG_FUNCTION.

ns3::UdpClient::~UdpClient ( )
virtual

Definition at line 84 of file udp-client.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::UdpClient::DoDispose ( void  )
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 114 of file udp-client.cc.

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

+ Here is the call graph for this function:

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

Get the type ID.

Returns
the object TypeId

Definition at line 44 of file udp-client.cc.

References m_count, m_interval, m_peerAddress, m_peerPort, m_size, ns3::MakeTimeChecker(), and ns3::TypeId::SetParent().

Referenced by ns3::UdpClientHelper::UdpClientHelper().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::UdpClient::Send ( void  )
private

Send a packet.

Definition at line 153 of file udp-client.cc.

References ns3::Packet::AddHeader(), ns3::Ipv4Address::ConvertFrom(), ns3::Ipv6Address::ConvertFrom(), ns3::Packet::GetUid(), ns3::EventId::IsExpired(), ns3::Ipv4Address::IsMatchingType(), ns3::Ipv6Address::IsMatchingType(), m_count, m_interval, m_peerAddress, m_sendEvent, m_sent, m_size, m_socket, ns3::Simulator::Now(), NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_INFO, ns3::Simulator::Schedule(), ns3::Socket::Send(), and ns3::SeqTsHeader::SetSeq().

Referenced by StartApplication().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::UdpClient::SetRemote ( Ipv4Address  ip,
uint16_t  port 
)

set the remote address and port

Parameters
ipremote IPv4 address
portremote port

Definition at line 90 of file udp-client.cc.

References m_peerAddress, m_peerPort, NS_LOG_FUNCTION, and port.

void ns3::UdpClient::SetRemote ( Ipv6Address  ip,
uint16_t  port 
)

set the remote address and port

Parameters
ipremote IPv6 address
portremote port

Definition at line 98 of file udp-client.cc.

References m_peerAddress, m_peerPort, NS_LOG_FUNCTION, and port.

void ns3::UdpClient::SetRemote ( Address  ip,
uint16_t  port 
)

set the remote address and port

Parameters
ipremote IP address
portremote port

Definition at line 106 of file udp-client.cc.

References m_peerAddress, m_peerPort, NS_LOG_FUNCTION, and port.

void ns3::UdpClient::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 121 of file udp-client.cc.

References ns3::Socket::Bind(), ns3::Socket::Bind6(), ns3::Socket::Connect(), ns3::Ipv4Address::ConvertFrom(), ns3::Ipv6Address::ConvertFrom(), ns3::Socket::CreateSocket(), ns3::Application::GetNode(), ns3::Ipv4Address::IsMatchingType(), ns3::Ipv6Address::IsMatchingType(), ns3::TypeId::LookupByName(), m_peerAddress, m_peerPort, m_sendEvent, m_socket, ns3::MakeNullCallback(), NS_LOG_FUNCTION, ns3::Simulator::Schedule(), Send(), and ns3::Socket::SetRecvCallback().

+ Here is the call graph for this function:

void ns3::UdpClient::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 146 of file udp-client.cc.

References ns3::Simulator::Cancel(), m_sendEvent, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Member Data Documentation

uint32_t ns3::UdpClient::m_count
private

Maximum number of packets the application will send.

Definition at line 88 of file udp-client.h.

Referenced by GetTypeId(), and Send().

Time ns3::UdpClient::m_interval
private

Packet inter-send time.

Definition at line 89 of file udp-client.h.

Referenced by GetTypeId(), and Send().

Address ns3::UdpClient::m_peerAddress
private

Remote peer address.

Definition at line 94 of file udp-client.h.

Referenced by GetTypeId(), Send(), SetRemote(), and StartApplication().

uint16_t ns3::UdpClient::m_peerPort
private

Remote peer port.

Definition at line 95 of file udp-client.h.

Referenced by GetTypeId(), SetRemote(), and StartApplication().

EventId ns3::UdpClient::m_sendEvent
private

Event to send the next packet.

Definition at line 96 of file udp-client.h.

Referenced by Send(), StartApplication(), StopApplication(), and UdpClient().

uint32_t ns3::UdpClient::m_sent
private

Counter for sent packets.

Definition at line 92 of file udp-client.h.

Referenced by Send(), and UdpClient().

uint32_t ns3::UdpClient::m_size
private

Size of the sent packet (including the SeqTsHeader)

Definition at line 90 of file udp-client.h.

Referenced by GetTypeId(), and Send().

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

Socket.

Definition at line 93 of file udp-client.h.

Referenced by Send(), StartApplication(), and UdpClient().

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