#include <TestableAttachmentWriter.h>

Inheritance diagram for alexaClientSDK::avsCommon::utils::TestableAttachmentWriter:

Collaboration diagram for alexaClientSDK::avsCommon::utils::TestableAttachmentWriter:

Public Member Functions
	TestableAttachmentWriter (std::shared_ptr< avsCommon::utils::sds::InProcessSDS > dummySDS, std::unique_ptr< avsCommon::avs::attachment::AttachmentWriter > writer)

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

void	close () override

Public Member Functions inherited from alexaClientSDK::avsCommon::avs::attachment::InProcessAttachmentWriter
	~InProcessAttachmentWriter ()

Public Member Functions inherited from alexaClientSDK::avsCommon::avs::attachment::AttachmentWriter
virtual	~AttachmentWriter ()=default

Additional Inherited Members
Public Types inherited from alexaClientSDK::avsCommon::avs::attachment::InProcessAttachmentWriter
using	SDSType = avsCommon::utils::sds::InProcessSDS
	Type aliases for convenience. More...

using	SDSTypeWriter = SDSType::Writer

Public Types inherited from alexaClientSDK::avsCommon::avs::attachment::AttachmentWriter
enum	WriteStatus { WriteStatus::OK, WriteStatus::CLOSED, WriteStatus::OK_BUFFER_FULL, WriteStatus::ERROR_BYTES_LESS_THAN_WORD_SIZE, WriteStatus::ERROR_INTERNAL, WriteStatus::TIMEDOUT }

Static Public Member Functions inherited from alexaClientSDK::avsCommon::avs::attachment::InProcessAttachmentWriter
static std::unique_ptr< InProcessAttachmentWriter >	create (std::shared_ptr< SDSType > sds, SDSTypeWriter::Policy policy=SDSTypeWriter::Policy::ALL_OR_NOTHING)

Protected Member Functions inherited from alexaClientSDK::avsCommon::avs::attachment::InProcessAttachmentWriter
	InProcessAttachmentWriter (std::shared_ptr< SDSType > sds, SDSTypeWriter::Policy policy=SDSTypeWriter::Policy::ALL_OR_NOTHING)

Protected Attributes inherited from alexaClientSDK::avsCommon::avs::attachment::InProcessAttachmentWriter
std::shared_ptr< SDSTypeWriter >	m_writer
	The underlying `SharedDataStream` reader. More...

Detailed Description

A version of the Decorator Pattern, this class allows us to simulate pausing writes without requiring an actual (slow) AttachmentReader anywhere in the test code. Besides this small change in functionality, all real work is done by the encapsulated InProcessAttachmentWriter object.

Constructor & Destructor Documentation

◆ TestableAttachmentWriter()

alexaClientSDK::avsCommon::utils::TestableAttachmentWriter::TestableAttachmentWriter	(	std::shared_ptr< avsCommon::utils::sds::InProcessSDS >	dummySDS,
		std::unique_ptr< avsCommon::avs::attachment::AttachmentWriter >	writer
	)

Constructor.

Parameters

dummySDS	An SDS used to instantiate this class, although it will never be used. This is to avert any risk of this wrapper object being created with a nullptr.
writer	The AttachmentWriter object to be wrapped by this class.

Member Function Documentation

◆ close()

void alexaClientSDK::avsCommon::utils::TestableAttachmentWriter::close ( )

overridevirtual

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

Reimplemented from alexaClientSDK::avsCommon::avs::attachment::InProcessAttachmentWriter.

◆ write()

std::size_t alexaClientSDK::avsCommon::utils::TestableAttachmentWriter::write	(	const void *	buf,
		std::size_t	numBytes,
		WriteStatus *	writeStatus,
		std::chrono::milliseconds	timeout
	)

overridevirtual

The write function.