lp-reassembler.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2019, Regents of the University of California,
4  * Arizona Board of Regents,
5  * Colorado State University,
6  * University Pierre & Marie Curie, Sorbonne University,
7  * Washington University in St. Louis,
8  * Beijing Institute of Technology,
9  * The University of Memphis.
10  *
11  * This file is part of NFD (Named Data Networking Forwarding Daemon).
12  * See AUTHORS.md for complete list of NFD authors and contributors.
13  *
14  * NFD is free software: you can redistribute it and/or modify it under the terms
15  * of the GNU General Public License as published by the Free Software Foundation,
16  * either version 3 of the License, or (at your option) any later version.
17  *
18  * NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
19  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
20  * PURPOSE. See the GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License along with
23  * NFD, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
24  */
25 
26 #ifndef NFD_DAEMON_FACE_LP_REASSEMBLER_HPP
27 #define NFD_DAEMON_FACE_LP_REASSEMBLER_HPP
28 
29 #include "face-common.hpp"
30 
31 #include <ndn-cxx/lp/packet.hpp>
32 
33 namespace nfd {
34 namespace face {
35 
39 class LpReassembler : noncopyable
40 {
41 public:
44  struct Options
45  {
50  size_t nMaxFragments = 400;
51 
54  time::nanoseconds reassemblyTimeout = 500_ms;
55  };
56 
57  explicit
58  LpReassembler(const Options& options, const LinkService* linkService = nullptr);
59 
62  void
63  setOptions(const Options& options);
64 
69  const LinkService*
70  getLinkService() const;
71 
81  std::tuple<bool, Block, lp::Packet>
82  receiveFragment(EndpointId remoteEndpoint, const lp::Packet& packet);
83 
86  size_t
87  size() const;
88 
96  signal::Signal<LpReassembler, EndpointId, size_t> beforeTimeout;
97 
98 private:
101  struct PartialPacket
102  {
103  std::vector<lp::Packet> fragments;
104  size_t fragCount;
105  size_t nReceivedFragments;
106  scheduler::ScopedEventId dropTimer;
107  };
108 
111  typedef std::tuple<
112  EndpointId, // remoteEndpoint
113  lp::Sequence // message identifier (sequence of the first fragment)
114  > Key;
115 
116  Block
117  doReassembly(const Key& key);
118 
119  void
120  timeoutPartialPacket(const Key& key);
121 
122 private:
123  Options m_options;
124  const LinkService* m_linkService;
125  std::map<Key, PartialPacket> m_partialPackets;
126 };
127 
128 std::ostream&
129 operator<<(std::ostream& os, const FaceLogHelper<LpReassembler>& flh);
130 
131 inline void
133 {
134  m_options = options;
135 }
136 
137 inline const LinkService*
139 {
140  return m_linkService;
141 }
142 
143 inline size_t
145 {
146  return m_partialPackets.size();
147 }
148 
149 } // namespace face
150 } // namespace nfd
151 
152 #endif // NFD_DAEMON_FACE_LP_REASSEMBLER_HPP
LpReassembler(const Options &options, const LinkService *linkService=nullptr)
std::tuple< bool, Block, lp::Packet > receiveFragment(EndpointId remoteEndpoint, const lp::Packet &packet)
adds received fragment to the buffer
const LinkService * getLinkService() const
size_t size() const
count of partial packets
uint64_t EndpointId
Identifies a remote endpoint on the link.
Definition: face-common.hpp:65
Copyright (c) 2014-2015, Regents of the University of California, Arizona Board of Regents...
Definition: algorithm.hpp:32
Options that control the behavior of LpReassembler.
signal::Signal< LpReassembler, EndpointId, size_t > beforeTimeout
signals before a partial packet is dropped due to timeout
reassembles fragmented network-layer packets
size_t nMaxFragments
maximum number of fragments in a packet
time::nanoseconds reassemblyTimeout
timeout before a partially reassembled packet is dropped
void setOptions(const Options &options)
set options for reassembler