buffer-stream.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2024 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  * @author Alexander Afanasyev <http://lasr.cs.ucla.edu/afanasyev/index.html>
22  */
23 
24 #ifndef NDN_CXX_ENCODING_BUFFER_STREAM_HPP
25 #define NDN_CXX_ENCODING_BUFFER_STREAM_HPP
26 
28 
29 #include <boost/iostreams/concepts.hpp>
30 #include <boost/iostreams/stream.hpp>
31 
32 namespace ndn {
33 namespace detail {
34 
38 class BufferSink : public boost::iostreams::sink
39 {
40 public:
41  explicit
42  BufferSink(Buffer& container);
43 
44  std::streamsize
45  write(const char_type* s, std::streamsize n);
46 
47 private:
48  Buffer& m_container;
49 };
50 
51 } // namespace detail
52 
69 class OBufferStream : public boost::iostreams::stream<detail::BufferSink>
70 {
71 public:
72  OBufferStream();
73 
74  ~OBufferStream() noexcept override;
75 
79  std::shared_ptr<Buffer>
80  buf();
81 
82 private:
83  std::shared_ptr<Buffer> m_buffer;
84 };
85 
86 } // namespace ndn
87 
88 #endif // NDN_CXX_ENCODING_BUFFER_STREAM_HPP
General-purpose automatically managed/resized buffer.
Definition: buffer.hpp:43
An output stream that writes to a Buffer.
std::shared_ptr< Buffer > buf()
Return a shared pointer to the underlying buffer.
~OBufferStream() noexcept override
(implementation detail) A Boost.Iostreams.Sink that appends to a Buffer.
BufferSink(Buffer &container)
std::streamsize write(const char_type *s, std::streamsize n)
Definition: data.cpp:25