A Discrete-Event Network Simulator
API
udp-echo-server.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright 2007 University of Washington
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 
19 #include "ns3/log.h"
20 #include "ns3/ipv4-address.h"
21 #include "ns3/ipv6-address.h"
22 #include "ns3/address-utils.h"
23 #include "ns3/nstime.h"
24 #include "ns3/inet-socket-address.h"
25 #include "ns3/inet6-socket-address.h"
26 #include "ns3/socket.h"
27 #include "ns3/udp-socket.h"
28 #include "ns3/simulator.h"
29 #include "ns3/socket-factory.h"
30 #include "ns3/packet.h"
31 #include "ns3/uinteger.h"
32 
33 #include "udp-echo-server.h"
34 
35 namespace ns3 {
36 
37 NS_LOG_COMPONENT_DEFINE ("UdpEchoServerApplication");
38 
39 NS_OBJECT_ENSURE_REGISTERED (UdpEchoServer);
40 
41 TypeId
43 {
44  static TypeId tid = TypeId ("ns3::UdpEchoServer")
46  .AddConstructor<UdpEchoServer> ()
47  .AddAttribute ("Port", "Port on which we listen for incoming packets.",
48  UintegerValue (9),
50  MakeUintegerChecker<uint16_t> ())
51  ;
52  return tid;
53 }
54 
56 {
57  NS_LOG_FUNCTION (this);
58 }
59 
61 {
62  NS_LOG_FUNCTION (this);
63  m_socket = 0;
64  m_socket6 = 0;
65 }
66 
67 void
69 {
70  NS_LOG_FUNCTION (this);
72 }
73 
74 void
76 {
77  NS_LOG_FUNCTION (this);
78 
79  if (m_socket == 0)
80  {
81  TypeId tid = TypeId::LookupByName ("ns3::UdpSocketFactory");
84  m_socket->Bind (local);
86  {
87  Ptr<UdpSocket> udpSocket = DynamicCast<UdpSocket> (m_socket);
88  if (udpSocket)
89  {
90  // equivalent to setsockopt (MCAST_JOIN_GROUP)
91  udpSocket->MulticastJoinGroup (0, m_local);
92  }
93  else
94  {
95  NS_FATAL_ERROR ("Error: Failed to join multicast group");
96  }
97  }
98  }
99 
100  if (m_socket6 == 0)
101  {
102  TypeId tid = TypeId::LookupByName ("ns3::UdpSocketFactory");
105  m_socket6->Bind (local6);
106  if (addressUtils::IsMulticast (local6))
107  {
108  Ptr<UdpSocket> udpSocket = DynamicCast<UdpSocket> (m_socket6);
109  if (udpSocket)
110  {
111  // equivalent to setsockopt (MCAST_JOIN_GROUP)
112  udpSocket->MulticastJoinGroup (0, local6);
113  }
114  else
115  {
116  NS_FATAL_ERROR ("Error: Failed to join multicast group");
117  }
118  }
119  }
120 
123 }
124 
125 void
127 {
128  NS_LOG_FUNCTION (this);
129 
130  if (m_socket != 0)
131  {
132  m_socket->Close ();
134  }
135  if (m_socket6 != 0)
136  {
137  m_socket6->Close ();
139  }
140 }
141 
142 void
144 {
145  NS_LOG_FUNCTION (this << socket);
146 
147  Ptr<Packet> packet;
148  Address from;
149  while ((packet = socket->RecvFrom (from)))
150  {
152  {
153  NS_LOG_INFO ("At time " << Simulator::Now ().GetSeconds () << "s server received " << packet->GetSize () << " bytes from " <<
154  InetSocketAddress::ConvertFrom (from).GetIpv4 () << " port " <<
156  }
157  else if (Inet6SocketAddress::IsMatchingType (from))
158  {
159  NS_LOG_INFO ("At time " << Simulator::Now ().GetSeconds () << "s server received " << packet->GetSize () << " bytes from " <<
160  Inet6SocketAddress::ConvertFrom (from).GetIpv6 () << " port " <<
162  }
163 
164  packet->RemoveAllPacketTags ();
165  packet->RemoveAllByteTags ();
166 
167  NS_LOG_LOGIC ("Echoing packet");
168  socket->SendTo (packet, 0, from);
169 
171  {
172  NS_LOG_INFO ("At time " << Simulator::Now ().GetSeconds () << "s server sent " << packet->GetSize () << " bytes to " <<
173  InetSocketAddress::ConvertFrom (from).GetIpv4 () << " port " <<
175  }
176  else if (Inet6SocketAddress::IsMatchingType (from))
177  {
178  NS_LOG_INFO ("At time " << Simulator::Now ().GetSeconds () << "s server sent " << packet->GetSize () << " bytes to " <<
179  Inet6SocketAddress::ConvertFrom (from).GetIpv6 () << " port " <<
181  }
182  }
183 }
184 
185 } // Namespace ns3
uint16_t m_port
Port on which we listen for incoming packets.
Ipv6Address GetIpv6(void) const
Get the IPv6 address.
an Inet address class
Ipv4Address GetIpv4(void) const
static Ipv4Address GetAny(void)
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by "...
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:44
bool IsMulticast(const Address &ad)
Address family-independent test for a multicast address.
virtual void StartApplication(void)
Application specific startup code.
static Ipv6Address GetAny()
Get the "any" (::) Ipv6Address.
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:201
void HandleRead(Ptr< Socket > socket)
Handle a packet reception.
uint32_t GetSize(void) const
Returns the the size in bytes of the packet (including the zero-filled initial payload).
Definition: packet.h:766
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:244
#define NS_FATAL_ERROR(msg)
Fatal error handling.
Definition: fatal-error.h:100
Callback< R > MakeNullCallback(void)
Definition: callback.h:1436
a polymophic address class
Definition: address.h:90
Ptr< Socket > m_socket6
IPv6 Socket.
void RemoveAllPacketTags(void)
Remove all packet tags.
Definition: packet.cc:864
The base class for all ns3 applications.
Definition: application.h:60
Hold an unsigned integer type.
Definition: uinteger.h:44
Ptr< Node > GetNode() const
Definition: application.cc:103
Address m_local
local multicast address
An Inet6 address class.
Callback< R > MakeCallback(R(T::*memPtr)(void), OBJ objPtr)
Definition: callback.h:1290
void SetRecvCallback(Callback< void, Ptr< Socket > >)
Notify application when new data is available to be read.
Definition: socket.cc:127
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:70
virtual void DoDispose(void)
Destructor implementation.
#define NS_LOG_LOGIC(msg)
Use NS_LOG to output a message of level LOG_LOGIC.
Definition: log.h:252
virtual void DoDispose(void)
Destructor implementation.
Definition: application.cc:82
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.
static InetSocketAddress ConvertFrom(const Address &address)
Returns an InetSocketAddress which corresponds to the input Address.
static Time Now(void)
Return the current simulation virtual time.
Definition: simulator.cc:223
static Inet6SocketAddress ConvertFrom(const Address &addr)
Convert the address to a InetSocketAddress.
void RemoveAllByteTags(void)
Remove all byte tags stored in this packet.
Definition: packet.cc:361
static bool IsMatchingType(const Address &addr)
If the address match.
uint16_t GetPort(void) const
Get the port.
virtual void StopApplication(void)
Application specific shutdown code.
virtual int SendTo(Ptr< Packet > p, uint32_t flags, const Address &toAddress)=0
Send data to a specified peer.
uint16_t GetPort(void) const
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.
static TypeId GetTypeId(void)
Get the type ID.
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:51
TypeId SetParent(TypeId tid)
Definition: type-id.cc:631
static bool IsMatchingType(const Address &address)
static TypeId LookupByName(std::string name)
Definition: type-id.cc:556
Ptr< Socket > m_socket
IPv4 Socket.