face.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
#ifndef NFD_DAEMON_FACE_FACE_HPP
#define NFD_DAEMON_FACE_FACE_HPP

#include "common.hpp"
#include "core/logger.hpp"
#include "face-counters.hpp"

#include <ndn-cxx/management/nfd-face-status.hpp>

namespace nfd {

typedef int FaceId;

const FaceId INVALID_FACEID = -1;

const FaceId FACEID_INTERNAL_FACE = 1;
const FaceId FACEID_CONTENT_STORE = 254;
const FaceId FACEID_NULL = 255;
const FaceId FACEID_RESERVED_MAX = 255;


class Face : noncopyable, public enable_shared_from_this<Face>
{
public:
  class Error : public std::runtime_error
  {
  public:
    explicit
    Error(const std::string& what)
      : std::runtime_error(what)
    {
    }
  };

  Face(const FaceUri& remoteUri, const FaceUri& localUri,
       bool isLocal = false, bool isMultiAccess = false);

  virtual
  ~Face();

  signal::Signal<Face, Interest> onReceiveInterest;

  signal::Signal<Face, Data> onReceiveData;

  signal::Signal<Face, Interest> onSendInterest;

  signal::Signal<Face, Data> onSendData;

  signal::Signal<Face, std::string/*reason*/> onFail;

  virtual void
  sendInterest(const Interest& interest) = 0;

  virtual void
  sendData(const Data& data) = 0;

  virtual void
  close() = 0;

public: // attributes
  FaceId
  getId() const;

  const std::string&
  getDescription() const;

  void
  setDescription(const std::string& description);

  void
  setMetric(uint64_t metric);

  uint64_t
  getMetric() const;

  bool
  isLocal() const;

  ndn::nfd::FacePersistency
  getPersistency() const;

  bool
  isMultiAccess() const;

  virtual bool
  isUp() const;

  const FaceCounters&
  getCounters() const;

  const FaceUri&
  getRemoteUri() const;

  const FaceUri&
  getLocalUri() const;

  template<typename FaceTraits>
  void
  copyStatusTo(FaceTraits& traits) const;

  virtual ndn::nfd::FaceStatus
  getFaceStatus() const;

PUBLIC_WITH_TESTS_ELSE_PROTECTED:
  void
  setPersistency(ndn::nfd::FacePersistency persistency);

protected:
  bool
  decodeAndDispatchInput(const Block& element);

  void
  fail(const std::string& reason);

  FaceCounters&
  getMutableCounters();

  DECLARE_SIGNAL_EMIT(onReceiveInterest)
  DECLARE_SIGNAL_EMIT(onReceiveData)
  DECLARE_SIGNAL_EMIT(onSendInterest)
  DECLARE_SIGNAL_EMIT(onSendData)

private:
  // this method should be used only by the FaceTable
  void
  setId(FaceId faceId);

private:
  FaceId m_id;
  std::string m_description;
  FaceCounters m_counters;
  const FaceUri m_remoteUri;
  const FaceUri m_localUri;
  const bool m_isLocal;
  ndn::nfd::FacePersistency m_persistency;
  const bool m_isMultiAccess;
  bool m_isFailed;
  uint64_t m_metric;

  // allow setting FaceId
  friend class FaceTable;
};

inline FaceId
Face::getId() const
{
  return m_id;
}

inline void
Face::setId(FaceId faceId)
{
  m_id = faceId;
}

inline const std::string&
Face::getDescription() const
{
  return m_description;
}

inline void
Face::setDescription(const std::string& description)
{
  m_description = description;
}

inline bool
Face::isLocal() const
{
  return m_isLocal;
}

inline ndn::nfd::FacePersistency
Face::getPersistency() const
{
  return m_persistency;
}

inline void
Face::setPersistency(ndn::nfd::FacePersistency persistency)
{
  m_persistency = persistency;
}

inline bool
Face::isMultiAccess() const
{
  return m_isMultiAccess;
}

inline const FaceCounters&
Face::getCounters() const
{
  return m_counters;
}

inline FaceCounters&
Face::getMutableCounters()
{
  return m_counters;
}

inline const FaceUri&
Face::getRemoteUri() const
{
  return m_remoteUri;
}

inline const FaceUri&
Face::getLocalUri() const
{
  return m_localUri;
}


inline void
Face::setMetric(uint64_t metric)
{
  m_metric = metric;
}

inline uint64_t
Face::getMetric() const
{
  return m_metric;
}

#define NFD_LOG_FACE(level, msg)                        \
  NFD_LOG_##level("[id=" << this->getId() <<            \
                  ",local=" << this->getLocalUri() <<   \
                  ",remote=" << this->getRemoteUri() << \
                  "] " << msg)

#define NFD_LOG_FACE_TRACE(msg) NFD_LOG_FACE(TRACE, msg)

#define NFD_LOG_FACE_DEBUG(msg) NFD_LOG_FACE(DEBUG, msg)

#define NFD_LOG_FACE_INFO(msg)  NFD_LOG_FACE(INFO,  msg)

#define NFD_LOG_FACE_WARN(msg)  NFD_LOG_FACE(WARN,  msg)

#define NFD_LOG_FACE_ERROR(msg) NFD_LOG_FACE(ERROR, msg)

} // namespace nfd

#endif // NFD_DAEMON_FACE_FACE_HPP