A Discrete-Event Network Simulator
API
qkd-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: Miralem Mehic <miralem.mehic@ieee.org> after 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/virtual-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/virtual-udp-socket-factory.h"
33 #include "qkd-sink.h"
34 
35 namespace ns3 {
36 
37 NS_LOG_COMPONENT_DEFINE ("QKDSink");
38 
40 
41 TypeId
43 {
44  static TypeId tid = TypeId ("ns3::QKDSink")
46  .SetGroupName("Applications")
47  .AddConstructor<QKDSink> ()
48  .AddAttribute ("Local",
49  "The Address on which to Bind the rx socket.",
50  AddressValue (),
53  .AddAttribute ("Protocol",
54  "The type id of the protocol to use for the rx socket.",
58  .AddTraceSource ("Rx",
59  "A packet has been received",
61  "ns3::Packet::AddressTracedCallback")
62  ;
63  return tid;
64 }
65 
67 {
68  NS_LOG_FUNCTION (this);
69  m_socket = 0;
70  m_totalRx = 0;
71 }
72 
74 {
75  NS_LOG_FUNCTION (this);
76 }
77 
78 uint32_t QKDSink::GetTotalRx () const
79 {
80  NS_LOG_FUNCTION (this);
81  return m_totalRx;
82 }
83 
86 {
87  NS_LOG_FUNCTION (this);
88  return m_socket;
89 }
90 
91 std::list<Ptr<Socket> >
93 {
94  NS_LOG_FUNCTION (this);
95  return m_socketList;
96 }
97 
98 void QKDSink::DoDispose (void)
99 {
100  NS_LOG_FUNCTION (this);
101  m_socket = 0;
102  m_socketList.clear ();
103 
104  // chain up
106 }
107 
108 
109 // Application Methods
110 void QKDSink::StartApplication () // Called at time specified by Start
111 {
112  NS_LOG_FUNCTION (this);
113  // Create the socket if not already
114  if (!m_socket)
115  {
116  NS_LOG_FUNCTION (this << "Create new socket to bind on " << m_local );
118  m_socket->Bind (m_local);
119  m_socket->Listen ();
122  {
123  Ptr<VirtualUdpSocket> udpSocket = DynamicCast<VirtualUdpSocket> (m_socket);
124  if (udpSocket)
125  {
126  // equivalent to setsockopt (MCAST_JOIN_GROUP)
127  udpSocket->MulticastJoinGroup (0, m_local);
128  }
129  else
130  {
131  NS_FATAL_ERROR ("Error: joining multicast on a non-UDP socket");
132  }
133  }
134  }
135 
138  MakeNullCallback<bool, Ptr<Socket>, const Address &> (),
143 }
144 
145 void QKDSink::StopApplication () // Called at time specified by Stop
146 {
147  NS_LOG_FUNCTION (this);
148  while(!m_socketList.empty ()) //these are accepted sockets, close them
149  {
150  Ptr<Socket> acceptedSocket = m_socketList.front ();
151  m_socketList.pop_front ();
152  acceptedSocket->Close ();
153  }
154  if (m_socket)
155  {
156  m_socket->Close ();
158  }
159 }
160 
162 {
163  NS_LOG_FUNCTION (this << socket);
164  Ptr<Packet> p;
165  Address from;
166  while ((p = socket->RecvFrom (from)))
167  {
168  if (p->GetSize () == 0)
169  { //EOF
170  break;
171  }
172 
173  NS_LOG_FUNCTION(this << p->GetUid() << p->GetSize() );
174 
175  m_totalRx += p->GetSize ();
177  {
178  NS_LOG_INFO ("At time " << Simulator::Now ().GetSeconds ()
179  << "s packet sink received "
180  << p->GetSize () << " bytes from "
182  << " port " << InetSocketAddress::ConvertFrom (from).GetPort ()
183  << " total Rx " << m_totalRx << " bytes");
184  }
185  else if (Inet6SocketAddress::IsMatchingType (from))
186  {
187  NS_LOG_INFO ("At time " << Simulator::Now ().GetSeconds ()
188  << "s packet sink received "
189  << p->GetSize () << " bytes from "
191  << " port " << Inet6SocketAddress::ConvertFrom (from).GetPort ()
192  << " total Rx " << m_totalRx << " bytes");
193  }
194 
195  m_rxTrace (p, from);
196  }
197 }
198 
199 
201 {
202  NS_LOG_FUNCTION (this << socket);
203 }
204 
206 {
207  NS_LOG_FUNCTION (this << socket);
208 }
209 
210 
212 {
213  NS_LOG_FUNCTION (this << s << from);
215  m_socketList.push_back (s);
216 }
217 
218 } // Namespace ns3
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 "...
static TypeId GetTypeId(void)
Get the type ID.
Definition: qkd-sink.cc:42
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
TracedCallback< Ptr< const Packet >, const Address & > m_rxTrace
Traced Callback: received packets, source address.
Definition: qkd-sink.h:135
TypeId m_tid
Protocol TypeId.
Definition: qkd-sink.h:132
virtual int ShutdownSend(void)=0
Receive and consume traffic generated to an IP address and port.
Definition: qkd-sink.h:69
bool IsMulticast(const Address &ad)
Address family-independent test for a multicast address.
uint64_t GetUid(void) const
Returns the packet&#39;s Uid.
Definition: packet.cc:390
void HandleRead(Ptr< Socket > socket)
Handle a packet received by the application.
Definition: qkd-sink.cc:161
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
uint32_t GetSize(void) const
Returns the the size in bytes of the packet (including the zero-filled initial payload).
Definition: packet.h:831
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:94
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:278
#define NS_FATAL_ERROR(msg)
Report a fatal error with a message and terminate.
Definition: fatal-error.h:162
Callback< R > MakeNullCallback(void)
Definition: callback.h:1635
uint32_t GetTotalRx() const
Definition: qkd-sink.cc:78
a polymophic address class
Definition: address.h:90
std::list< Ptr< Socket > > GetAcceptedSockets(void) const
Definition: qkd-sink.cc:92
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.
void HandleAccept(Ptr< Socket > socket, const Address &from)
Handle an incoming connection.
Definition: qkd-sink.cc:211
void HandlePeerError(Ptr< Socket > socket)
Handle an connection error.
Definition: qkd-sink.cc:205
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
uint32_t m_totalRx
Total bytes received.
Definition: qkd-sink.h:131
The base class for all ns3 applications.
Definition: application.h:60
virtual void StopApplication(void)
Application specific shutdown code.
Definition: qkd-sink.cc:145
static TypeId GetTypeId(void)
Get the type ID.
Ptr< Node > GetNode() const
Definition: application.cc:104
AttributeValue implementation for TypeId.
Definition: type-id.h:608
virtual void StartApplication(void)
Application specific startup code.
Definition: qkd-sink.cc:110
Callback< R > MakeCallback(R(T::*memPtr)(void), OBJ objPtr)
Definition: callback.h:1489
virtual void DoDispose(void)
Destructor implementation.
Definition: qkd-sink.cc:98
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 HandlePeerClose(Ptr< Socket > socket)
Handle an connection close.
Definition: qkd-sink.cc:200
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.
static InetSocketAddress ConvertFrom(const Address &address)
Returns an InetSocketAddress which corresponds to the input Address.
std::list< Ptr< Socket > > m_socketList
the accepted sockets
Definition: qkd-sink.h:128
Ptr< const AttributeChecker > MakeAddressChecker(void)
Definition: address.cc:172
static Time Now(void)
Return the current simulation virtual time.
Definition: simulator.cc:249
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:104
Address m_local
Local address to bind to.
Definition: qkd-sink.h:130
Ptr< Socket > m_socket
Listening socket.
Definition: qkd-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:608
AttributeValue implementation for Address.
Definition: address.h:278
Ptr< Socket > GetListeningSocket(void) const
Definition: qkd-sink.cc:85
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 ~QKDSink()
Definition: qkd-sink.cc:73
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.
virtual int Close(void)=0
Close a socket.
Ptr< const AttributeChecker > MakeTypeIdChecker(void)
Definition: type-id.cc:1225
a unique identifier for an interface.
Definition: type-id.h:58
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:915
static bool IsMatchingType(const Address &address)