A Discrete-Event Network Simulator
API
udp-trace-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: Mohamed Amine Ismail <amine.ismail@sophia.inria.fr>
18  * <amine.ismail@udcast.com>
19  */
20 
21 #ifndef UDP_TRACE_CLIENT_H
22 #define UDP_TRACE_CLIENT_H
23 
24 #include "ns3/application.h"
25 #include "ns3/event-id.h"
26 #include "ns3/ipv4-address.h"
27 #include "ns3/ptr.h"
28 
29 #include <vector>
30 
31 namespace ns3
32 {
33 
34 class Socket;
35 class Packet;
36 
64 {
65  public:
70  static TypeId GetTypeId();
71 
73 
85  UdpTraceClient(Ipv4Address ip, uint16_t port, char* traceFile);
86  ~UdpTraceClient() override;
87 
93  void SetRemote(Address ip, uint16_t port);
98  void SetRemote(Address addr);
99 
107  void SetTraceFile(std::string filename);
108 
113  uint16_t GetMaxPacketSize();
114 
119  void SetMaxPacketSize(uint16_t maxPacketSize);
120 
125  void SetTraceLoop(bool traceLoop);
126 
127  protected:
128  void DoDispose() override;
129 
130  private:
135  void LoadTrace(std::string filename);
139  void LoadDefaultTrace();
140  void StartApplication() override;
141  void StopApplication() override;
142 
146  void Send();
151  void SendPacket(uint32_t size);
152 
158  struct TraceEntry
159  {
160  uint32_t timeToSend;
161  uint32_t packetSize;
162  char frameType;
163  };
164 
165  uint32_t m_sent;
168  uint16_t m_peerPort;
170 
171  std::vector<TraceEntry> m_entries;
172  uint32_t m_currentEntry;
174  uint16_t m_maxPacketSize;
175  bool m_traceLoop;
176 };
177 
178 } // namespace ns3
179 
180 #endif /* UDP_TRACE_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
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:42
a unique identifier for an interface.
Definition: type-id.h:59
A trace based streamer.
EventId m_sendEvent
Event to send the next packet.
void StopApplication() override
Application specific shutdown code.
static TypeId GetTypeId()
Get the type ID.
void Send()
Send a packet.
uint16_t m_peerPort
Remote peer port.
void SetTraceLoop(bool traceLoop)
Set the trace loop flag.
uint32_t m_sent
Counter for sent packets.
void SetRemote(Address ip, uint16_t port)
set the remote address and port
Address m_peerAddress
Remote peer address.
std::vector< TraceEntry > m_entries
Entries in the trace to send.
uint32_t m_currentEntry
Current entry index.
void SetTraceFile(std::string filename)
Set the trace file to be used by the application.
void LoadTrace(std::string filename)
Load a trace file.
void SetMaxPacketSize(uint16_t maxPacketSize)
Set the maximum packet size.
void StartApplication() override
Application specific startup code.
void DoDispose() override
Destructor implementation.
void SendPacket(uint32_t size)
Send a packet of a given size.
bool m_traceLoop
Loop through the trace file.
uint16_t m_maxPacketSize
Maximum packet size to send (including the SeqTsHeader)
static TraceEntry g_defaultEntries[]
Default trace to send.
uint16_t GetMaxPacketSize()
Return the maximum packet size.
void LoadDefaultTrace()
Load the default trace.
Ptr< Socket > m_socket
Socket.
uint16_t port
Definition: dsdv-manet.cc:44
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Entry to send.
uint32_t timeToSend
Time to send the frame.
uint32_t packetSize
Size of the frame.
char frameType
Frame type (I, P or B)