segmenter.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2022 Regents of the University of California.
4  *
5  * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6  *
7  * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8  * terms of the GNU Lesser General Public License as published by the Free Software
9  * Foundation, either version 3 of the License, or (at your option) any later version.
10  *
11  * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13  * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14  *
15  * You should have received copies of the GNU General Public License and GNU Lesser
16  * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17  * <http://www.gnu.org/licenses/>.
18  *
19  * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
20  */
21 
22 #ifndef NDN_CXX_UTIL_SEGMENTER_HPP
23 #define NDN_CXX_UTIL_SEGMENTER_HPP
24 
26 #include "ndn-cxx/util/span.hpp"
27 
28 namespace ndn {
29 namespace util {
30 
34 class Segmenter
35 {
36 public:
42  Segmenter(KeyChain& keyChain, const security::SigningInfo& signingInfo);
43 
53  NDN_CXX_NODISCARD std::vector<std::shared_ptr<Data>>
54  segment(span<const uint8_t> buffer,
55  const Name& dataName,
56  size_t maxSegmentSize,
57  time::milliseconds freshnessPeriod,
58  uint32_t contentType = tlv::ContentType_Blob);
59 
69  NDN_CXX_NODISCARD std::vector<std::shared_ptr<Data>>
70  segment(std::istream& input,
71  const Name& dataName,
72  size_t maxSegmentSize,
73  time::milliseconds freshnessPeriod,
74  uint32_t contentType = tlv::ContentType_Blob);
75 
76 private:
77  KeyChain& m_keyChain;
78  security::SigningInfo m_signingInfo;
79 };
80 
81 } // namespace util
82 } // namespace ndn
83 
84 #endif // NDN_CXX_UTIL_SEGMENTER_HPP
#define NDN_CXX_NODISCARD
Definition: backports.hpp:68
Represents an absolute name.
Definition: name.hpp:44
Signing parameters passed to KeyChain.
Utility class to segment an object into multiple Data packets.
Definition: segmenter.hpp:35
Segmenter(KeyChain &keyChain, const security::SigningInfo &signingInfo)
Constructor.
Definition: segmenter.cpp:29
std::vector< std::shared_ptr< Data > > segment(span< const uint8_t > buffer, const Name &dataName, size_t maxSegmentSize, time::milliseconds freshnessPeriod, uint32_t contentType=tlv::ContentType_Blob)
Splits a blob of bytes into one or more Data packets (segments).
Definition: segmenter.cpp:36
boost::chrono::milliseconds milliseconds
Definition: time.hpp:48
@ ContentType_Blob
payload
Definition: tlv.hpp:145
Definition: data.cpp:25