lp-reassembler.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_LP_REASSEMBLER_HPP
#define NFD_DAEMON_FACE_LP_REASSEMBLER_HPP
 
#include "face-common.hpp"
 
#include <ndn-cxx/lp/packet.hpp>
#include <ndn-cxx/lp/sequence.hpp>
#include <ndn-cxx/util/scheduler.hpp>
 
#include <map>
 
namespace nfd::face {
 
class LpReassembler : noncopyable
{
public:
  struct Options
  {
    size_t nMaxFragments = 400;
 
    time::nanoseconds reassemblyTimeout = 500_ms;
  };
 
  explicit
  LpReassembler(const Options& options, const LinkService* linkService = nullptr);
 
  void
  setOptions(const Options& options)
  {
    m_options = options;
  }
 
  const LinkService*
  getLinkService() const noexcept
  {
    return m_linkService;
  }
 
  std::tuple<bool, Block, lp::Packet>
  receiveFragment(const EndpointId& remoteEndpoint, const lp::Packet& packet);
 
  size_t
  size() const noexcept
  {
    return m_partialPackets.size();
  }
 
  signal::Signal<LpReassembler, EndpointId, size_t> beforeTimeout;
 
private:
  struct PartialPacket
  {
    std::vector<lp::Packet> fragments;
    size_t fragCount; 
    size_t nReceivedFragments; 
    ndn::scheduler::ScopedEventId dropTimer;
  };
 
  using Key = std::tuple<
    EndpointId, // remote endpoint
    lp::Sequence // message identifier (sequence number of the first fragment)
  >;
 
  Block
  doReassembly(const Key& key);
 
  void
  timeoutPartialPacket(const Key& key);
 
private:
  Options m_options;
  const LinkService* m_linkService;
  std::map<Key, PartialPacket> m_partialPackets;
};
 
std::ostream&
operator<<(std::ostream& os, const FaceLogHelper<LpReassembler>& flh);
 
} // namespace nfd::face
 
#endif // NFD_DAEMON_FACE_LP_REASSEMBLER_HPP