rippled
Public Member Functions | Private Attributes | List of all members
ripple::StreambufWSMsg< Streambuf > Class Template Reference
Inheritance diagram for ripple::StreambufWSMsg< Streambuf >:
Inheritance graph
[legend]
Collaboration diagram for ripple::StreambufWSMsg< Streambuf >:
Collaboration graph
[legend]

Public Member Functions

 StreambufWSMsg (Streambuf &&sb)
 
std::pair< boost::tribool, std::vector< boost::asio::const_buffer > > prepare (std::size_t bytes, std::function< void(void)>) override
 Retrieve message data. More...
 

Private Attributes

Streambuf sb_
 
std::size_t n_ = 0
 

Detailed Description

template<class Streambuf>
class ripple::StreambufWSMsg< Streambuf >

Definition at line 72 of file WSSession.h.

Constructor & Destructor Documentation

◆ StreambufWSMsg()

template<class Streambuf >
ripple::StreambufWSMsg< Streambuf >::StreambufWSMsg ( Streambuf &&  sb)

Definition at line 78 of file WSSession.h.

Member Function Documentation

◆ prepare()

template<class Streambuf >
std::pair<boost::tribool, std::vector<boost::asio::const_buffer> > ripple::StreambufWSMsg< Streambuf >::prepare ( std::size_t  bytes,
std::function< void(void)>  resume 
)
overridevirtual

Retrieve message data.

Returns a tribool indicating whether or not data is available, and a ConstBufferSequence representing the data.

tribool values: maybe: Data is not ready yet false: Data is available true: Data is available, and it is the last chunk of bytes.

Derived classes that do not know when the data ends (for example, when returning the output of a paged database query) may return true and an empty vector.

Implements ripple::WSMsg.

Definition at line 83 of file WSSession.h.

Member Data Documentation

◆ sb_

template<class Streambuf >
Streambuf ripple::StreambufWSMsg< Streambuf >::sb_
private

Definition at line 74 of file WSSession.h.

◆ n_

template<class Streambuf >
std::size_t ripple::StreambufWSMsg< Streambuf >::n_ = 0
private

Definition at line 75 of file WSSession.h.