A Discrete-Event Network Simulator
API
udp-server.cc
Go to the documentation of this file.
1/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2007,2008,2009 INRIA, UDCAST
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: Amine Ismail <amine.ismail@sophia.inria.fr>
19 * <amine.ismail@udcast.com>
20 */
21
22#include "ns3/log.h"
23#include "ns3/ipv4-address.h"
24#include "ns3/nstime.h"
25#include "ns3/inet-socket-address.h"
26#include "ns3/inet6-socket-address.h"
27#include "ns3/socket.h"
28#include "ns3/simulator.h"
29#include "ns3/socket-factory.h"
30#include "ns3/packet.h"
31#include "ns3/uinteger.h"
32#include "packet-loss-counter.h"
33
34#include "seq-ts-header.h"
35#include "udp-server.h"
36
37namespace ns3 {
38
39NS_LOG_COMPONENT_DEFINE ("UdpServer");
40
42
43
44TypeId
46{
47 static TypeId tid = TypeId ("ns3::UdpServer")
49 .SetGroupName("Applications")
50 .AddConstructor<UdpServer> ()
51 .AddAttribute ("Port",
52 "Port on which we listen for incoming packets.",
53 UintegerValue (100),
55 MakeUintegerChecker<uint16_t> ())
56 .AddAttribute ("PacketWindowSize",
57 "The size of the window used to compute the packet loss. This value should be a multiple of 8.",
58 UintegerValue (32),
61 MakeUintegerChecker<uint16_t> (8,256))
62 .AddTraceSource ("Rx", "A packet has been received",
64 "ns3::Packet::TracedCallback")
65 .AddTraceSource ("RxWithAddresses", "A packet has been received",
67 "ns3::Packet::TwoAddressTracedCallback")
68 ;
69 return tid;
70}
71
73 : m_lossCounter (0)
74{
75 NS_LOG_FUNCTION (this);
76 m_received=0;
77}
78
80{
81 NS_LOG_FUNCTION (this);
82}
83
84uint16_t
86{
87 NS_LOG_FUNCTION (this);
89}
90
91void
93{
94 NS_LOG_FUNCTION (this << size);
96}
97
100{
101 NS_LOG_FUNCTION (this);
102 return m_lossCounter.GetLost ();
103}
104
105uint64_t
107{
108 NS_LOG_FUNCTION (this);
109 return m_received;
110}
111
112void
114{
115 NS_LOG_FUNCTION (this);
117}
118
119void
121{
122 NS_LOG_FUNCTION (this);
123
124 if (!m_socket)
125 {
126 TypeId tid = TypeId::LookupByName ("ns3::UdpSocketFactory");
129 m_port);
130 if (m_socket->Bind (local) == -1)
131 {
132 NS_FATAL_ERROR ("Failed to bind socket");
133 }
134 }
135
137
138 if (!m_socket6)
139 {
140 TypeId tid = TypeId::LookupByName ("ns3::UdpSocketFactory");
143 m_port);
144 if (m_socket6->Bind (local) == -1)
145 {
146 NS_FATAL_ERROR ("Failed to bind socket");
147 }
148 }
149
151
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 <<
186 " bytes from "<< InetSocketAddress::ConvertFrom (from).GetIpv4 () <<
187 " Sequence Number: " << currentSequenceNumber <<
188 " Uid: " << packet->GetUid () <<
189 " TXtime: " << seqTs.GetTs () <<
190 " RXtime: " << Simulator::Now () <<
191 " Delay: " << Simulator::Now () - seqTs.GetTs ());
192 }
194 {
195 NS_LOG_INFO ("TraceDelay: RX " << receivedSize <<
196 " bytes from "<< Inet6SocketAddress::ConvertFrom (from).GetIpv6 () <<
197 " Sequence Number: " << currentSequenceNumber <<
198 " Uid: " << packet->GetUid () <<
199 " TXtime: " << seqTs.GetTs () <<
200 " RXtime: " << Simulator::Now () <<
201 " Delay: " << Simulator::Now () - seqTs.GetTs ());
202 }
203
204 m_lossCounter.NotifyReceived (currentSequenceNumber);
205 m_received++;
206 }
207 }
208}
209
210} // Namespace ns3
a polymophic address class
Definition: address.h:91
The base class for all ns3 applications.
Definition: application.h:61
virtual void DoDispose(void)
Destructor implementation.
Definition: application.cc:83
Ptr< Node > GetNode() const
Definition: application.cc:104
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(void)
static Ipv6Address GetAny()
Get the "any" (::) Ipv6Address.
uint32_t RemoveHeader(Header &header)
Deserialize and remove the header from the internal buffer.
Definition: packet.cc:280
uint64_t GetUid(void) const
Returns the packet's Uid.
Definition: packet.cc:390
uint32_t GetSize(void) const
Returns the the size in bytes of the packet (including the zero-filled initial payload).
Definition: packet.h:856
void NotifyReceived(uint32_t seq)
Record a successfully received packet.
uint32_t GetLost(void) const
Get the number of lost packets.
void SetBitMapSize(uint16_t size)
Set the size of the window used to compute the packet loss.
uint16_t GetBitMapSize(void) const
Return the size of the window used to compute the packet loss.
Packet header to carry sequence number and timestamp.
Definition: seq-ts-header.h:45
uint32_t GetSeq(void) const
Time GetTs(void) const
static Time Now(void)
Return the current simulation virtual time.
Definition: simulator.cc:195
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: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
virtual int Bind(const Address &address)=0
Allocate a local endpoint for this socket.
a unique identifier for an interface.
Definition: type-id.h:59
static TypeId LookupByName(std::string name)
Get a TypeId by name.
Definition: type-id.cc:829
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:922
A UDP server, receives UDP packets from a remote host.
Definition: udp-server.h:49
Ptr< Socket > m_socket6
IPv6 Socket.
Definition: udp-server.h:102
TracedCallback< Ptr< const Packet > > m_rxTrace
Callbacks for tracing the packet Rx events.
Definition: udp-server.h:107
virtual ~UdpServer()
Definition: udp-server.cc:79
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:110
uint16_t m_port
Port on which we listen for incoming packets.
Definition: udp-server.h:100
uint64_t GetReceived(void) const
Returns the number of received packets.
Definition: udp-server.cc:106
Ptr< Socket > m_socket
IPv4 Socket.
Definition: udp-server.h:101
uint32_t GetLost(void) const
Returns the number of lost packets.
Definition: udp-server.cc:99
static TypeId GetTypeId(void)
Get the type ID.
Definition: udp-server.cc:45
void HandleRead(Ptr< Socket > socket)
Handle a packet reception.
Definition: udp-server.cc:166
virtual void StartApplication(void)
Application specific startup code.
Definition: udp-server.cc:120
PacketLossCounter m_lossCounter
Lost packet counter.
Definition: udp-server.h:104
void SetPacketWindowSize(uint16_t size)
Set the size of the window used for checking loss.
Definition: udp-server.cc:92
uint64_t m_received
Number of received packets.
Definition: udp-server.h:103
virtual void DoDispose(void)
Destructor implementation.
Definition: udp-server.cc:113
virtual void StopApplication(void)
Application specific shutdown code.
Definition: udp-server.cc:155
uint16_t GetPacketWindowSize() const
Returns the size of the window used for checking loss.
Definition: udp-server.cc:85
Hold an unsigned integer type.
Definition: uinteger.h:44
Ptr< const AttributeAccessor > MakeUintegerAccessor(T1 a1)
Definition: uinteger.h:45
Callback< R, Args... > MakeNullCallback(void)
Definition: callback.h:697
#define NS_FATAL_ERROR(msg)
Report a fatal error with a message and terminate.
Definition: fatal-error.h:165
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:206
#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:282
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
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:661