Inheritance diagram for alexaClientSDK::avsCommon::avs::attachment::AttachmentWriter:

Public Types
enum	WriteStatus { WriteStatus::OK, WriteStatus::CLOSED, WriteStatus::OK_BUFFER_FULL, WriteStatus::ERROR_BYTES_LESS_THAN_WORD_SIZE, WriteStatus::ERROR_INTERNAL, WriteStatus::TIMEDOUT }

Public Member Functions
virtual	~AttachmentWriter ()=default

virtual std::size_t	write (const void buf, std::size_t numBytes, WriteStatus writeStatus, std::chrono::milliseconds timeout=std::chrono::milliseconds(0))=0

virtual void	close ()=0

Detailed Description

A class that provides functionality to write data to an Attachment.

Member Enumeration Documentation

strong

An enum class to communicate the possible states following a write() call.

Enumerator
OK	Things are ok.
CLOSED	The underlying data representation is no longer writeable.
OK_BUFFER_FULL	The write could not succeed due to the underlying buffer being full.
ERROR_BYTES_LESS_THAN_WORD_SIZE	The number of bytes in the request is smaller than the word-size of the underlying data representation. This is only posible if the policy is ALL_OR_NOTHING.
ERROR_INTERNAL	A non-specified error occurred.
TIMEDOUT	The write timed out. This is only possible if the writer policy is BLOCKING.

virtual alexaClientSDK::avsCommon::avs::attachment::AttachmentWriter::~AttachmentWriter ( )

virtualdefault

Destructor.

virtual void alexaClientSDK::avsCommon::avs::attachment::AttachmentWriter::close ( )

pure virtual

The close function. An implementation will take care of any resource management when a writer no longer needs to use an attachment.

virtual std::size_t alexaClientSDK::avsCommon::avs::attachment::AttachmentWriter::write	(	const void *	buf,
		std::size_t	numBytes,
		WriteStatus *	writeStatus,
		std::chrono::milliseconds	timeout = `std::chrono::milliseconds(0)`
	)

pure virtual

The write function.

Parameters

	buf	The buffer where data should be copied from.
	numBytes	The size of the buffer in bytes.
[out]	writeStatus	The out-parameter where the resulting state of the write will be expressed.
	timeout	The maximum time to wait (if `policy` is `BLOCKING`) for space to write into. If this parameter is zero, there is no timeout and blocking writes will wait forever. If `policy` is not BLOCKING, this parameter is ignored.

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

/workplace/avs-device-sdk/AVSCommon/AVS/include/AVSCommon/AVS/Attachment/AttachmentWriter.h