transport.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2014-2024,  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_TRANSPORT_HPP
#define NFD_DAEMON_FACE_TRANSPORT_HPP
 
#include "face-common.hpp"
#include "common/counter.hpp"
 
namespace nfd::face {
 
enum class TransportState {
  NONE,
  UP, 
  DOWN, 
  CLOSING, 
  FAILED, 
  CLOSED 
};
 
std::ostream&
operator<<(std::ostream& os, TransportState state);
 
class TransportCounters
{
public:
  PacketCounter nInPackets;
 
  PacketCounter nOutPackets;
 
  ByteCounter nInBytes;
 
  ByteCounter nOutBytes;
};
 
inline constexpr ssize_t MTU_UNLIMITED = -1;
 
inline constexpr ssize_t MTU_INVALID = -2;
 
inline constexpr ssize_t QUEUE_UNSUPPORTED = -1;
 
inline constexpr ssize_t QUEUE_ERROR = -2;
 
class Transport : protected virtual TransportCounters, noncopyable
{
public:
  using Counters = TransportCounters;
 
  Transport();
 
  virtual
  ~Transport();
 
public:
  void
  setFaceAndLinkService(Face& face, LinkService& service) noexcept;
 
  const Face*
  getFace() const noexcept
  {
    return m_face;
  }
 
  const LinkService*
  getLinkService() const noexcept
  {
    return m_service;
  }
 
  LinkService*
  getLinkService() noexcept
  {
    return m_service;
  }
 
  virtual const Counters&
  getCounters() const
  {
    return *this;
  }
 
public: // upper interface
  void
  close();
 
  void
  send(const Block& packet);
 
public: // static properties
  FaceUri
  getLocalUri() const noexcept
  {
    return m_localUri;
  }
 
  FaceUri
  getRemoteUri() const noexcept
  {
    return m_remoteUri;
  }
 
  ndn::nfd::FaceScope
  getScope() const noexcept
  {
    return m_scope;
  }
 
  ndn::nfd::FacePersistency
  getPersistency() const noexcept
  {
    return m_persistency;
  }
 
  bool
  canChangePersistencyTo(ndn::nfd::FacePersistency newPersistency) const;
 
  void
  setPersistency(ndn::nfd::FacePersistency newPersistency);
 
  ndn::nfd::LinkType
  getLinkType() const noexcept
  {
    return m_linkType;
  }
 
  ssize_t
  getMtu() const noexcept
  {
    return m_mtu;
  }
 
  ssize_t
  getSendQueueCapacity() const noexcept
  {
    return m_sendQueueCapacity;
  }
 
public: // dynamic properties
  TransportState
  getState() const noexcept
  {
    return m_state;
  }
 
  signal::Signal<Transport, TransportState /*old*/, TransportState /*new*/> afterStateChange;
 
  time::steady_clock::time_point
  getExpirationTime() const noexcept
  {
    return m_expirationTime;
  }
 
  virtual ssize_t
  getSendQueueLength()
  {
    return QUEUE_UNSUPPORTED;
  }
 
protected: // upper interface to be invoked by subclass
  void
  receive(const Block& packet, const EndpointId& endpoint = {});
 
protected: // properties to be set by subclass
  void
  setLocalUri(const FaceUri& uri) noexcept
  {
    m_localUri = uri;
  }
 
  void
  setRemoteUri(const FaceUri& uri) noexcept
  {
    m_remoteUri = uri;
  }
 
  void
  setScope(ndn::nfd::FaceScope scope) noexcept
  {
    m_scope = scope;
  }
 
  void
  setLinkType(ndn::nfd::LinkType linkType) noexcept
  {
    m_linkType = linkType;
  }
 
  void
  setMtu(ssize_t mtu) noexcept;
 
  void
  setSendQueueCapacity(ssize_t sendQueueCapacity) noexcept
  {
    m_sendQueueCapacity = sendQueueCapacity;
  }
 
  void
  setState(TransportState newState);
 
  void
  setExpirationTime(const time::steady_clock::time_point& expirationTime) noexcept
  {
    m_expirationTime = expirationTime;
  }
 
protected: // to be overridden by subclass
  virtual bool
  canChangePersistencyToImpl(ndn::nfd::FacePersistency newPersistency) const;
 
  virtual void
  afterChangePersistency(ndn::nfd::FacePersistency oldPersistency);
 
  virtual void
  doClose() = 0;
 
private: // to be overridden by subclass
  virtual void
  doSend(const Block& packet) = 0;
 
private:
  Face* m_face = nullptr;
  LinkService* m_service = nullptr;
  FaceUri m_localUri;
  FaceUri m_remoteUri;
  ndn::nfd::FaceScope m_scope = ndn::nfd::FACE_SCOPE_NONE;
  ndn::nfd::FacePersistency m_persistency = ndn::nfd::FACE_PERSISTENCY_NONE;
  ndn::nfd::LinkType m_linkType = ndn::nfd::LINK_TYPE_NONE;
  ssize_t m_mtu = MTU_INVALID;
  ssize_t m_sendQueueCapacity = QUEUE_UNSUPPORTED;
  TransportState m_state = TransportState::UP;
  time::steady_clock::time_point m_expirationTime = time::steady_clock::time_point::max();
};
 
std::ostream&
operator<<(std::ostream& os, const FaceLogHelper<Transport>& flh);
 
template<typename T>
std::enable_if_t<std::is_base_of_v<Transport, T> && !std::is_same_v<Transport, T>,
                 std::ostream&>
operator<<(std::ostream& os, const FaceLogHelper<T>& flh)
{
  return os << FaceLogHelper<Transport>(flh.obj);
}
 
} // namespace nfd::face
 
#endif // NFD_DAEMON_FACE_TRANSPORT_HPP