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 (const Address &addr) override |
| set the remote address | |
| void | SetRemote (const Address &ip, uint16_t port) |
| set the remote address and port | |
| Public Member Functions inherited from ns3::SourceApplication | |
| SourceApplication (bool allowPacketSocket=true) | |
| Constructor. | |
| ~SourceApplication () override | |
| Address | GetRemote () const |
| get the remote address | |
| Ptr< Socket > | GetSocket () const |
| Get the socket this application is attached to. | |
| Public Member Functions inherited from ns3::Application | |
| Application () | |
| ~Application () override | |
| virtual int64_t | AssignStreams (int64_t stream) |
| Assign a fixed random variable stream number to the random variables used by this Application object. | |
| 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 final |
| Get the most derived TypeId for this Object. | |
| template<> | |
| Ptr< Object > | GetObject () const |
| Specialization of () for objects of type ns3::Object. | |
| template<typename T> | |
| Ptr< T > | GetObject () const |
| Get a pointer to the requested aggregated Object. | |
| template<> | |
| Ptr< Object > | GetObject (TypeId tid) const |
| Specialization of (TypeId tid) 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. | |
| void | Initialize () |
| Invoke DoInitialize on all Objects aggregated to this one. | |
| bool | IsInitialized () const |
| Check if the object has been initialized. | |
| void | UnidirectionalAggregateObject (Ptr< Object > other) |
| Aggregate an Object to another Object. | |
| Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
| SimpleRefCount () | |
| Default 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, bool permissive=false) 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. | |
| 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::SourceApplication | |
| 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. | |
Static Public Attributes | |
| static constexpr uint16_t | DEFAULT_PORT {0} |
| default port | |
Private Member Functions | |
| void | CancelEvents () override |
| Cancel all pending events. | |
| void | DoStartApplication () override |
| Application specific startup code for child subclasses. | |
| uint16_t | GetPort () const |
| Get the remote port (temporary function until deprecated attributes are removed). | |
| Address | GetRemote () const |
| Get the remote address (temporary function until deprecated attributes are removed). | |
| void | HandleRead (Ptr< Socket > socket) |
| Handle a packet reception. | |
| void | ScheduleTransmit (Time dt) |
| Schedule the next packet transmission. | |
| void | Send () |
| Send a packet. | |
| void | SetPort (uint16_t port) |
| Set the remote port (temporary function until deprecated attributes are removed). | |
Private Attributes | |
| uint32_t | m_count |
| Maximum number of packets the application will send. | |
| uint8_t * | m_data {nullptr} |
| packet payload data | |
| uint32_t | m_dataSize {0} |
| packet payload size (must be equal to m_size) | |
| Time | m_interval |
| Packet inter-send time. | |
| std::optional< uint16_t > | m_peerPort |
| Remote peer port (deprecated) // NS_DEPRECATED_3_44. | |
| 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 {0} |
| Counter for sent packets. | |
| uint32_t | m_size |
| Size of the sent packet. | |
| 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 Types inherited from ns3::SourceApplication | |
| typedef void(* | ConnectionEventCallback) (Ptr< Socket > socket, const Address &local, const Address &remote) |
| TracedCallback signature for connection success/failure event. | |
| Protected Member Functions inherited from ns3::SourceApplication | |
| bool | CloseSocket () |
| Close the socket. | |
| void | DoDispose () override |
| Destructor implementation. | |
| Protected Member Functions inherited from ns3::Application | |
| void | DoInitialize () override |
| Initialize() implementation. | |
| Protected Member Functions inherited from ns3::Object | |
| Object (const Object &o) | |
| Copy an Object. | |
| 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. | |
| Protected Attributes inherited from ns3::SourceApplication | |
| bool | m_connected {false} |
| flag whether socket is connected | |
| TracedCallback< Ptr< Socket >, const Address &, const Address & > | m_connectionFailure |
| Traced Callback: connection failure event. | |
| TracedCallback< Ptr< Socket >, const Address &, const Address & > | m_connectionSuccess |
| Traced Callback: connection success event. | |
| Address | m_local |
| Local address to bind to. | |
| Address | m_peer |
| Peer address. | |
| TypeId | m_protocolTid |
| Protocol TypeId value. | |
| Ptr< Socket > | m_socket |
| Socket. | |
| uint8_t | m_tos |
| The packets Type of Service. | |
| TracedCallback< Ptr< const Packet > > | m_txTrace |
| Traced Callback: transmitted packets. | |
| 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 Symbols 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 Address Address Time -9.22337e+18ns:+9.22337e+18ns Time -9.22337e+18ns:+9.22337e+18ns Group: Applications
Size of this type is 392 bytes (on a 64-bit architecture).
Definition at line 31 of file udp-echo-client.h.
| ns3::UdpEchoClient::UdpEchoClient | ( | ) |
Definition at line 85 of file udp-echo-client.cc.
References ns3::SourceApplication::SourceApplication(), ns3::TypeId::LookupByName(), ns3::SourceApplication::m_protocolTid, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
|
override |
Definition at line 92 of file udp-echo-client.cc.
References m_data, m_dataSize, and NS_LOG_FUNCTION.
|
overrideprivatevirtual |
Cancel all pending events.
Implements ns3::SourceApplication.
Definition at line 370 of file udp-echo-client.cc.
References ns3::Simulator::Cancel(), m_sendEvent, and NS_LOG_FUNCTION.
|
overrideprivatevirtual |
Application specific startup code for child subclasses.
Reimplemented from ns3::SourceApplication.
Definition at line 164 of file udp-echo-client.cc.
References HandleRead(), ns3::SourceApplication::m_socket, ns3::MakeCallback(), NS_LOG_FUNCTION, and ScheduleTransmit().
| uint32_t ns3::UdpEchoClient::GetDataSize | ( | ) | const |
Get the number of data bytes that will be sent to the server.
Definition at line 189 of file udp-echo-client.cc.
References m_size.
Referenced by GetTypeId().
|
private |
Get the remote port (temporary function until deprecated attributes are removed).
Definition at line 146 of file udp-echo-client.cc.
References ns3::Inet6SocketAddress::ConvertFrom(), ns3::InetSocketAddress::ConvertFrom(), DEFAULT_PORT, ns3::Inet6SocketAddress::GetPort(), ns3::InetSocketAddress::GetPort(), ns3::Inet6SocketAddress::IsMatchingType(), ns3::InetSocketAddress::IsMatchingType(), ns3::SourceApplication::m_peer, and m_peerPort.
Referenced by GetTypeId(), and Send().
|
private |
Get the remote address (temporary function until deprecated attributes are removed).
Definition at line 124 of file udp-echo-client.cc.
References ns3::SourceApplication::m_peer.
Referenced by GetTypeId().
|
static |
Get the type ID.
Definition at line 26 of file udp-echo-client.cc.
References ns3::SourceApplication::SourceApplication(), UdpEchoClient(), DEFAULT_PORT, ns3::TypeId::DEPRECATED, GetDataSize(), GetPort(), GetRemote(), m_count, m_interval, m_rxTrace, m_rxTraceWithAddresses, m_txTraceWithAddresses, ns3::MakeAddressAccessor(), ns3::MakeAddressChecker(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), ns3::Seconds(), SetDataSize(), ns3::TypeId::SetParent(), SetPort(), and SetRemote().
Handle a packet reception.
This function is called by lower layers.
| socket | the socket the packet was received to. |
Definition at line 342 of file udp-echo-client.cc.
References ns3::Inet6SocketAddress::ConvertFrom(), ns3::InetSocketAddress::ConvertFrom(), 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 DoStartApplication().
|
private |
Schedule the next packet transmission.
| dt | time interval between packets. |
Definition at line 275 of file udp-echo-client.cc.
References m_sendEvent, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), and Send().
Referenced by DoStartApplication(), and Send().
|
private |
Send a packet.
Definition at line 282 of file udp-echo-client.cc.
References ns3::Inet6SocketAddress::ConvertFrom(), ns3::InetSocketAddress::ConvertFrom(), ns3::Create(), GetPort(), ns3::Inet6SocketAddress::IsMatchingType(), ns3::InetSocketAddress::IsMatchingType(), m_count, m_data, m_dataSize, m_interval, ns3::SourceApplication::m_peer, m_sendEvent, m_sent, m_size, ns3::SourceApplication::m_socket, ns3::SourceApplication::m_txTrace, m_txTraceWithAddresses, ns3::Simulator::Now(), NS_ASSERT, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_INFO, ns3::Time::S, and ScheduleTransmit().
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 173 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 195 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 236 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 217 of file udp-echo-client.cc.
References m_data, m_dataSize, m_size, and NS_LOG_FUNCTION.
|
private |
Set the remote port (temporary function until deprecated attributes are removed).
| port | remote port |
Definition at line 130 of file udp-echo-client.cc.
References ns3::addressUtils::ConvertToSocketAddress(), ns3::Ipv4Address::IsMatchingType(), ns3::Ipv6Address::IsMatchingType(), ns3::SourceApplication::m_peer, m_peerPort, NS_LOG_FUNCTION, and port.
Referenced by GetTypeId(), SetRemote(), and SetRemote().
|
overridevirtual |
set the remote address
| addr | remote address |
Reimplemented from ns3::SourceApplication.
Definition at line 110 of file udp-echo-client.cc.
References ns3::Address::IsInvalid(), ns3::SourceApplication::m_peer, m_peerPort, NS_LOG_FUNCTION, and SetPort().
| void ns3::UdpEchoClient::SetRemote | ( | const Address & | ip, |
| uint16_t | port ) |
set the remote address and port
| ip | remote IP address |
| port | remote port |
Definition at line 102 of file udp-echo-client.cc.
References NS_LOG_FUNCTION, port, SetPort(), and SetRemote().
Referenced by GetTypeId(), and SetRemote().
|
staticconstexpr |
default port
Definition at line 43 of file udp-echo-client.h.
Referenced by GetPort(), and GetTypeId().
|
private |
Maximum number of packets the application will send.
Definition at line 164 of file udp-echo-client.h.
Referenced by GetTypeId(), and Send().
|
private |
packet payload data
Definition at line 169 of file udp-echo-client.h.
Referenced by ~UdpEchoClient(), Send(), SetDataSize(), SetFill(), SetFill(), and SetFill().
|
private |
packet payload size (must be equal to m_size)
Definition at line 168 of file udp-echo-client.h.
Referenced by ~UdpEchoClient(), Send(), SetDataSize(), SetFill(), SetFill(), and SetFill().
|
private |
Packet inter-send time.
Definition at line 165 of file udp-echo-client.h.
Referenced by GetTypeId(), and Send().
|
private |
Remote peer port (deprecated) // NS_DEPRECATED_3_44.
Definition at line 172 of file udp-echo-client.h.
Referenced by GetPort(), SetPort(), and SetRemote().
|
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 173 of file udp-echo-client.h.
Referenced by CancelEvents(), ScheduleTransmit(), and Send().
|
private |
|
private |
Size of the sent packet.
Definition at line 166 of file udp-echo-client.h.
Referenced by GetDataSize(), Send(), SetDataSize(), SetFill(), SetFill(), and SetFill().
|
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().