step-source.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_SECURITY_TRANSFORM_STEP_SOURCE_HPP
23 #define NDN_CXX_SECURITY_TRANSFORM_STEP_SOURCE_HPP
24 
26 
27 namespace ndn {
28 namespace security {
29 namespace transform {
30 
45 class StepSource : public Source
46 {
47 public:
56  size_t
57  write(span<const uint8_t> buf);
58 
62  void
63  end();
64 
65 private:
71  void
72  doPump() final;
73 };
74 
76 
77 } // namespace transform
78 } // namespace security
79 } // namespace ndn
80 
81 #endif // NDN_CXX_SECURITY_TRANSFORM_STEP_SOURCE_HPP
Abstraction of the transformation source module.
A source that can accept input step by step, and can close input explicitly.
Definition: step-source.hpp:46
size_t write(span< const uint8_t > buf)
Accept input data and directly write input into next transformation module.
Definition: step-source.cpp:29
void end()
Close the input interface and directly notify the next module the end of input.
Definition: step-source.cpp:35
Definition: data.cpp:25
There are three types of module in a transformation chain: Source, Transform, and Sink.