packet-sink.h

Go to the documentation of this file.

/* -*- 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"
#include "ns3/inet-socket-address.h"
#include "ns3/inet6-socket-address.h"
#include "ns3/seq-ts-size-header.h"
#include <unordered_map>
 
namespace ns3 {
 
class Address;
class Socket;
class Packet;
 
class PacketSink : public Application
{
public:
  static TypeId GetTypeId (void);
  PacketSink ();
 
  virtual ~PacketSink ();
 
  uint64_t GetTotalRx () const;
 
  Ptr<Socket> GetListeningSocket (void) const;
 
  std::list<Ptr<Socket> > GetAcceptedSockets (void) const;
 
  typedef void (* SeqTsSizeCallback)(Ptr<const Packet> p, const Address &from, const Address & to,
                                   const SeqTsSizeHeader &header);
 
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> socket);
  void HandleAccept (Ptr<Socket> socket, const Address& from);
  void HandlePeerClose (Ptr<Socket> socket);
  void HandlePeerError (Ptr<Socket> socket);
 
  void PacketReceived (const Ptr<Packet> &p, const Address &from, const Address &localAddress);
 
  struct AddressHash
  {
    size_t operator() (const Address &x) const
    {
      if (InetSocketAddress::IsMatchingType (x))
        {
          InetSocketAddress a = InetSocketAddress::ConvertFrom (x);
          return Ipv4AddressHash()(a.GetIpv4 ());
        }
      else if (Inet6SocketAddress::IsMatchingType (x))
        {
          Inet6SocketAddress a = Inet6SocketAddress::ConvertFrom (x);
          return Ipv6AddressHash()(a.GetIpv6 ());
        }
 
      NS_ABORT_MSG ("PacketSink: unexpected address type, neither IPv4 nor IPv6");
      return 0; //silence the warnings.
    }
  };
 
  std::unordered_map<Address, Ptr<Packet>, AddressHash> m_buffer; 
 
  // In the case of TCP, each socket accept returns a new socket, so the
  // listening socket is stored separately from the accepted sockets
  Ptr<Socket>     m_socket;       
  std::list<Ptr<Socket> > m_socketList; 
 
  Address         m_local;        
  uint16_t        m_localPort;    
  uint64_t        m_totalRx;      
  TypeId          m_tid;          
 
  bool            m_enableSeqTsSizeHeader {false}; 
 
  TracedCallback<Ptr<const Packet>, const Address &> m_rxTrace;
  TracedCallback<Ptr<const Packet>, const Address &, const Address &> m_rxTraceWithAddresses;
  TracedCallback<Ptr<const Packet>, const Address &, const Address &, const SeqTsSizeHeader&> m_rxTraceWithSeqTsSize;
};
 
} // namespace ns3
 
#endif /* PACKET_SINK_H */