A Udp Echo client. More...
#include "udp-echo-client.h"
Public Member Functions | |
UdpEchoClient () | |
~UdpEchoClient () override | |
uint32_t | GetDataSize () const |
Get the number of data bytes that will be sent to the server. | |
void | SetDataSize (uint32_t dataSize) |
Set the data size of the packet (the number of bytes that are sent as data to the server). | |
void | SetFill (std::string fill) |
Set the data fill of the packet (what is sent as data to the server) to the zero-terminated contents of the fill string string. | |
void | SetFill (uint8_t *fill, uint32_t fillSize, uint32_t dataSize) |
Set the data fill of the packet (what is sent as data to the server) to the contents of the fill buffer, repeated as many times as is required. | |
void | SetFill (uint8_t fill, uint32_t dataSize) |
Set the data fill of the packet (what is sent as data to the server) to the repeated contents of the fill byte. | |
void | SetRemote (Address addr) |
set the remote address | |
void | SetRemote (Address ip, uint16_t port) |
set the remote address and port | |
Public Member Functions inherited from ns3::Application | |
Application () | |
~Application () override | |
Ptr< Node > | GetNode () const |
void | SetNode (Ptr< Node > node) |
void | SetStartTime (Time start) |
Specify application start time. | |
void | SetStopTime (Time stop) |
Specify application stop time. | |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. | |
~Object () override | |
Destructor. | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. | |
void | Dispose () |
Dispose of this Object. | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. | |
bool | IsInitialized () const |
Check if the object has been initialized. | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment operator. | |
void | Ref () const |
Increment the reference count. | |
void | Unref () const |
Decrement the reference count. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
virtual TypeId | GetInstanceTypeId () const =0 |
Get the most derived TypeId for this Object. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Application | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Protected Member Functions | |
void | DoDispose () override |
Destructor implementation. | |
Protected Member Functions inherited from ns3::Application | |
void | DoDispose () override |
Destructor implementation. | |
void | DoInitialize () override |
Initialize() implementation. | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
virtual void | DoDispose () |
Destructor implementation. | |
virtual void | DoInitialize () |
Initialize() implementation. | |
virtual void | NotifyNewAggregate () |
Notify all Objects aggregated to this one of a new Object being aggregated. | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Private Member Functions | |
void | HandleRead (Ptr< Socket > socket) |
Handle a packet reception. | |
void | ScheduleTransmit (Time dt) |
Schedule the next packet transmission. | |
void | Send () |
Send a packet. | |
void | StartApplication () override |
Application specific startup code. | |
void | StopApplication () override |
Application specific shutdown code. | |
Private Attributes | |
uint32_t | m_count |
Maximum number of packets the application will send. | |
uint8_t * | m_data |
packet payload data | |
uint32_t | m_dataSize |
packet payload size (must be equal to m_size) | |
Time | m_interval |
Packet inter-send time. | |
Address | m_peerAddress |
Remote peer address. | |
uint16_t | m_peerPort |
Remote peer port. | |
TracedCallback< Ptr< const Packet > > | m_rxTrace |
Callbacks for tracing the packet Rx events. | |
TracedCallback< Ptr< const Packet >, const Address &, const Address & > | m_rxTraceWithAddresses |
Callbacks for tracing the packet Rx events, includes source and destination addresses. | |
EventId | m_sendEvent |
Event to send the next packet. | |
uint32_t | m_sent |
Counter for sent packets. | |
uint32_t | m_size |
Size of the sent packet. | |
Ptr< Socket > | m_socket |
Socket. | |
TracedCallback< Ptr< const Packet > > | m_txTrace |
Callbacks for tracing the packet Tx events. | |
TracedCallback< Ptr< const Packet >, const Address &, const Address & > | m_txTraceWithAddresses |
Callbacks for tracing the packet Tx events, includes source and destination addresses. | |
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. | |
typedef void(* | StateTransitionCallback) (const std::string &oldState, const std::string &newState) |
Common signature used by callbacks to application's state transition trace source. | |
Protected Attributes inherited from ns3::Application | |
Ptr< Node > | m_node |
The node that this application is installed on. | |
EventId | m_startEvent |
The event that will fire at m_startTime to start the application. | |
Time | m_startTime |
The simulation time that the application will start. | |
EventId | m_stopEvent |
The event that will fire at m_stopTime to end the application. | |
Time | m_stopTime |
The simulation time that the application will end. | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
A Udp Echo client.
Every packet sent should be returned by the server and received here.
ns3::UdpEchoClient is accessible through the following paths with Config::Set and Config::Connect:
Time
+9.22337e+18ns:+9.22337e+18ns Address
Time
+9.22337e+18ns:+9.22337e+18ns Time
+9.22337e+18ns:+9.22337e+18ns Size of this type is 264 bytes (on a 64-bit architecture).
Definition at line 39 of file udp-echo-client.h.
ns3::UdpEchoClient::UdpEchoClient | ( | ) |
Definition at line 93 of file udp-echo-client.cc.
References m_data, m_dataSize, m_sendEvent, m_sent, m_socket, and NS_LOG_FUNCTION.
|
override |
Definition at line 103 of file udp-echo-client.cc.
References m_data, m_dataSize, m_socket, and NS_LOG_FUNCTION.
|
overrideprotectedvirtual |
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::Object.
Definition at line 129 of file udp-echo-client.cc.
References ns3::Application::DoDispose(), and NS_LOG_FUNCTION.
uint32_t ns3::UdpEchoClient::GetDataSize | ( | ) | const |
Get the number of data bytes that will be sent to the server.
Definition at line 221 of file udp-echo-client.cc.
References m_size, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
|
static |
Get the type ID.
Definition at line 40 of file udp-echo-client.cc.
References GetDataSize(), m_count, m_interval, m_peerAddress, m_peerPort, m_rxTrace, m_rxTraceWithAddresses, m_txTrace, m_txTraceWithAddresses, ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), ns3::Seconds(), SetDataSize(), and ns3::TypeId::SetParent().
Referenced by ns3::UdpEchoClientHelper::UdpEchoClientHelper().
Handle a packet reception.
This function is called by lower layers.
socket | the socket the packet was received to. |
Definition at line 402 of file udp-echo-client.cc.
References ns3::Inet6SocketAddress::ConvertFrom(), ns3::InetSocketAddress::ConvertFrom(), ns3::InetSocketAddress::GetIpv4(), ns3::Inet6SocketAddress::GetIpv6(), ns3::InetSocketAddress::GetPort(), ns3::Inet6SocketAddress::GetPort(), ns3::Inet6SocketAddress::IsMatchingType(), ns3::InetSocketAddress::IsMatchingType(), m_rxTrace, m_rxTraceWithAddresses, ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_INFO, and ns3::Time::S.
Referenced by StartApplication().
|
private |
Schedule the next packet transmission.
dt | time interval between packets. |
Definition at line 308 of file udp-echo-client.cc.
References m_sendEvent, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), and Send().
Referenced by Send(), and StartApplication().
|
private |
Send a packet.
Definition at line 315 of file udp-echo-client.cc.
References ns3::Inet6SocketAddress::ConvertFrom(), ns3::InetSocketAddress::ConvertFrom(), ns3::Ipv4Address::ConvertFrom(), ns3::Ipv6Address::ConvertFrom(), ns3::Socket::GetSockName(), ns3::EventId::IsExpired(), ns3::Inet6SocketAddress::IsMatchingType(), ns3::InetSocketAddress::IsMatchingType(), ns3::Ipv4Address::IsMatchingType(), ns3::Ipv6Address::IsMatchingType(), m_count, m_data, m_dataSize, m_interval, m_peerAddress, m_peerPort, m_sendEvent, m_sent, m_size, m_socket, m_txTrace, m_txTraceWithAddresses, ns3::Simulator::Now(), NS_ASSERT, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_INFO, ns3::Time::S, ScheduleTransmit(), and ns3::Socket::Send().
Referenced by ScheduleTransmit().
void ns3::UdpEchoClient::SetDataSize | ( | uint32_t | dataSize | ) |
Set the data size of the packet (the number of bytes that are sent as data to the server).
The contents of the data are set to unspecified (don't care) by this call.
dataSize | The size of the echo data you want to sent. |
Definition at line 205 of file udp-echo-client.cc.
References m_data, m_dataSize, m_size, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
void ns3::UdpEchoClient::SetFill | ( | std::string | fill | ) |
Set the data fill of the packet (what is sent as data to the server) to the zero-terminated contents of the fill string string.
fill | The string to use as the actual echo data bytes. |
Definition at line 228 of file udp-echo-client.cc.
References m_data, m_dataSize, m_size, and NS_LOG_FUNCTION.
Set the data fill of the packet (what is sent as data to the server) to the contents of the fill buffer, repeated as many times as is required.
Initializing the packet to the contents of a provided single buffer is accomplished by setting the fillSize set to your desired dataSize (and providing an appropriate buffer).
fill | The fill pattern to use when constructing packets. |
fillSize | The number of bytes in the provided fill pattern. |
dataSize | The desired size of the final echo data. |
Definition at line 269 of file udp-echo-client.cc.
References m_data, m_dataSize, m_size, and NS_LOG_FUNCTION.
void ns3::UdpEchoClient::SetFill | ( | uint8_t | fill, |
uint32_t | dataSize | ||
) |
Set the data fill of the packet (what is sent as data to the server) to the repeated contents of the fill byte.
i.e., the fill byte will be used to initialize the contents of the data packet.
fill | The byte to be repeated in constructing the packet data.. |
dataSize | The desired size of the resulting echo packet data. |
Definition at line 250 of file udp-echo-client.cc.
References m_data, m_dataSize, m_size, and NS_LOG_FUNCTION.
void ns3::UdpEchoClient::SetRemote | ( | Address | addr | ) |
set the remote address
addr | remote address |
Definition at line 122 of file udp-echo-client.cc.
References m_peerAddress, and NS_LOG_FUNCTION.
void ns3::UdpEchoClient::SetRemote | ( | Address | ip, |
uint16_t | port | ||
) |
set the remote address and port
ip | remote IP address |
port | remote port |
Definition at line 114 of file udp-echo-client.cc.
References m_peerAddress, m_peerPort, NS_LOG_FUNCTION, and port.
|
overrideprivatevirtual |
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 136 of file udp-echo-client.cc.
References ns3::Socket::Bind(), ns3::Socket::Bind6(), ns3::Socket::Connect(), ns3::Ipv4Address::ConvertFrom(), ns3::Ipv6Address::ConvertFrom(), ns3::Socket::CreateSocket(), ns3::Application::GetNode(), HandleRead(), ns3::Inet6SocketAddress::IsMatchingType(), ns3::InetSocketAddress::IsMatchingType(), ns3::Ipv4Address::IsMatchingType(), ns3::Ipv6Address::IsMatchingType(), ns3::TypeId::LookupByName(), m_peerAddress, m_peerPort, m_socket, ns3::MakeCallback(), NS_ASSERT_MSG, NS_FATAL_ERROR, NS_LOG_FUNCTION, ScheduleTransmit(), ns3::Seconds(), ns3::Socket::SetAllowBroadcast(), and ns3::Socket::SetRecvCallback().
|
overrideprivatevirtual |
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 190 of file udp-echo-client.cc.
References ns3::Simulator::Cancel(), ns3::Socket::Close(), m_sendEvent, m_socket, ns3::MakeNullCallback(), NS_LOG_FUNCTION, and ns3::Socket::SetRecvCallback().
|
private |
Maximum number of packets the application will send.
Definition at line 159 of file udp-echo-client.h.
Referenced by GetTypeId(), and Send().
|
private |
packet payload data
Definition at line 164 of file udp-echo-client.h.
Referenced by UdpEchoClient(), ~UdpEchoClient(), Send(), SetDataSize(), and SetFill().
|
private |
packet payload size (must be equal to m_size)
Definition at line 163 of file udp-echo-client.h.
Referenced by UdpEchoClient(), ~UdpEchoClient(), Send(), SetDataSize(), and SetFill().
|
private |
Packet inter-send time.
Definition at line 160 of file udp-echo-client.h.
Referenced by GetTypeId(), and Send().
|
private |
Remote peer address.
Definition at line 168 of file udp-echo-client.h.
Referenced by GetTypeId(), Send(), SetRemote(), and StartApplication().
|
private |
Remote peer port.
Definition at line 169 of file udp-echo-client.h.
Referenced by GetTypeId(), Send(), SetRemote(), and StartApplication().
|
private |
Callbacks for tracing the packet Rx events.
Definition at line 176 of file udp-echo-client.h.
Referenced by GetTypeId(), and HandleRead().
|
private |
Callbacks for tracing the packet Rx events, includes source and destination addresses.
Definition at line 182 of file udp-echo-client.h.
Referenced by GetTypeId(), and HandleRead().
|
private |
Event to send the next packet.
Definition at line 170 of file udp-echo-client.h.
Referenced by UdpEchoClient(), ScheduleTransmit(), Send(), and StopApplication().
|
private |
Counter for sent packets.
Definition at line 166 of file udp-echo-client.h.
Referenced by UdpEchoClient(), and Send().
|
private |
Size of the sent packet.
Definition at line 161 of file udp-echo-client.h.
Referenced by GetDataSize(), Send(), SetDataSize(), and SetFill().
Definition at line 167 of file udp-echo-client.h.
Referenced by UdpEchoClient(), ~UdpEchoClient(), Send(), StartApplication(), and StopApplication().
|
private |
Callbacks for tracing the packet Tx events.
Definition at line 173 of file udp-echo-client.h.
Referenced by GetTypeId(), and Send().
|
private |
Callbacks for tracing the packet Tx events, includes source and destination addresses.
Definition at line 179 of file udp-echo-client.h.
Referenced by GetTypeId(), and Send().