A Discrete-Event Network Simulator
API
udp-server.cc
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#include "udp-server.h"
22
23#include "packet-loss-counter.h"
24#include "seq-ts-header.h"
25
26#include "ns3/inet-socket-address.h"
27#include "ns3/inet6-socket-address.h"
28#include "ns3/ipv4-address.h"
29#include "ns3/log.h"
30#include "ns3/nstime.h"
31#include "ns3/packet.h"
32#include "ns3/simulator.h"
33#include "ns3/socket-factory.h"
34#include "ns3/socket.h"
35#include "ns3/uinteger.h"
36
37namespace ns3
38{
39
40NS_LOG_COMPONENT_DEFINE("UdpServer");
41
43
44TypeId
46{
47 static TypeId tid =
48 TypeId("ns3::UdpServer")
50 .SetGroupName("Applications")
51 .AddConstructor<UdpServer>()
52 .AddAttribute("Port",
53 "Port on which we listen for incoming packets.",
54 UintegerValue(100),
56 MakeUintegerChecker<uint16_t>())
57 .AddAttribute("PacketWindowSize",
58 "The size of the window used to compute the packet loss. This value "
59 "should be a multiple of 8.",
60 UintegerValue(32),
63 MakeUintegerChecker<uint16_t>(8, 256))
64 .AddTraceSource("Rx",
65 "A packet has been received",
67 "ns3::Packet::TracedCallback")
68 .AddTraceSource("RxWithAddresses",
69 "A packet has been received",
71 "ns3::Packet::TwoAddressTracedCallback");
72 return tid;
73}
74
76 : m_lossCounter(0)
77{
78 NS_LOG_FUNCTION(this);
79 m_received = 0;
80}
81
83{
84 NS_LOG_FUNCTION(this);
85}
86
87uint16_t
89{
90 NS_LOG_FUNCTION(this);
92}
93
94void
96{
97 NS_LOG_FUNCTION(this << size);
99}
100
103{
104 NS_LOG_FUNCTION(this);
105 return m_lossCounter.GetLost();
106}
107
108uint64_t
110{
111 NS_LOG_FUNCTION(this);
112 return m_received;
113}
114
115void
117{
118 NS_LOG_FUNCTION(this);
120}
121
122void
124{
125 NS_LOG_FUNCTION(this);
126
127 if (!m_socket)
128 {
129 TypeId tid = TypeId::LookupByName("ns3::UdpSocketFactory");
132 if (m_socket->Bind(local) == -1)
133 {
134 NS_FATAL_ERROR("Failed to bind socket");
135 }
136 }
137
139
140 if (!m_socket6)
141 {
142 TypeId tid = TypeId::LookupByName("ns3::UdpSocketFactory");
145 if (m_socket6->Bind(local) == -1)
146 {
147 NS_FATAL_ERROR("Failed to bind socket");
148 }
149 }
150
152}
153
154void
156{
157 NS_LOG_FUNCTION(this);
158
159 if (m_socket)
160 {
162 }
163}
164
165void
167{
168 NS_LOG_FUNCTION(this << socket);
169 Ptr<Packet> packet;
170 Address from;
171 Address localAddress;
172 while ((packet = socket->RecvFrom(from)))
173 {
174 socket->GetSockName(localAddress);
175 m_rxTrace(packet);
176 m_rxTraceWithAddresses(packet, from, localAddress);
177 if (packet->GetSize() > 0)
178 {
179 uint32_t receivedSize = packet->GetSize();
180 SeqTsHeader seqTs;
181 packet->RemoveHeader(seqTs);
182 uint32_t currentSequenceNumber = seqTs.GetSeq();
184 {
185 NS_LOG_INFO("TraceDelay: RX " << receivedSize << " bytes from "
186 << InetSocketAddress::ConvertFrom(from).GetIpv4()
187 << " Sequence Number: " << currentSequenceNumber
188 << " Uid: " << packet->GetUid() << " TXtime: "
189 << seqTs.GetTs() << " RXtime: " << Simulator::Now()
190 << " Delay: " << Simulator::Now() - seqTs.GetTs());
191 }
193 {
194 NS_LOG_INFO("TraceDelay: RX " << receivedSize << " bytes from "
195 << Inet6SocketAddress::ConvertFrom(from).GetIpv6()
196 << " Sequence Number: " << currentSequenceNumber
197 << " Uid: " << packet->GetUid() << " TXtime: "
198 << seqTs.GetTs() << " RXtime: " << Simulator::Now()
199 << " Delay: " << Simulator::Now() - seqTs.GetTs());
200 }
201
202 m_lossCounter.NotifyReceived(currentSequenceNumber);
203 m_received++;
204 }
205 }
206}
207
208} // Namespace ns3
a polymophic address class
Definition: address.h:100
The base class for all ns3 applications.
Definition: application.h:61
void DoDispose() override
Destructor implementation.
Definition: application.cc:85
Ptr< Node > GetNode() const
Definition: application.cc:107
An Inet6 address class.
static Inet6SocketAddress ConvertFrom(const Address &addr)
Convert the address to a InetSocketAddress.
static bool IsMatchingType(const Address &addr)
If the address match.
an Inet address class
static bool IsMatchingType(const Address &address)
static InetSocketAddress ConvertFrom(const Address &address)
Returns an InetSocketAddress which corresponds to the input Address.
static Ipv4Address GetAny()
static Ipv6Address GetAny()
Get the "any" (::) Ipv6Address.
uint32_t RemoveHeader(Header &header)
Deserialize and remove the header from the internal buffer.
Definition: packet.cc:294
uint32_t GetSize() const
Returns the the size in bytes of the packet (including the zero-filled initial payload).
Definition: packet.h:863
uint64_t GetUid() const
Returns the packet's Uid.
Definition: packet.cc:412
void NotifyReceived(uint32_t seq)
Record a successfully received packet.
void SetBitMapSize(uint16_t size)
Set the size of the window used to compute the packet loss.
uint16_t GetBitMapSize() const
Return the size of the window used to compute the packet loss.
uint32_t GetLost() const
Get the number of lost packets.
Packet header to carry sequence number and timestamp.
Definition: seq-ts-header.h:45
Time GetTs() const
uint32_t GetSeq() const
static Time Now()
Return the current simulation virtual time.
Definition: simulator.cc:199
virtual Ptr< Packet > RecvFrom(uint32_t maxSize, uint32_t flags, Address &fromAddress)=0
Read a single packet from the socket and retrieve the sender address.
virtual int GetSockName(Address &address) const =0
Get socket address.
void SetRecvCallback(Callback< void, Ptr< Socket > > receivedData)
Notify application when new data is available to be read.
Definition: socket.cc:126
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:72
virtual int Bind(const Address &address)=0
Allocate a local endpoint for this socket.
a unique identifier for an interface.
Definition: type-id.h:60
static TypeId LookupByName(std::string name)
Get a TypeId by name.
Definition: type-id.cc:839
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:935
A UDP server, receives UDP packets from a remote host.
Definition: udp-server.h:50
Ptr< Socket > m_socket6
IPv6 Socket.
Definition: udp-server.h:103
TracedCallback< Ptr< const Packet > > m_rxTrace
Callbacks for tracing the packet Rx events.
Definition: udp-server.h:108
~UdpServer() override
Definition: udp-server.cc:82
uint16_t m_port
Port on which we listen for incoming packets.
Definition: udp-server.h:101
uint64_t GetReceived() const
Returns the number of received packets.
Definition: udp-server.cc:109
void StartApplication() override
Application specific startup code.
Definition: udp-server.cc:123
Ptr< Socket > m_socket
IPv4 Socket.
Definition: udp-server.h:102
void HandleRead(Ptr< Socket > socket)
Handle a packet reception.
Definition: udp-server.cc:166
static TypeId GetTypeId()
Get the type ID.
Definition: udp-server.cc:45
PacketLossCounter m_lossCounter
Lost packet counter.
Definition: udp-server.h:105
void SetPacketWindowSize(uint16_t size)
Set the size of the window used for checking loss.
Definition: udp-server.cc:95
TracedCallback< Ptr< const Packet >, const Address &, const Address & > m_rxTraceWithAddresses
Callbacks for tracing the packet Rx events, includes source and destination addresses.
Definition: udp-server.h:111
uint32_t GetLost() const
Returns the number of lost packets.
Definition: udp-server.cc:102
uint64_t m_received
Number of received packets.
Definition: udp-server.h:104
void DoDispose() override
Destructor implementation.
Definition: udp-server.cc:116
uint16_t GetPacketWindowSize() const
Returns the size of the window used for checking loss.
Definition: udp-server.cc:88
void StopApplication() override
Application specific shutdown code.
Definition: udp-server.cc:155
Hold an unsigned integer type.
Definition: uinteger.h:45
Ptr< const AttributeAccessor > MakeUintegerAccessor(T1 a1)
Definition: uinteger.h:46
Callback< R, Args... > MakeNullCallback()
Definition: callback.h:734
#define NS_FATAL_ERROR(msg)
Report a fatal error with a message and terminate.
Definition: fatal-error.h:160
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:275
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:46
Ptr< const TraceSourceAccessor > MakeTraceSourceAccessor(T a)
Create a TraceSourceAccessor which will control access to the underlying trace source.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Callback< R, Args... > MakeCallback(R(T::*memPtr)(Args...), OBJ objPtr)
Build Callbacks for class method members which take varying numbers of arguments and potentially retu...
Definition: callback.h:691