NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
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-2018 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_ENCODING_BUFFER_STREAM_HPP
25 #define NDN_ENCODING_BUFFER_STREAM_HPP
26 
28 
29 #include <boost/iostreams/categories.hpp>
30 #include <boost/iostreams/stream.hpp>
31 
32 namespace ndn {
33 
34 namespace detail {
35 
39 {
40 public:
41  typedef char char_type;
42  typedef boost::iostreams::sink_tag category;
43 
44  explicit
45  BufferAppendDevice(Buffer& container);
46 
47  std::streamsize
48  write(const char_type* s, std::streamsize n);
49 
50 protected:
52 };
53 
54 } // namespace detail
55 
70 class OBufferStream : public boost::iostreams::stream<detail::BufferAppendDevice>
71 {
72 public:
73  OBufferStream();
74 
76 
80  shared_ptr<Buffer>
81  buf();
82 
83 private:
84  BufferPtr m_buffer;
86 };
87 
88 } // namespace ndn
89 
90 #endif // NDN_ENCODING_BUFFER_STREAM_HPP
ndn::detail::BufferAppendDevice::m_container
Buffer & m_container
Definition: buffer-stream.hpp:51
ndn::Buffer
General-purpose automatically managed/resized buffer.
Definition: buffer.hpp:41
ndn::detail::BufferAppendDevice::BufferAppendDevice
BufferAppendDevice(Buffer &container)
Definition: buffer-stream.cpp:27
ndn::detail::BufferAppendDevice::char_type
char char_type
Definition: buffer-stream.hpp:41
ndn::detail::BufferAppendDevice
(implementation detail) a Boost.Iostreams.Sink which appends to an ndn::Buffer
Definition: buffer-stream.hpp:39
ndn::OBufferStream
implements an output stream that constructs ndn::Buffer
Definition: buffer-stream.hpp:71
ndn::BufferPtr
shared_ptr< Buffer > BufferPtr
Definition: buffer.hpp:125
ndn::OBufferStream::OBufferStream
OBufferStream()
Definition: buffer-stream.cpp:41
ndn::detail::BufferAppendDevice::write
std::streamsize write(const char_type *s, std::streamsize n)
Definition: buffer-stream.cpp:33
ndn::OBufferStream::~OBufferStream
~OBufferStream()
Definition: buffer-stream.cpp:48
ndn::detail::BufferAppendDevice::category
boost::iostreams::sink_tag category
Definition: buffer-stream.hpp:42
buffer.hpp
ndn::OBufferStream::buf
shared_ptr< Buffer > buf()
Flush written data to the stream and return shared pointer to the underlying buffer.
Definition: buffer-stream.cpp:54
ndn
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-strategy-choice-helper.hpp:34