A Discrete-Event Network Simulator
API
packet-sink.h
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 
21 #ifndef PACKET_SINK_H
22 #define PACKET_SINK_H
23 
24 #include "ns3/application.h"
25 #include "ns3/event-id.h"
26 #include "ns3/ptr.h"
27 #include "ns3/traced-callback.h"
28 #include "ns3/address.h"
29 
30 namespace ns3 {
31 
32 class Address;
33 class Socket;
34 class Packet;
35 
68 class PacketSink : public Application
69 {
70 public:
75  static TypeId GetTypeId (void);
76  PacketSink ();
77 
78  virtual ~PacketSink ();
79 
83  uint64_t GetTotalRx () const;
84 
88  Ptr<Socket> GetListeningSocket (void) const;
89 
93  std::list<Ptr<Socket> > GetAcceptedSockets (void) const;
94 
95 protected:
96  virtual void DoDispose (void);
97 private:
98  // inherited from Application base class.
99  virtual void StartApplication (void); // Called at time specified by Start
100  virtual void StopApplication (void); // Called at time specified by Stop
101 
106  void HandleRead (Ptr<Socket> socket);
112  void HandleAccept (Ptr<Socket> socket, const Address& from);
117  void HandlePeerClose (Ptr<Socket> socket);
122  void HandlePeerError (Ptr<Socket> socket);
123 
124  // In the case of TCP, each socket accept returns a new socket, so the
125  // listening socket is stored separately from the accepted sockets
127  std::list<Ptr<Socket> > m_socketList;
128 
130  uint64_t m_totalRx;
132 
135 
138 
139 };
140 
141 } // namespace ns3
142 
143 #endif /* PACKET_SINK_H */
144 
Address m_local
Local address to bind to.
Definition: packet-sink.h:129
Forward calls to a chain of Callback.
uint64_t GetTotalRx() const
Definition: packet-sink.cc:81
TracedCallback< Ptr< const Packet >, const Address & > m_rxTrace
Traced Callback: received packets, source address.
Definition: packet-sink.h:134
static TypeId GetTypeId(void)
Get the type ID.
Definition: packet-sink.cc:42
std::list< Ptr< Socket > > GetAcceptedSockets(void) const
Definition: packet-sink.cc:95
a polymophic address class
Definition: address.h:90
TracedCallback< Ptr< const Packet >, const Address &, const Address & > m_rxTraceWithAddresses
Callback for tracing the packet Rx events, includes source and destination addresses.
Definition: packet-sink.h:137
The base class for all ns3 applications.
Definition: application.h:60
void HandleRead(Ptr< Socket > socket)
Handle a packet received by the application.
Definition: packet-sink.cc:166
TypeId m_tid
Protocol TypeId.
Definition: packet-sink.h:131
virtual void StopApplication(void)
Application specific shutdown code.
Definition: packet-sink.cc:150
void HandlePeerClose(Ptr< Socket > socket)
Handle an connection close.
Definition: packet-sink.cc:204
Every class exported by the ns3 library is enclosed in the ns3 namespace.
uint64_t m_totalRx
Total bytes received.
Definition: packet-sink.h:130
virtual ~PacketSink()
Definition: packet-sink.cc:76
std::list< Ptr< Socket > > m_socketList
the accepted sockets
Definition: packet-sink.h:127
void HandleAccept(Ptr< Socket > socket, const Address &from)
Handle an incoming connection.
Definition: packet-sink.cc:215
void HandlePeerError(Ptr< Socket > socket)
Handle an connection error.
Definition: packet-sink.cc:209
Ptr< Socket > GetListeningSocket(void) const
Definition: packet-sink.cc:88
virtual void DoDispose(void)
Destructor implementation.
Definition: packet-sink.cc:101
virtual void StartApplication(void)
Application specific startup code.
Definition: packet-sink.cc:113
Receive and consume traffic generated to an IP address and port.
Definition: packet-sink.h:68
Ptr< Socket > m_socket
Listening socket.
Definition: packet-sink.h:126
a unique identifier for an interface.
Definition: type-id.h:58