face.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2014-2022,  Regents of the University of California,
 *                           Arizona Board of Regents,
 *                           Colorado State University,
 *                           University Pierre & Marie Curie, Sorbonne University,
 *                           Washington University in St. Louis,
 *                           Beijing Institute of Technology,
 *                           The University of Memphis.
 *
 * This file is part of NFD (Named Data Networking Forwarding Daemon).
 * See AUTHORS.md for complete list of NFD authors and contributors.
 *
 * NFD is free software: you can redistribute it and/or modify it under the terms
 * of the GNU General Public License as published by the Free Software Foundation,
 * either version 3 of the License, or (at your option) any later version.
 *
 * NFD 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
 * NFD, e.g., in COPYING.md file.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef NFD_DAEMON_FACE_FACE_HPP
#define NFD_DAEMON_FACE_FACE_HPP
 
#include "face-common.hpp"
#include "face-counters.hpp"
#include "link-service.hpp"
#include "transport.hpp"
 
namespace nfd {
namespace face {
 
class Channel;
 
using FaceState = TransportState;
 
class Face NFD_FINAL_UNLESS_WITH_TESTS : public std::enable_shared_from_this<Face>, noncopyable
{
public:
  Face(unique_ptr<LinkService> service, unique_ptr<Transport> transport);
 
  LinkService*
  getLinkService() const noexcept
  {
    return m_service.get();
  }
 
  Transport*
  getTransport() const noexcept
  {
    return m_transport.get();
  }
 
  void
  close();
 
public: // upper interface connected to forwarding
  void
  sendInterest(const Interest& interest);
 
  void
  sendData(const Data& data);
 
  void
  sendNack(const lp::Nack& nack);
 
  signal::Signal<LinkService, Interest, EndpointId>& afterReceiveInterest;
 
  signal::Signal<LinkService, Data, EndpointId>& afterReceiveData;
 
  signal::Signal<LinkService, lp::Nack, EndpointId>& afterReceiveNack;
 
  signal::Signal<LinkService, Interest>& onDroppedInterest;
 
public: // properties
  FaceId
  getId() const noexcept
  {
    return m_id;
  }
 
  void
  setId(FaceId id) noexcept
  {
    m_id = id;
  }
 
  FaceUri
  getLocalUri() const;
 
  FaceUri
  getRemoteUri() const;
 
  ndn::nfd::FaceScope
  getScope() const;
 
  ndn::nfd::FacePersistency
  getPersistency() const;
 
  void
  setPersistency(ndn::nfd::FacePersistency persistency);
 
  ndn::nfd::LinkType
  getLinkType() const;
 
  ssize_t
  getMtu() const;
 
  FaceState
  getState() const;
 
  signal::Signal<Transport, FaceState/*old*/, FaceState/*new*/>& afterStateChange;
 
  time::steady_clock::time_point
  getExpirationTime() const;
 
  const FaceCounters&
  getCounters() const noexcept
  {
    return m_counters;
  }
 
  FaceCounters&
  getCounters() noexcept
  {
    return m_counters;
  }
 
  weak_ptr<Channel>
  getChannel() const
  {
    return m_channel;
  }
 
  void
  setChannel(weak_ptr<Channel> channel)
  {
    m_channel = std::move(channel);
  }
 
private:
  FaceId m_id = INVALID_FACEID;
  unique_ptr<LinkService> m_service;
  unique_ptr<Transport> m_transport;
  FaceCounters m_counters;
  weak_ptr<Channel> m_channel;
};
 
inline void
Face::close()
{
  m_transport->close();
}
 
inline void
Face::sendInterest(const Interest& interest)
{
  m_service->sendInterest(interest);
}
 
inline void
Face::sendData(const Data& data)
{
  m_service->sendData(data);
}
 
inline void
Face::sendNack(const lp::Nack& nack)
{
  m_service->sendNack(nack);
}
 
inline FaceUri
Face::getLocalUri() const
{
  return m_transport->getLocalUri();
}
 
inline FaceUri
Face::getRemoteUri() const
{
  return m_transport->getRemoteUri();
}
 
inline ndn::nfd::FaceScope
Face::getScope() const
{
  return m_transport->getScope();
}
 
inline ndn::nfd::FacePersistency
Face::getPersistency() const
{
  return m_transport->getPersistency();
}
 
inline void
Face::setPersistency(ndn::nfd::FacePersistency persistency)
{
  return m_transport->setPersistency(persistency);
}
 
inline ndn::nfd::LinkType
Face::getLinkType() const
{
  return m_transport->getLinkType();
}
 
inline ssize_t
Face::getMtu() const
{
  return m_service->getEffectiveMtu();
}
 
inline FaceState
Face::getState() const
{
  return m_transport->getState();
}
 
inline time::steady_clock::time_point
Face::getExpirationTime() const
{
  return m_transport->getExpirationTime();
}
 
std::ostream&
operator<<(std::ostream& os, const FaceLogHelper<Face>& flh);
 
} // namespace face
 
using face::Face;
 
} // namespace nfd
 
#endif // NFD_DAEMON_FACE_FACE_HPP