AlexaClientSDK  1.23.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::avsCommon::avs::attachment::AttachmentManagerInterface Class Referenceabstract

#include <AttachmentManagerInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::avs::attachment::AttachmentManagerInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~AttachmentManagerInterface ()=default
 
virtual std::string generateAttachmentId (const std::string &contextId, const std::string &contentId) const =0
 
virtual bool setAttachmentTimeoutMinutes (std::chrono::minutes timeoutMinutes)=0
 
virtual std::unique_ptr< AttachmentWritercreateWriter (const std::string &attachmentId, utils::sds::WriterPolicy policy=avsCommon::utils::sds::WriterPolicy::ALL_OR_NOTHING)=0
 
virtual std::unique_ptr< AttachmentReadercreateReader (const std::string &attachmentId, utils::sds::ReaderPolicy policy)=0
 

Detailed Description

This class allows the decoupling of attachment readers and writers from the management of attachments.

This class is thread safe.

Constructor & Destructor Documentation

◆ ~AttachmentManagerInterface()

virtual alexaClientSDK::avsCommon::avs::attachment::AttachmentManagerInterface::~AttachmentManagerInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ createReader()

virtual std::unique_ptr<AttachmentReader> alexaClientSDK::avsCommon::avs::attachment::AttachmentManagerInterface::createReader ( const std::string &  attachmentId,
utils::sds::ReaderPolicy  policy 
)
pure virtual

Returns a pointer to an AttachmentReader.

Note
Calls to createReader and createWriter may occur in any order.
Parameters
attachmentIdThe id of the Attachment.
policyThe AttachmentReader policy, which determines the semantics of the AttachmentReader.read().
Returns
An AttachmentReader.

Implemented in alexaClientSDK::avsCommon::avs::attachment::AttachmentManager, and alexaClientSDK::avsCommon::utils::TestableAttachmentManager.

◆ createWriter()

virtual std::unique_ptr<AttachmentWriter> alexaClientSDK::avsCommon::avs::attachment::AttachmentManagerInterface::createWriter ( const std::string &  attachmentId,
utils::sds::WriterPolicy  policy = avsCommon::utils::sds::WriterPolicy::ALL_OR_NOTHING 
)
pure virtual

Returns a pointer to an AttachmentWriter.

Note
Calls to createReader and createWriter may occur in any order.
Parameters
attachmentIdThe id of the Attachment.
policyThe WriterPolicy that the AttachmentWriter should adhere to.
Returns
An AttachmentWriter.

Implemented in alexaClientSDK::avsCommon::avs::attachment::AttachmentManager, and alexaClientSDK::avsCommon::utils::TestableAttachmentManager.

◆ generateAttachmentId()

virtual std::string alexaClientSDK::avsCommon::avs::attachment::AttachmentManagerInterface::generateAttachmentId ( const std::string &  contextId,
const std::string &  contentId 
) const
pure virtual

Creates an attachmentId given two particular strings - the contextId and the contentId. Generally, contextId allows disambiguation when two attachment contentIds are not guaranteed to be unique. This function provides a consistent way for different parts of application code to combine contextId and contentId into a single string. Clearly, both the reader and writer of a given attachment need to call this function with the same two strings.

As an example of usage, if an application has several sources of attachments, for example two audio providers, then one pair of contextId / contentId strings might be: { "AudioProvider1", "Attachment1" }. If the other audio provider creates an attachment, then the pair: { "AudioProvider2", "Attachment1" } allows the contextId to disambiguate what happens to be identical contentIds.

If this function is called with one or both strings being empty, then the combine will not be performed. In the case of both strings being empty, an empty string will be returned. If only one string is non-empty, then that string will be returned.

Parameters
contextIdThe contextId, which generally reflects the source of the Attachment.
contentIdThe contentId, which is considered unique when paired with a particular contextId.
Returns
The combined strings, which may be then used as a single attachmentId, per the logic outlined above.

Implemented in alexaClientSDK::avsCommon::avs::attachment::AttachmentManager, and alexaClientSDK::avsCommon::utils::TestableAttachmentManager.

◆ setAttachmentTimeoutMinutes()

virtual bool alexaClientSDK::avsCommon::avs::attachment::AttachmentManagerInterface::setAttachmentTimeoutMinutes ( std::chrono::minutes  timeoutMinutes)
pure virtual

Sets the timeout parameter which is used to ensure unused attachments are eventually cleaned up. This time is specified in minutes. An unused attachment is defined as an attachment for which only a reader or writer was created. Such an Attachment is waiting to be either produced or consumed.

If this function is not called, then the timeout is set to a default value specified by the implementation.

The timeout cannot be set lower than an implementation specific minimum, since too low a timeout could cause attachments to be removed before both reader and writer have had time to request it.

Parameters
timeoutMinutesThe timeout, expressed in minutes. If this is less than the minimum, then the setting will not be updated, and the function will return false.
Returns
Whether the timeout was set ok.

Implemented in alexaClientSDK::avsCommon::avs::attachment::AttachmentManager, and alexaClientSDK::avsCommon::utils::TestableAttachmentManager.


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

AlexaClientSDK 1.23.0 - Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0