ndn-l3-protocol.h

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */
/*
 * Copyright (c) 2011 University of California, Los Angeles
 *
 * 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: Alexander Afanasyev <alexander.afanasyev@ucla.edu>
 */

#ifndef NDN_L3_PROTOCOL_H
#define NDN_L3_PROTOCOL_H

#include <list>
#include <vector>

#include "ns3/ptr.h"
#include "ns3/net-device.h"
#include "ns3/nstime.h"

namespace ns3 {

class Packet;
class NetDevice;
class Node;
class Header;

namespace ndn {

class Face;
class ForwardingStrategy;

class L3Protocol :
    public Object
{
public:
  typedef std::vector<Ptr<Face> > FaceList;

  static TypeId GetTypeId ();

  static const uint16_t ETHERNET_FRAME_TYPE; 
  static const uint16_t IP_STACK_PORT;       
  // static const uint16_t IP_PROTOCOL_TYPE;    ///< \brief IP protocol type of NDN

  L3Protocol();
  virtual ~L3Protocol ();

  virtual uint32_t
  AddFace (const Ptr<Face> &face);
  
  virtual uint32_t
  GetNFaces () const;

  virtual Ptr<Face>
  GetFace (uint32_t face) const;
  
  virtual Ptr<Face>
  GetFaceById (uint32_t face) const;

  virtual void
  RemoveFace (Ptr<Face> face);

  virtual Ptr<Face>
  GetFaceByNetDevice (Ptr<NetDevice> netDevice) const;

protected:
  virtual void DoDispose (void); 

  virtual void NotifyNewAggregate ();

private:
  L3Protocol(const L3Protocol &); 
  L3Protocol &operator = (const L3Protocol &); 
  
private:
  uint32_t m_faceCounter; 
  FaceList m_faces; 

  // These objects are aggregated, but for optimization, get them here
  Ptr<Node> m_node; 
  Ptr<ForwardingStrategy> m_forwardingStrategy; 
};

} // namespace ndn
} // namespace ns3

#endif /* NDN_L3_PROTOCOL_H */