/usr/include/ns3.17/ns3/packet-sink.h is in libns3-dev 3.17+dfsg-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright 2007 University of Washington
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Author: Tom Henderson (tomhend@u.washington.edu)
*/
#ifndef PACKET_SINK_H
#define PACKET_SINK_H
#include "ns3/application.h"
#include "ns3/event-id.h"
#include "ns3/ptr.h"
#include "ns3/traced-callback.h"
#include "ns3/address.h"
namespace ns3 {
class Address;
class Socket;
class Packet;
/**
* \ingroup applications
* \defgroup packetsink PacketSink
*
* This application was written to complement OnOffApplication, but it
* is more general so a PacketSink name was selected. Functionally it is
* important to use in multicast situations, so that reception of the layer-2
* multicast frames of interest are enabled, but it is also useful for
* unicast as an example of how you can write something simple to receive
* packets at the application layer. Also, if an IP stack generates
* ICMP Port Unreachable errors, receiving applications will be needed.
*/
/**
* \ingroup packetsink
*
* \brief Receive and consume traffic generated to an IP address and port
*
* This application was written to complement OnOffApplication, but it
* is more general so a PacketSink name was selected. Functionally it is
* important to use in multicast situations, so that reception of the layer-2
* multicast frames of interest are enabled, but it is also useful for
* unicast as an example of how you can write something simple to receive
* packets at the application layer. Also, if an IP stack generates
* ICMP Port Unreachable errors, receiving applications will be needed.
*
* The constructor specifies the Address (IP address and port) and the
* transport protocol to use. A virtual Receive () method is installed
* as a callback on the receiving socket. By default, when logging is
* enabled, it prints out the size of packets and their address, but
* we intend to also add a tracing source to Receive() at a later date.
*/
class PacketSink : public Application
{
public:
static TypeId GetTypeId (void);
PacketSink ();
virtual ~PacketSink ();
/**
* \return the total bytes received in this sink app
*/
uint32_t GetTotalRx () const;
/**
* \return pointer to listening socket
*/
Ptr<Socket> GetListeningSocket (void) const;
/**
* \return list of pointers to accepted sockets
*/
std::list<Ptr<Socket> > GetAcceptedSockets (void) const;
protected:
virtual void DoDispose (void);
private:
// inherited from Application base class.
virtual void StartApplication (void); // Called at time specified by Start
virtual void StopApplication (void); // Called at time specified by Stop
void HandleRead (Ptr<Socket>);
void HandleAccept (Ptr<Socket>, const Address& from);
void HandlePeerClose (Ptr<Socket>);
void HandlePeerError (Ptr<Socket>);
// In the case of TCP, each socket accept returns a new socket, so the
// listening socket is stored seperately from the accepted sockets
Ptr<Socket> m_socket; // Listening socket
std::list<Ptr<Socket> > m_socketList; //the accepted sockets
Address m_local; // Local address to bind to
uint32_t m_totalRx; // Total bytes received
TypeId m_tid; // Protocol TypeId
TracedCallback<Ptr<const Packet>, const Address &> m_rxTrace;
};
} // namespace ns3
#endif /* PACKET_SINK_H */
|