blob: 97c75f95c64b9cdecff33145356010dd1c99ce06 [file] [log] [blame]
/* -*- 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-limits.h"
namespace ns3 {
class Packet;
class Node;
namespace ndn {
/**
* \ingroup ndn
* \defgroup ndn-face Faces
*/
/**
* \ingroup ndn-face
* \brief Virtual class defining NDN face
*
* This class defines basic functionality of NDN face. Face is core
* component responsible for actual delivery of data packet to and
* from NDN stack
*
* \see ndn::AppFace, ndn::NetDeviceFace
*/
class Face :
public Object
{
public:
static TypeId
GetTypeId ();
/**
* \brief NDN protocol handler
*
* \param face Face from which packet has been received
* \param packet Original packet
*/
typedef Callback<void,const Ptr<Face>&,const Ptr<const Packet>& > ProtocolHandler;
/**
* \brief Default constructor
*/
Face (Ptr<Node> node);
virtual ~Face();
/**
* @brief Get node to which this face is associated
*/
Ptr<Node>
GetNode () const;
////////////////////////////////////////////////////////////////////
/**
* \brief Register callback to call when new packet arrives on the face
*
* This method should call protocol-dependent registration function
*/
virtual void
RegisterProtocolHandler (ProtocolHandler handler);
/**
* \brief Send packet on a face
*
* This method will be called by lower layers to send data to device or application
*
* \param p smart pointer to a packet to send
*
* @return false if either limit is reached
*/
bool
Send (Ptr<Packet> p);
/**
* \brief Receive packet from application or another node and forward it to the Ndn stack
*
* \todo The only reason for this call is to handle tracing, if requested
*/
bool
Receive (const Ptr<const Packet> &p);
////////////////////////////////////////////////////////////////////
/**
* \brief Assign routing/forwarding metric with face
*
* \param metric configured routing metric (cost) of this face
*/
virtual void
SetMetric (uint16_t metric);
/**
* \brief Get routing/forwarding metric assigned to the face
*
* \returns configured routing/forwarding metric (cost) of this face
*/
virtual uint16_t
GetMetric (void) const;
/**
* These are face states and may be distinct from actual lower-layer
* device states, such as found in real implementations (where the
* device may be down but ndn face state is still up).
*/
/**
* \brief Enable or disable this face
*/
virtual void
SetUp (bool up = true);
/**
* \brief Returns true if this face is enabled, false otherwise.
*/
virtual bool
IsUp () const;
/**
* @brief Get face flags
*
* Face flags may indicate various properties of the face. For example, if the face is an application face,
* than the returned flags have Face::APPLICATION bit set.
*
* @see ndn::Face::Flags for the list of currently defined face flags
*/
inline uint32_t
GetFlags () const;
/**
* @brief List of currently defined face flags
*/
enum Flags
{
APPLICATION = 1 ///< @brief An application face
};
/**
* @brief Print information about the face into the stream
* @param os stream to write information to
*/
virtual std::ostream&
Print (std::ostream &os) const;
/**
* \brief Set face Id
*
* Id is purely informative and should not be used for any other purpose
*
* \param id id to set
*/
inline void
SetId (uint32_t id);
/**
* \brief Get face Id
*
* Id is purely informative and should not be used for any other purpose
*
* \returns id id to set
*/
inline uint32_t
GetId () const;
/**
* \brief Compare two faces. Only two faces on the same node could be compared.
*
* Internal index is used for comparison.
*/
bool
operator== (const Face &face) const;
/**
* \brief Compare two faces. Only two faces on the same node could be compared.
*
* Internal index is used for comparison.
*/
inline bool
operator!= (const Face &face) const;
/**
* \brief Compare two faces. Only two faces on the same node could be compared.
*
* Internal index is used for comparison.
*/
bool
operator< (const Face &face) const;
protected:
/**
* \brief Send packet on a face (actual implementation)
*
* \param p smart pointer to a packet to send
*/
virtual bool
SendImpl (Ptr<Packet> p) = 0;
void
SetFlags (uint32_t flags);
private:
Face (const Face &); ///< \brief Disabled copy constructor
Face& operator= (const Face &); ///< \brief Disabled copy operator
protected:
Ptr<Node> m_node; ///< \brief Smart pointer to Node
private:
ProtocolHandler m_protocolHandler; ///< Callback via which packets are getting send to Ndn stack
bool m_ifup; ///< \brief flag indicating that the interface is UP
uint32_t m_id; ///< \brief id of the interface in NDN stack (per-node uniqueness)
uint32_t m_metric; ///< \brief metric of the face
uint32_t m_flags;
TracedCallback<Ptr<const Packet> > m_txTrace;
TracedCallback<Ptr<const Packet> > m_rxTrace;
TracedCallback<Ptr<const Packet> > m_dropTrace;
};
std::ostream&
operator<< (std::ostream& os, const Face &face);
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