generic-link-service.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_GENERIC_LINK_SERVICE_HPP
#define NFD_DAEMON_FACE_GENERIC_LINK_SERVICE_HPP
 
#include "link-service.hpp"
#include "lp-fragmenter.hpp"
#include "lp-reassembler.hpp"
#include "lp-reliability.hpp"
 
#include <limits>
 
namespace nfd::face {
 
class GenericLinkServiceCounters : public virtual LinkService::Counters
{
public:
  PacketCounter nFragmentationErrors;
 
  PacketCounter nOutOverMtu;
 
  PacketCounter nInLpInvalid;
 
  SizeCounter<LpReassembler> nReassembling;
 
  PacketCounter nReassemblyTimeouts;
 
  PacketCounter nInNetInvalid;
 
  PacketCounter nAcknowledged;
 
  PacketCounter nRetransmitted;
 
  PacketCounter nRetxExhausted;
 
  PacketCounter nDuplicateSequence;
 
  PacketCounter nCongestionMarked;
};
 
struct GenericLinkServiceOptions
{
  bool allowLocalFields = false;
 
  bool allowFragmentation = false;
 
  LpFragmenter::Options fragmenterOptions;
 
  bool allowReassembly = false;
 
  LpReassembler::Options reassemblerOptions;
 
  LpReliability::Options reliabilityOptions;
 
  bool allowCongestionMarking = false;
 
  time::nanoseconds baseCongestionMarkingInterval = 100_ms;
 
  size_t defaultCongestionThreshold = 65536;
 
  bool allowSelfLearning = true;
 
  ssize_t overrideMtu = std::numeric_limits<ssize_t>::max();
};
 
class GenericLinkService NFD_FINAL_UNLESS_WITH_TESTS : public LinkService
                                                     , protected virtual GenericLinkServiceCounters
{
public:
  using Counters = GenericLinkServiceCounters;
 
  using Options = GenericLinkServiceOptions;
 
  explicit
  GenericLinkService(const Options& options = {});
 
  const Options&
  getOptions() const
  {
    return m_options;
  }
 
  void
  setOptions(const Options& options);
 
  const Counters&
  getCounters() const NFD_OVERRIDE_WITH_TESTS_ELSE_FINAL
  {
    return *this;
  }
 
  ssize_t
  getEffectiveMtu() const NFD_OVERRIDE_WITH_TESTS_ELSE_FINAL;
 
  bool
  canOverrideMtuTo(ssize_t mtu) const;
 
NFD_PROTECTED_WITH_TESTS_ELSE_PRIVATE: // send path
  void
  requestIdlePacket();
 
  void
  sendLpPacket(lp::Packet&& pkt);
 
  void
  doSendInterest(const Interest& interest) NFD_OVERRIDE_WITH_TESTS_ELSE_FINAL;
 
  void
  doSendData(const Data& data) NFD_OVERRIDE_WITH_TESTS_ELSE_FINAL;
 
  void
  doSendNack(const ndn::lp::Nack& nack) NFD_OVERRIDE_WITH_TESTS_ELSE_FINAL;
 
  void
  assignSequences(std::vector<lp::Packet>& pkts);
 
private: // send path
  void
  encodeLpFields(const ndn::PacketBase& netPkt, lp::Packet& lpPacket);
 
  void
  sendNetPacket(lp::Packet&& pkt, bool isInterest);
 
  void
  checkCongestionLevel(lp::Packet& pkt);
 
private: // receive path
  void
  doReceivePacket(const Block& packet, const EndpointId& endpoint) NFD_OVERRIDE_WITH_TESTS_ELSE_FINAL;
 
  void
  decodeNetPacket(const Block& netPkt, const lp::Packet& firstPkt, const EndpointId& endpointId);
 
  void
  decodeInterest(const Block& netPkt, const lp::Packet& firstPkt, const EndpointId& endpointId);
 
  void
  decodeData(const Block& netPkt, const lp::Packet& firstPkt, const EndpointId& endpointId);
 
  void
  decodeNack(const Block& netPkt, const lp::Packet& firstPkt, const EndpointId& endpointId);
 
NFD_PROTECTED_WITH_TESTS_ELSE_PRIVATE:
  Options m_options;
  LpFragmenter m_fragmenter;
  LpReassembler m_reassembler;
  LpReliability m_reliability;
  lp::Sequence m_lastSeqNo = static_cast<lp::Sequence>(-2);
 
NFD_PUBLIC_WITH_TESTS_ELSE_PRIVATE:
  time::steady_clock::time_point m_nextMarkTime = time::steady_clock::time_point::max();
  size_t m_nMarkedSinceInMarkingState = 0;
 
  friend LpReliability;
};
 
} // namespace nfd::face
 
#endif // NFD_DAEMON_FACE_GENERIC_LINK_SERVICE_HPP