A Discrete-Event Network Simulator
API
udp-echo-client.h
Go to the documentation of this file.
1 /*
2  * Copyright 2007 University of Washington
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation;
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write to the Free Software
15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16  */
17 
18 #ifndef UDP_ECHO_CLIENT_H
19 #define UDP_ECHO_CLIENT_H
20 
21 #include "ns3/application.h"
22 #include "ns3/event-id.h"
23 #include "ns3/ipv4-address.h"
24 #include "ns3/ptr.h"
25 #include "ns3/traced-callback.h"
26 
27 namespace ns3
28 {
29 
30 class Socket;
31 class Packet;
32 
39 class UdpEchoClient : public Application
40 {
41  public:
46  static TypeId GetTypeId();
47 
48  UdpEchoClient();
49 
50  ~UdpEchoClient() override;
51 
57  void SetRemote(Address ip, uint16_t port);
62  void SetRemote(Address addr);
63 
74  void SetDataSize(uint32_t dataSize);
75 
87  uint32_t GetDataSize() const;
88 
99  void SetFill(std::string fill);
100 
113  void SetFill(uint8_t fill, uint32_t dataSize);
114 
131  void SetFill(uint8_t* fill, uint32_t fillSize, uint32_t dataSize);
132 
133  protected:
134  void DoDispose() override;
135 
136  private:
137  void StartApplication() override;
138  void StopApplication() override;
139 
144  void ScheduleTransmit(Time dt);
148  void Send();
149 
157  void HandleRead(Ptr<Socket> socket);
158 
159  uint32_t m_count;
161  uint32_t m_size;
162 
163  uint32_t m_dataSize;
164  uint8_t* m_data;
165 
166  uint32_t m_sent;
169  uint16_t m_peerPort;
171 
174 
177 
180 
183 };
184 
185 } // namespace ns3
186 
187 #endif /* UDP_ECHO_CLIENT_H */
a polymophic address class
Definition: address.h:101
The base class for all ns3 applications.
Definition: application.h:62
An identifier for simulation events.
Definition: event-id.h:55
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:105
Forward calls to a chain of Callback.
a unique identifier for an interface.
Definition: type-id.h:59
A Udp Echo client.
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 ...
Time m_interval
Packet inter-send time.
void DoDispose() override
Destructor implementation.
void Send()
Send a packet.
void StopApplication() override
Application specific shutdown code.
Ptr< Socket > m_socket
Socket.
void HandleRead(Ptr< Socket > socket)
Handle a packet reception.
EventId m_sendEvent
Event to send the next packet.
uint32_t m_size
Size of the sent packet.
uint32_t GetDataSize() const
Get the number of data bytes that will be sent to the server.
uint32_t m_count
Maximum number of packets the application will send.
static TypeId GetTypeId()
Get the type ID.
Address m_peerAddress
Remote peer address.
uint8_t * m_data
packet payload data
uint32_t m_sent
Counter for sent packets.
void StartApplication() override
Application specific startup code.
void ScheduleTransmit(Time dt)
Schedule the next packet transmission.
TracedCallback< Ptr< const Packet >, const Address &, const Address & > m_txTraceWithAddresses
Callbacks for tracing the packet Tx events, includes source and destination addresses.
TracedCallback< Ptr< const Packet > > m_txTrace
Callbacks for tracing the packet Tx events.
TracedCallback< Ptr< const Packet >, const Address &, const Address & > m_rxTraceWithAddresses
Callbacks for tracing the packet Rx events, includes source and destination addresses.
void SetDataSize(uint32_t dataSize)
Set the data size of the packet (the number of bytes that are sent as data to the server).
uint16_t m_peerPort
Remote peer port.
TracedCallback< Ptr< const Packet > > m_rxTrace
Callbacks for tracing the packet Rx events.
uint32_t m_dataSize
packet payload size (must be equal to m_size)
void SetRemote(Address ip, uint16_t port)
set the remote address and port
uint16_t port
Definition: dsdv-manet.cc:44
Every class exported by the ns3 library is enclosed in the ns3 namespace.