blob: 0833a0ff66c78bfd9ae4d6bea0ebef35a32141d6 [file] [log] [blame]
Yingdi Yu3168c302015-07-04 16:45:40 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/**
3 * Copyright (c) 2013-2016 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_BUFFER_SOURCE_HPP
23#define NDN_CXX_SECURITY_TRANSFORM_BUFFER_SOURCE_HPP
24
25#include "transform-base.hpp"
26#include "../../encoding/buffer.hpp"
27
28namespace ndn {
29namespace security {
30namespace transform {
31
32/**
33 * @brief A source taking a memory buffer as input
34 */
35class BufferSource : public Source
36{
37public:
38 /**
39 * @brief Take a buffer @p buf with size of @p size as input.
40 *
41 * Caller must not destroy the buffer before transformation is done
42 */
43 BufferSource(const uint8_t* buf, size_t size);
44
45 /**
46 * @brief Take @p string as input.
47 *
48 * Caller must not destroy the string before transformation is done
49 */
50 explicit
51 BufferSource(const std::string& string);
52
53 /**
54 * @brief Take @p buffer as input.
55 *
56 * Caller must not destroy the buffer before transformation is done
57 */
58 explicit
59 BufferSource(const Buffer& buffer);
60
61private:
62 /**
63 * @brief Write the whole buffer into the next module.
64 */
65 virtual void
66 doPump() final;
67
68private:
69 const uint8_t* m_buf;
70 size_t m_size;
71};
72
73typedef BufferSource bufferSource;
74
75} // namespace transform
76} // namespace security
77} // namespace ndn
78
79#endif // NDN_CXX_SECURITY_TRANSFORM_BUFFER_SOURCE_HPP