rippled
Loading...
Searching...
No Matches
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
25#include <functional>
26#include <vector>
27
28namespace ripple {
29
30class Writer
31{
32public:
33 virtual ~Writer() = default;
34
36 virtual bool
37 complete() = 0;
38
43 virtual void
44 consume(std::size_t bytes) = 0;
45
51 virtual bool
52 prepare(std::size_t bytes, std::function<void(void)> resume) = 0;
53
56 data() = 0;
57};
58
59} // namespace ripple
60
61#endif
virtual ~Writer()=default
virtual std::vector< boost::asio::const_buffer > data()=0
Returns a ConstBufferSequence representing the input sequence.
virtual bool complete()=0
Returns true if there is no more data to pull.
virtual bool prepare(std::size_t bytes, std::function< void(void)> resume)=0
Add data to the input sequence.
virtual void consume(std::size_t bytes)=0
Removes bytes from the input sequence.
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:25