alexaClientSDK::avsCommon::utils::http2::HTTP2MimeRequestSourceInterface Class Reference

#include <HTTP2MimeRequestSourceInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::utils::http2::HTTP2MimeRequestSourceInterface:

Public Member Functions
virtual	~HTTP2MimeRequestSourceInterface ()=default
virtual std::vector< std::string >	getRequestHeaderLines ()=0
virtual HTTP2GetMimeHeadersResult	getMimePartHeaderLines ()=0
virtual HTTP2SendDataResult	onSendMimePartData (char *bytes, size_t size)=0

Detailed Description

Interface for providing data to be sent as part of a Mime encoded HTTP2 request.

Constructor & Destructor Documentation

~HTTP2MimeRequestSourceInterface()

virtual alexaClientSDK::avsCommon::utils::http2::HTTP2MimeRequestSourceInterface::~HTTP2MimeRequestSourceInterface ( )

virtualdefault

Default destructor.

Member Function Documentation

getMimePartHeaderLines()

virtual HTTP2GetMimeHeadersResult alexaClientSDK::avsCommon::utils::http2::HTTP2MimeRequestSourceInterface::getMimePartHeaderLines ( )

pure virtual

Get the header lines that should be output with the next mime part. This will be called once before onSendMimePartData() is called for the first mime part and after each call to onSendMimePartData() that returns HTTP2SendDataResult.status == COMPLETE.

Note

Calls to this method may block network operations for the associated instance of HTTP2ConnectionInterface, so they should return quickly.

Returns

An HTTP2GetMimeHeadersResult specifying the status of the operation and a vector of header lines if the status was CONTINUE.

Implemented in alexaClientSDK::acl::MessageRequestHandler, and alexaClientSDK::avsCommon::utils::http2::MockHTTP2MimeRequestEncodeSource.

getRequestHeaderLines()

virtual std::vector<std::string> alexaClientSDK::avsCommon::utils::http2::HTTP2MimeRequestSourceInterface::getRequestHeaderLines ( )

pure virtual

Get the header lines that should be output with this HTTP2 request.

Note

Calls to this method may block network operations for the associated instance of HTTP2ConnectionInterface, so they should return quickly.

Returns

The header lines that should be output with this request.

Implemented in alexaClientSDK::acl::MessageRequestHandler, and alexaClientSDK::avsCommon::utils::http2::MockHTTP2MimeRequestEncodeSource.

onSendMimePartData()

virtual HTTP2SendDataResult alexaClientSDK::avsCommon::utils::http2::HTTP2MimeRequestSourceInterface::onSendMimePartData ( char *  bytes, size_t  size  )

pure virtual

Notification to copy data to be mime encoded in to an HTTP2 request.

Note

Calls to this method may block network operations for the associated instance of HTTP2ConnectionInterface, so they should return quickly.

Parameters

bytes	The buffer to receive the bytes to send.
size	The max number of bytes to copy.

Returns

Result indicating the disposition of the operation and number of bytes copied.

See also

HTTPSendMimePartDataResult.

Implemented in alexaClientSDK::acl::MessageRequestHandler, and alexaClientSDK::avsCommon::utils::http2::MockHTTP2MimeRequestEncodeSource.

---

The documentation for this class was generated from the following file:

• /workplace/avs-device-sdk/AVSCommon/Utils/include/AVSCommon/Utils/HTTP2/HTTP2MimeRequestSourceInterface.h