rippled
server/Writer.h
1 //------------------------------------------------------------------------------
2 /*
3  This file is part of rippled: https://github.com/ripple/rippled
4  Copyright (c) 2012, 2013 Ripple Labs Inc.
5 
6  Permission to use, copy, modify, and/or distribute this software for any
7  purpose with or without fee is hereby granted, provided that the above
8  copyright notice and this permission notice appear in all copies.
9 
10  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 */
18 //==============================================================================
19 
20 #ifndef RIPPLE_SERVER_WRITER_H_INCLUDED
21 #define RIPPLE_SERVER_WRITER_H_INCLUDED
22 
23 #include <boost/asio/buffer.hpp>
24 #include <functional>
25 #include <vector>
26 
27 namespace ripple {
28 
29 class Writer
30 {
31 public:
32  virtual ~Writer() = default;
33 
35  virtual bool
36  complete() = 0;
37 
42  virtual void
43  consume(std::size_t bytes) = 0;
44 
50  virtual bool
51  prepare(std::size_t bytes, std::function<void(void)> resume) = 0;
52 
55  data() = 0;
56 };
57 
58 } // namespace ripple
59 
60 #endif
ripple::Writer::~Writer
virtual ~Writer()=default
functional
ripple::Writer::data
virtual std::vector< boost::asio::const_buffer > data()=0
Returns a ConstBufferSequence representing the input sequence.
vector
std::function
ripple::Writer::consume
virtual void consume(std::size_t bytes)=0
Removes bytes from the input sequence.
ripple::Writer
Definition: server/Writer.h:29
ripple::Writer::prepare
virtual bool prepare(std::size_t bytes, std::function< void(void)> resume)=0
Add data to the input sequence.
ripple::Writer::complete
virtual bool complete()=0
Returns true if there is no more data to pull.
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition: RCLCensorshipDetector.h:29
std::size_t