A Discrete-Event Network Simulator
API
packet-sink.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  * Author: Tom Henderson (tomhend@u.washington.edu)
19  */
20 #include "ns3/address.h"
21 #include "ns3/address-utils.h"
22 #include "ns3/log.h"
23 #include "ns3/inet-socket-address.h"
24 #include "ns3/inet6-socket-address.h"
25 #include "ns3/node.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/trace-source-accessor.h"
32 #include "ns3/udp-socket-factory.h"
33 #include "packet-sink.h"
34 
35 namespace ns3 {
36 
37 NS_LOG_COMPONENT_DEFINE ("PacketSink");
38 
39 NS_OBJECT_ENSURE_REGISTERED (PacketSink);
40 
41 TypeId
43 {
44  static TypeId tid = TypeId ("ns3::PacketSink")
46  .AddConstructor<PacketSink> ()
47  .AddAttribute ("Local",
48  "The Address on which to Bind the rx socket.",
49  AddressValue (),
52  .AddAttribute ("Protocol",
53  "The type id of the protocol to use for the rx socket.",
57  .AddTraceSource ("Rx",
58  "A packet has been received",
60  "ns3::Packet::PacketAddressTracedCallback")
61  ;
62  return tid;
63 }
64 
66 {
67  NS_LOG_FUNCTION (this);
68  m_socket = 0;
69  m_totalRx = 0;
70 }
71 
73 {
74  NS_LOG_FUNCTION (this);
75 }
76 
77 uint32_t PacketSink::GetTotalRx () const
78 {
79  NS_LOG_FUNCTION (this);
80  return m_totalRx;
81 }
82 
85 {
86  NS_LOG_FUNCTION (this);
87  return m_socket;
88 }
89 
90 std::list<Ptr<Socket> >
92 {
93  NS_LOG_FUNCTION (this);
94  return m_socketList;
95 }
96 
98 {
99  NS_LOG_FUNCTION (this);
100  m_socket = 0;
101  m_socketList.clear ();
102 
103  // chain up
105 }
106 
107 
108 // Application Methods
109 void PacketSink::StartApplication () // Called at time specified by Start
110 {
111  NS_LOG_FUNCTION (this);
112  // Create the socket if not already
113  if (!m_socket)
114  {
116  m_socket->Bind (m_local);
117  m_socket->Listen ();
120  {
121  Ptr<UdpSocket> udpSocket = DynamicCast<UdpSocket> (m_socket);
122  if (udpSocket)
123  {
124  // equivalent to setsockopt (MCAST_JOIN_GROUP)
125  udpSocket->MulticastJoinGroup (0, m_local);
126  }
127  else
128  {
129  NS_FATAL_ERROR ("Error: joining multicast on a non-UDP socket");
130  }
131  }
132  }
133 
136  MakeNullCallback<bool, Ptr<Socket>, const Address &> (),
141 }
142 
143 void PacketSink::StopApplication () // Called at time specified by Stop
144 {
145  NS_LOG_FUNCTION (this);
146  while(!m_socketList.empty ()) //these are accepted sockets, close them
147  {
148  Ptr<Socket> acceptedSocket = m_socketList.front ();
149  m_socketList.pop_front ();
150  acceptedSocket->Close ();
151  }
152  if (m_socket)
153  {
154  m_socket->Close ();
156  }
157 }
158 
160 {
161  NS_LOG_FUNCTION (this << socket);
162  Ptr<Packet> packet;
163  Address from;
164  while ((packet = socket->RecvFrom (from)))
165  {
166  if (packet->GetSize () == 0)
167  { //EOF
168  break;
169  }
170  m_totalRx += packet->GetSize ();
172  {
173  NS_LOG_INFO ("At time " << Simulator::Now ().GetSeconds ()
174  << "s packet sink received "
175  << packet->GetSize () << " bytes from "
177  << " port " << InetSocketAddress::ConvertFrom (from).GetPort ()
178  << " total Rx " << m_totalRx << " bytes");
179  }
180  else if (Inet6SocketAddress::IsMatchingType (from))
181  {
182  NS_LOG_INFO ("At time " << Simulator::Now ().GetSeconds ()
183  << "s packet sink received "
184  << packet->GetSize () << " bytes from "
186  << " port " << Inet6SocketAddress::ConvertFrom (from).GetPort ()
187  << " total Rx " << m_totalRx << " bytes");
188  }
189  m_rxTrace (packet, from);
190  }
191 }
192 
193 
195 {
196  NS_LOG_FUNCTION (this << socket);
197 }
198 
200 {
201  NS_LOG_FUNCTION (this << socket);
202 }
203 
204 
206 {
207  NS_LOG_FUNCTION (this << s << from);
209  m_socketList.push_back (s);
210 }
211 
212 } // Namespace ns3
static TypeId GetTypeId(void)
Get the type ID.
Ipv6Address GetIpv6(void) const
Get the IPv6 address.
Ipv4Address GetIpv4(void) const
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by "...
Address m_local
Local address to bind to.
Definition: packet-sink.h:129
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:44
uint32_t m_totalRx
Total bytes received.
Definition: packet-sink.h:130
virtual int ShutdownSend(void)=0
bool IsMulticast(const Address &ad)
Address family-independent test for a multicast address.
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:201
TracedCallback< Ptr< const Packet >, const Address & > m_rxTrace
Traced Callback: received packets, source address.
Definition: packet-sink.h:134
uint32_t GetSize(void) const
Returns the the size in bytes of the packet (including the zero-filled initial payload).
Definition: packet.h:766
void SetCloseCallbacks(Callback< void, Ptr< Socket > > normalClose, Callback< void, Ptr< Socket > > errorClose)
Detect socket recv() events such as graceful shutdown or error.
Definition: socket.cc:93
#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
static TypeId GetTypeId(void)
Get the type ID.
Definition: packet-sink.cc:42
Callback< R > MakeNullCallback(void)
Definition: callback.h:1436
a polymophic address class
Definition: address.h:90
Ptr< const TraceSourceAccessor > MakeTraceSourceAccessor(T a)
Create a TraceSourceAccessor which will control access to the underlying trace source.
virtual int Listen(void)=0
Listen for incoming connections.
Ptr< const AttributeAccessor > MakeAddressAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: address.h:278
The base class for all ns3 applications.
Definition: application.h:60
Ptr< SampleEmitter > s
Ptr< Node > GetNode() const
Definition: application.cc:103
void HandleRead(Ptr< Socket > socket)
Handle a packet received by the application.
Definition: packet-sink.cc:159
AttributeValue implementation for TypeId.
Definition: type-id.h:410
TypeId m_tid
Protocol TypeId.
Definition: packet-sink.h:131
Callback< R > MakeCallback(R(T::*memPtr)(void), OBJ objPtr)
Definition: callback.h:1290
virtual void StopApplication(void)
Application specific shutdown code.
Definition: packet-sink.cc:143
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
void HandlePeerClose(Ptr< Socket > socket)
Handle an connection close.
Definition: packet-sink.cc:194
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.
Ptr< const AttributeChecker > MakeAddressChecker(void)
Definition: address.cc:172
virtual ~PacketSink()
Definition: packet-sink.cc:72
static Time Now(void)
Return the current simulation virtual time.
Definition: simulator.cc:223
uint32_t GetTotalRx() const
Definition: packet-sink.cc:77
void SetAcceptCallback(Callback< bool, Ptr< Socket >, const Address & > connectionRequest, Callback< void, Ptr< Socket >, const Address & > newConnectionCreated)
Accept connection requests from remote hosts.
Definition: socket.cc:103
std::list< Ptr< Socket > > GetAcceptedSockets(void) const
Definition: packet-sink.cc:91
std::list< Ptr< Socket > > m_socketList
the accepted sockets
Definition: packet-sink.h:127
Ptr< const AttributeAccessor > MakeTypeIdAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: type-id.h:410
AttributeValue implementation for Address.
Definition: address.h:278
void HandleAccept(Ptr< Socket > socket, const Address &from)
Handle an incoming connection.
Definition: packet-sink.cc:205
void HandlePeerError(Ptr< Socket > socket)
Handle an connection error.
Definition: packet-sink.cc:199
static Inet6SocketAddress ConvertFrom(const Address &addr)
Convert the address to a InetSocketAddress.
static bool IsMatchingType(const Address &addr)
If the address match.
uint16_t GetPort(void) const
Get the port.
virtual void DoDispose(void)
Destructor implementation.
Definition: packet-sink.cc:97
uint16_t GetPort(void) const
virtual void StartApplication(void)
Application specific startup code.
Definition: packet-sink.cc:109
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.
Ptr< Socket > m_socket
Listening socket.
Definition: packet-sink.h:126
virtual int Close(void)=0
Close a socket.
Ptr< const AttributeChecker > MakeTypeIdChecker(void)
Definition: type-id.cc:886
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)
Ptr< Socket > GetListeningSocket(void) const
Definition: packet-sink.cc:84