A Discrete-Event Network Simulator
API
udp-client.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2007,2008,2009 INRIA, UDCAST
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  * Author: Amine Ismail <amine.ismail@sophia.inria.fr>
18  * <amine.ismail@udcast.com>
19  *
20  */
21 
22 #ifndef UDP_CLIENT_H
23 #define UDP_CLIENT_H
24 
25 #include "ns3/application.h"
26 #include "ns3/event-id.h"
27 #include "ns3/ipv4-address.h"
28 #include "ns3/ptr.h"
29 #include <ns3/traced-callback.h>
30 
31 namespace ns3
32 {
33 
34 class Socket;
35 class Packet;
36 
44 class UdpClient : public Application
45 {
46  public:
51  static TypeId GetTypeId();
52 
53  UdpClient();
54 
55  ~UdpClient() override;
56 
62  void SetRemote(Address ip, uint16_t port);
67  void SetRemote(Address addr);
68 
72  uint64_t GetTotalTx() const;
73 
74  protected:
75  void DoDispose() override;
76 
77  private:
78  void StartApplication() override;
79  void StopApplication() override;
80 
84  void Send();
85 
88 
91 
92  uint32_t m_count;
94  uint32_t m_size;
95 
96  uint32_t m_sent;
97  uint64_t m_totalTx;
100  uint16_t m_peerPort;
102 
103 #ifdef NS3_LOG_ENABLE
104  std::string m_peerAddressString;
105 #endif // NS3_LOG_ENABLE
106 };
107 
108 } // namespace ns3
109 
110 #endif /* UDP_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 client.
Definition: udp-client.h:45
Time m_interval
Packet inter-send time.
Definition: udp-client.h:93
void DoDispose() override
Destructor implementation.
Definition: udp-client.cc:121
uint64_t GetTotalTx() const
Definition: udp-client.cc:253
uint64_t m_totalTx
Total bytes sent.
Definition: udp-client.h:97
~UdpClient() override
Definition: udp-client.cc:100
uint32_t m_sent
Counter for sent packets.
Definition: udp-client.h:96
Ptr< Socket > m_socket
Socket.
Definition: udp-client.h:98
TracedCallback< Ptr< const Packet >, const Address &, const Address & > m_txTraceWithAddresses
Callbacks for tracing the packet Tx events, includes source and destination addresses.
Definition: udp-client.h:90
uint16_t m_peerPort
Remote peer port.
Definition: udp-client.h:100
void Send()
Send a packet.
Definition: udp-client.cc:210
static TypeId GetTypeId()
Get the type ID.
Definition: udp-client.cc:46
EventId m_sendEvent
Event to send the next packet.
Definition: udp-client.h:101
uint32_t m_size
Size of the sent packet (including the SeqTsHeader)
Definition: udp-client.h:94
uint32_t m_count
Maximum number of packets the application will send.
Definition: udp-client.h:92
void SetRemote(Address ip, uint16_t port)
set the remote address and port
Definition: udp-client.cc:106
Address m_peerAddress
Remote peer address.
Definition: udp-client.h:99
TracedCallback< Ptr< const Packet > > m_txTrace
Traced Callback: transmitted packets.
Definition: udp-client.h:87
void StartApplication() override
Application specific startup code.
Definition: udp-client.cc:128
void StopApplication() override
Application specific shutdown code.
Definition: udp-client.cc:203
std::string m_peerAddressString
Remote peer address string.
Definition: udp-client.h:104
uint16_t port
Definition: dsdv-manet.cc:44
Every class exported by the ns3 library is enclosed in the ns3 namespace.