A Discrete-Event Network Simulator
API
packet-socket-client.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014 Universita' di Firenze
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Tommaso Pecorella <tommaso.pecorella@unifi.it>
19  */
20 
21 #include "ns3/log.h"
22 #include "ns3/nstime.h"
23 #include "ns3/packet-socket-address.h"
24 #include "ns3/packet-socket.h"
25 #include "ns3/packet-socket-factory.h"
26 #include "ns3/socket.h"
27 #include "ns3/simulator.h"
28 #include "ns3/socket-factory.h"
29 #include "ns3/packet.h"
30 #include "ns3/uinteger.h"
31 #include "ns3/abort.h"
32 #include "packet-socket-client.h"
33 #include <cstdlib>
34 #include <cstdio>
35 
36 namespace ns3 {
37 
38 NS_LOG_COMPONENT_DEFINE ("PacketSocketClient");
39 
40 NS_OBJECT_ENSURE_REGISTERED (PacketSocketClient);
41 
42 TypeId
44 {
45  static TypeId tid = TypeId ("ns3::PacketSocketClient")
47  .SetGroupName("Network")
48  .AddConstructor<PacketSocketClient> ()
49  .AddAttribute ("MaxPackets",
50  "The maximum number of packets the application will send (zero means infinite)",
51  UintegerValue (100),
53  MakeUintegerChecker<uint32_t> ())
54  .AddAttribute ("Interval",
55  "The time to wait between packets", TimeValue (Seconds (1.0)),
57  MakeTimeChecker ())
58  .AddAttribute ("PacketSize",
59  "Size of packets generated (bytes).",
60  UintegerValue (1024),
62  MakeUintegerChecker<uint32_t> ())
63  .AddAttribute ("Priority",
64  "Priority assigned to the packets generated.",
65  UintegerValue (0),
68  MakeUintegerChecker<uint8_t> ())
69  .AddTraceSource ("Tx", "A packet has been sent",
71  "ns3::Packet::AddressTracedCallback")
72  ;
73  return tid;
74 }
75 
77 {
78  NS_LOG_FUNCTION (this);
79  m_sent = 0;
80  m_socket = 0;
81  m_sendEvent = EventId ();
82  m_peerAddressSet = false;
83 }
84 
86 {
87  NS_LOG_FUNCTION (this);
88 }
89 
90 void
92 {
93  NS_LOG_FUNCTION (this << addr);
94  m_peerAddress = addr;
95  m_peerAddressSet = true;
96 }
97 
98 void
100 {
101  NS_LOG_FUNCTION (this);
103 }
104 
105 void
107 {
108  m_priority = priority;
109  if (m_socket)
110  {
111  m_socket->SetPriority (priority);
112  }
113 }
114 
115 uint8_t
117 {
118  return m_priority;
119 }
120 
121 void
123 {
124  NS_LOG_FUNCTION (this);
125  NS_ASSERT_MSG (m_peerAddressSet, "Peer address not set");
126 
127  if (m_socket == 0)
128  {
129  TypeId tid = TypeId::LookupByName ("ns3::PacketSocketFactory");
131 
134 
135  if (m_priority)
136  {
138  }
139  }
140 
143 }
144 
145 void
147 {
148  NS_LOG_FUNCTION (this);
150  m_socket->Close ();
151 }
152 
153 void
155 {
156  NS_LOG_FUNCTION (this);
158 
159  Ptr<Packet> p = Create<Packet> (m_size);
160 
161  std::stringstream peerAddressStringStream;
162  peerAddressStringStream << PacketSocketAddress::ConvertFrom (m_peerAddress);
163 
164  if ((m_socket->Send (p)) >= 0)
165  {
167  NS_LOG_INFO ("TraceDelay TX " << m_size << " bytes to "
168  << peerAddressStringStream.str () << " Uid: "
169  << p->GetUid () << " Time: "
170  << (Simulator::Now ()).GetSeconds ());
171  }
172  else
173  {
174  NS_LOG_INFO ("Error while sending " << m_size << " bytes to "
175  << peerAddressStringStream.str ());
176  }
177  m_sent++;
178 
179  if ((m_sent < m_maxPackets) || (m_maxPackets == 0))
180  {
182  }
183 }
184 
185 } // Namespace ns3
uint32_t m_maxPackets
Maximum number of packets the application will send.
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by "...
virtual void StopApplication(void)
Application specific shutdown code.
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
NS_ASSERT_MSG(false, "Ipv4AddressGenerator::MaskToIndex(): Impossible")
an address for a packet socket
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file...
Definition: assert.h:67
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:204
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:280
bool m_peerAddressSet
Sanity check.
static void Cancel(const EventId &id)
Set the cancel bit on this event: the event&#39;s associated function will not be invoked when it expires...
Definition: simulator.cc:290
Callback< R > MakeNullCallback(void)
Definition: callback.h:1635
bool IsExpired(void) const
This method is syntactic sugar for the ns3::Simulator::IsExpired method.
Definition: event-id.cc:59
Ptr< const TraceSourceAccessor > MakeTraceSourceAccessor(T a)
Create a TraceSourceAccessor which will control access to the underlying trace source.
Ptr< const AttributeChecker > MakeTimeChecker(const Time min, const Time max)
Helper to make a Time checker with bounded range.
Definition: time.cc:446
uint32_t m_sent
Counter for sent packets.
Time m_interval
Packet inter-send time.
static EventId Schedule(Time const &delay, MEM mem_ptr, OBJ obj)
Schedule an event to expire after delay.
Definition: simulator.h:1389
virtual void StartApplication(void)
Application specific startup code.
The base class for all ns3 applications.
Definition: application.h:60
EventId m_sendEvent
Event to send the next packet.
AttributeValue implementation for Time.
Definition: nstime.h:1124
Hold an unsigned integer type.
Definition: uinteger.h:44
static TypeId GetTypeId(void)
Get the type ID.
void SetRecvCallback(Callback< void, Ptr< Socket > >)
Notify application when new data is available to be read.
Definition: socket.cc:128
static Ptr< Socket > CreateSocket(Ptr< Node > node, TypeId tid)
This method wraps the creation of sockets that is performed on a given node by a SocketFactory specif...
Definition: socket.cc:71
void SetPriority(uint8_t priority)
Manually set the socket priority.
Ptr< Socket > m_socket
Socket.
Ptr< Node > GetNode() const
Definition: application.cc:104
virtual int Connect(const Address &address)=0
Initiate a connection to a remote host.
virtual void DoDispose(void)
Destructor implementation.
Definition: application.cc:83
virtual int Bind(const Address &address)=0
Allocate a local endpoint for this socket.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
virtual void DoDispose(void)
Destructor implementation.
static EventId ScheduleNow(MEM mem_ptr, OBJ obj)
Schedule an event to expire Now.
Definition: simulator.h:1578
Ptr< const AttributeAccessor > MakeTimeAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: nstime.h:1125
static Time Now(void)
Return the current simulation virtual time.
Definition: simulator.cc:193
TracedCallback< Ptr< const Packet >, const Address & > m_txTrace
Traced Callback: sent packets, source address.
An identifier for simulation events.
Definition: event-id.h:53
void SetPriority(uint8_t priority)
Manually set the socket priority.
Definition: socket.cc:389
void SetRemote(PacketSocketAddress addr)
set the remote address and protocol to be used
uint8_t GetPriority(void) const
Query the priority value of this socket.
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1062
void Send(void)
Send a packet.
static PacketSocketAddress ConvertFrom(const Address &address)
PacketSocketAddress m_peerAddress
Remote peer address.
virtual int Send(Ptr< Packet > p, uint32_t flags)=0
Send data (or dummy data) to the remote host.
virtual int Close(void)=0
Close a socket.
Ptr< const AttributeAccessor > MakeUintegerAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: uinteger.h:45
a unique identifier for an interface.
Definition: type-id.h:58
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:915
uint32_t m_size
Size of the sent packet.
static TypeId LookupByName(std::string name)
Get a TypeId by name.
Definition: type-id.cc:824
uint8_t m_priority
Priority of the sent packets.