AlexaClientSDK
3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
|
#include <AttachmentManagerInterface.h>
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< AttachmentWriter > | createWriter (const std::string &attachmentId, utils::sds::WriterPolicy policy=avsCommon::utils::sds::WriterPolicy::ALL_OR_NOTHING)=0 |
virtual std::unique_ptr< AttachmentReader > | createReader (const std::string &attachmentId, utils::sds::ReaderPolicy policy)=0 |
This class allows the decoupling of attachment readers and writers from the management of attachments.
This class is thread safe.
|
virtualdefault |
Destructor.
|
pure virtual |
Returns a pointer to an AttachmentReader
.
createReader
and createWriter
may occur in any order.attachmentId | The id of the Attachment . |
policy | The AttachmentReader policy, which determines the semantics of the AttachmentReader.read() . |
AttachmentReader
. Implemented in alexaClientSDK::avsCommon::avs::attachment::AttachmentManager, and alexaClientSDK::avsCommon::utils::TestableAttachmentManager.
|
pure virtual |
Returns a pointer to an AttachmentWriter
.
createReader
and createWriter
may occur in any order.attachmentId | The id of the Attachment . |
policy | The WriterPolicy that the AttachmentWriter should adhere to. |
AttachmentWriter
. Implemented in alexaClientSDK::avsCommon::avs::attachment::AttachmentManager, and alexaClientSDK::avsCommon::utils::TestableAttachmentManager.
|
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.
contextId | The contextId, which generally reflects the source of the Attachment . |
contentId | The contentId, which is considered unique when paired with a particular contextId. |
Implemented in alexaClientSDK::avsCommon::avs::attachment::AttachmentManager, and alexaClientSDK::avsCommon::utils::TestableAttachmentManager.
|
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.
timeoutMinutes | The timeout, expressed in minutes. If this is less than the minimum, then the setting will not be updated, and the function will return false. |
Implemented in alexaClientSDK::avsCommon::avs::attachment::AttachmentManager, and alexaClientSDK::avsCommon::utils::TestableAttachmentManager.
AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0