mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-04 11:15:56 +00:00
1d42c4f6de
Per XLS-0095, we are taking steps to rename ripple(d) to xrpl(d). This change specifically removes all copyright notices referencing Ripple, XRPLF, and certain affiliated contributors upon mutual agreement, so the notice in the LICENSE.md file applies throughout. Copyright notices referencing external contributions remain as-is. Duplicate verbiage is also removed.
43 lines
964 B
C++
43 lines
964 B
C++
#ifndef XRPL_SERVER_WRITER_H_INCLUDED
|
|
#define XRPL_SERVER_WRITER_H_INCLUDED
|
|
|
|
#include <boost/asio/buffer.hpp>
|
|
|
|
#include <functional>
|
|
#include <vector>
|
|
|
|
namespace ripple {
|
|
|
|
class Writer
|
|
{
|
|
public:
|
|
virtual ~Writer() = default;
|
|
|
|
/** Returns `true` if there is no more data to pull. */
|
|
virtual bool
|
|
complete() = 0;
|
|
|
|
/** Removes bytes from the input sequence.
|
|
|
|
Can be called with 0.
|
|
*/
|
|
virtual void
|
|
consume(std::size_t bytes) = 0;
|
|
|
|
/** Add data to the input sequence.
|
|
@param bytes A hint to the number of bytes desired.
|
|
@param resume A functor to later resume execution.
|
|
@return `true` if the writer is ready to provide more data.
|
|
*/
|
|
virtual bool
|
|
prepare(std::size_t bytes, std::function<void(void)> resume) = 0;
|
|
|
|
/** Returns a ConstBufferSequence representing the input sequence. */
|
|
virtual std::vector<boost::asio::const_buffer>
|
|
data() = 0;
|
|
};
|
|
|
|
} // namespace ripple
|
|
|
|
#endif
|