ndn-face.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
 *
 * Authors: Alexander Afanasyev <alexander.afanasyev@ucla.edu>
 */

#ifndef NDN_FACE_H
#define NDN_FACE_H

#include <ostream>
#include <algorithm>

#include "ns3/ptr.h"
#include "ns3/object.h"
#include "ns3/nstime.h"
#include "ns3/type-id.h"
#include "ns3/traced-callback.h"
#include "ns3/ndn-name.h"

namespace ns3 {

class Packet;
class Node;

namespace ndn {

class Interest;
class Data;

class Face :
    public Object
{
public:
  static TypeId
  GetTypeId ();

  typedef Callback<void, Ptr<Face>, Ptr<Interest> > InterestHandler;
  typedef Callback<void, Ptr<Face>, Ptr<Data> > DataHandler;

  Face (Ptr<Node> node);
  virtual ~Face();

  Ptr<Node>
  GetNode () const;


  virtual void
  RegisterProtocolHandlers (const InterestHandler &interestHandler, const DataHandler &dataHandler);

  virtual void
  UnRegisterProtocolHandlers ();

  virtual bool
  SendInterest (Ptr<const Interest> interest);

  virtual bool
  SendData (Ptr<const Data> data);

  virtual bool
  ReceiveInterest (Ptr<Interest> interest);

  virtual bool
  ReceiveData (Ptr<Data> data);

  virtual void
  SetMetric (uint16_t metric);

  virtual uint16_t
  GetMetric (void) const;

  inline void
  SetUp (bool up = true);

  inline bool
  IsUp () const;

  inline uint32_t
  GetFlags () const;

  enum Flags
    {
      APPLICATION = 1 
    };

  virtual std::ostream&
  Print (std::ostream &os) const;

  inline void
  SetId (uint32_t id);

  inline uint32_t
  GetId () const;

  bool
  operator== (const Face &face) const;

  inline bool
  operator!= (const Face &face) const;

  bool
  operator< (const Face &face) const;

protected:
  virtual bool
  Send (Ptr<Packet> packet);

  virtual bool
  Receive (Ptr<const Packet> p);

  void
  SetFlags (uint32_t flags);

private:
  Face (const Face &); 
  Face& operator= (const Face &); 

protected:
  Ptr<Node> m_node; 

private:
  InterestHandler m_upstreamInterestHandler;
  DataHandler m_upstreamDataHandler;
  bool m_ifup;
  uint32_t m_id; 
  uint16_t m_metric; 
  uint32_t m_flags; 
};

std::ostream&
operator<< (std::ostream& os, const Face &face);

inline bool
Face::IsUp (void) const
{
  return m_ifup;
}

inline void
Face::SetUp (bool up/* = true*/)
{
  m_ifup = up;
}

inline uint32_t
Face::GetFlags () const
{
  return m_flags;
}

inline bool
operator < (const Ptr<Face> &lhs, const Ptr<Face> &rhs)
{
  return *lhs < *rhs;
}

void
Face::SetId (uint32_t id)
{
  m_id = id;
}

uint32_t
Face::GetId () const
{
  return m_id;
}

inline bool
Face::operator!= (const Face &face) const
{
  return !(*this == face);
}

} // namespace ndn
} // namespace ns3

#endif // NDN_FACE_H