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

Public Member Functions

 WSMsg ()=default
 
 WSMsg (WSMsg const &)=delete
 
WSMsgoperator= (WSMsg const &)=delete
 
virtual ~WSMsg ()=default
 
virtual std::pair< boost::tribool, std::vector< boost::asio::const_buffer > > prepare (std::size_t bytes, std::function< void(void)> resume)=0
 Retrieve message data. More...
 

Detailed Description

Definition at line 41 of file WSSession.h.

Constructor & Destructor Documentation

◆ WSMsg() [1/2]

ripple::WSMsg::WSMsg ( )
default

◆ WSMsg() [2/2]

ripple::WSMsg::WSMsg ( WSMsg const &  )
delete

◆ ~WSMsg()

virtual ripple::WSMsg::~WSMsg ( )
virtualdefault

Member Function Documentation

◆ operator=()

WSMsg& ripple::WSMsg::operator= ( WSMsg const &  )
delete

◆ prepare()

virtual std::pair<boost::tribool, std::vector<boost::asio::const_buffer> > ripple::WSMsg::prepare ( std::size_t  bytes,
std::function< void(void)>  resume 
)
pure virtual

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.

Implemented in ripple::StreambufWSMsg< Streambuf >.