Qore yaml Module  0.7.1
Public Member Methods | Private Member Methods | List of all members
DataStreamClient::DataStreamSendMessage Class Referenceabstract

this class can be used to send and receive data using the DataStream protocol More...

Inheritance diagram for DataStreamClient::DataStreamSendMessage:
DataStreamClient::DataStreamMessage

Public Member Methods

auto sendData ()
 this method returns data to be returned to the server; when this method returns no value, it signifies the end of the streamed data transfer; this method calls sendDataImpl() to return the data More...
 

Private Member Methods

abstract auto sendDataImpl ()
 reimplement this method in subclasses to support streamed data transfers; when this method returns no value, it signifies the end of the streamed data transfer More...
 

Detailed Description

this class can be used to send and receive data using the DataStream protocol

Member Function Documentation

◆ sendData()

auto DataStreamClient::DataStreamSendMessage::sendData ( )

this method returns data to be returned to the server; when this method returns no value, it signifies the end of the streamed data transfer; this method calls sendDataImpl() to return the data

Returns
the data returned by this callback will be serialized to YAML and send via the DataStream protocol to the remote HTTP REST server in HTTP chunked format; when all data has been send then this callback should return nothing, which will close the chunked message and terminate the request

◆ sendDataImpl()

abstract auto DataStreamClient::DataStreamSendMessage::sendDataImpl ( )
privatepure virtual

reimplement this method in subclasses to support streamed data transfers; when this method returns no value, it signifies the end of the streamed data transfer

Returns
the data returned by this callback will be serialized to YAML and send via the DataStream protocol to the remote HTTP REST server in HTTP chunked format; when all data has been send then this callback should return nothing, which will close the chunked message and terminate the request
The documentation for this class was generated from the following file: