rippled
Public Member Functions | List of all members
ripple::Writer Class Referenceabstract
Inheritance diagram for ripple::Writer:
Inheritance graph
[legend]

Public Member Functions

virtual ~Writer ()=default
 
virtual bool complete ()=0
 Returns true if there is no more data to pull. More...
 
virtual void consume (std::size_t bytes)=0
 Removes bytes from the input sequence. More...
 
virtual bool prepare (std::size_t bytes, std::function< void(void)> resume)=0
 Add data to the input sequence. More...
 
virtual std::vector< boost::asio::const_buffer > data ()=0
 Returns a ConstBufferSequence representing the input sequence. More...
 

Detailed Description

Definition at line 29 of file server/Writer.h.

Constructor & Destructor Documentation

◆ ~Writer()

virtual ripple::Writer::~Writer ( )
virtualdefault

Member Function Documentation

◆ complete()

virtual bool ripple::Writer::complete ( )
pure virtual

Returns true if there is no more data to pull.

Implemented in ripple::SimpleWriter.

◆ consume()

virtual void ripple::Writer::consume ( std::size_t  bytes)
pure virtual

Removes bytes from the input sequence.

Can be called with 0.

Implemented in ripple::SimpleWriter.

◆ prepare()

virtual bool ripple::Writer::prepare ( std::size_t  bytes,
std::function< void(void)>  resume 
)
pure virtual

Add data to the input sequence.

Parameters
bytesA hint to the number of bytes desired.
resumeA functor to later resume execution.
Returns
true if the writer is ready to provide more data.

Implemented in ripple::SimpleWriter.

◆ data()

virtual std::vector<boost::asio::const_buffer> ripple::Writer::data ( )
pure virtual

Returns a ConstBufferSequence representing the input sequence.

Implemented in ripple::SimpleWriter.