AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
AttachmentManager.h
Go to the documentation of this file.
1 /*
2  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License").
5  * You may not use this file except in compliance with the License.
6  * A copy of the License is located at
7  *
8  * http://aws.amazon.com/apache2.0/
9  *
10  * or in the "license" file accompanying this file. This file is distributed
11  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12  * express or implied. See the License for the specific language governing
13  * permissions and limitations under the License.
14  */
15 
16 #ifndef ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_ATTACHMENT_ATTACHMENTMANAGER_H_
17 #define ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_ATTACHMENT_ATTACHMENTMANAGER_H_
18 
19 #include <mutex>
20 #include <unordered_map>
21 
23 
24 namespace alexaClientSDK {
25 namespace avsCommon {
26 namespace avs {
27 namespace attachment {
28 
51 public:
56  static constexpr std::chrono::minutes ATTACHMENT_MANAGER_TIMOUT_MINUTES_DEFAULT = std::chrono::hours(12);
57 
62  static constexpr std::chrono::minutes ATTACHMENT_MANAGER_TIMOUT_MINUTES_MINIMUM = std::chrono::minutes(1);
63 
69  enum class AttachmentType {
72  };
73 
79  static std::shared_ptr<AttachmentManagerInterface> createInProcessAttachmentManagerInterface();
80 
87  AttachmentManager(AttachmentType attachmentType);
88 
89  std::string generateAttachmentId(const std::string& contextId, const std::string& contentId) const override;
90 
91  bool setAttachmentTimeoutMinutes(std::chrono::minutes timeoutMinutes) override;
92 
93  std::unique_ptr<AttachmentWriter> createWriter(
94  const std::string& attachmentId,
96 
97  std::unique_ptr<AttachmentReader> createReader(const std::string& attachmentId, utils::sds::ReaderPolicy policy)
98  override;
99 
100 private:
104  struct AttachmentManagementDetails {
108  AttachmentManagementDetails();
109 
111  std::chrono::steady_clock::time_point creationTime;
113  std::unique_ptr<Attachment> attachment;
114  };
115 
125  AttachmentManagementDetails& getDetailsLocked(const std::string& attachmentId);
126 
132  void removeExpiredAttachmentsLocked();
133 
135  AttachmentType m_attachmentType;
137  std::chrono::minutes m_attachmentExpirationMinutes;
139  std::mutex m_mutex;
141  std::unordered_map<std::string, AttachmentManagementDetails> m_attachmentDetailsMap;
142 };
143 
144 } // namespace attachment
145 } // namespace avs
146 } // namespace avsCommon
147 } // namespace alexaClientSDK
148 
149 #endif // ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_ATTACHMENT_ATTACHMENTMANAGER_H_
bool setAttachmentTimeoutMinutes(std::chrono::minutes timeoutMinutes) override
Definition: AttachmentManager.cpp:81
WriterPolicy
Specifies the policy to use for writing to the stream.
Definition: WriterPolicy.h:25
std::unique_ptr< AttachmentReader > createReader(const std::string &attachmentId, utils::sds::ReaderPolicy policy) override
Definition: AttachmentManager.cpp:139
static constexpr std::chrono::minutes ATTACHMENT_MANAGER_TIMOUT_MINUTES_MINIMUM
Definition: AttachmentManager.h:62
static constexpr std::chrono::minutes ATTACHMENT_MANAGER_TIMOUT_MINUTES_DEFAULT
Definition: AttachmentManager.h:56
static std::shared_ptr< AttachmentManagerInterface > createInProcessAttachmentManagerInterface()
Definition: AttachmentManager.cpp:53
std::string generateAttachmentId(const std::string &contextId, const std::string &contentId) const override
Definition: AttachmentManager.cpp:62
Whether or not curl logs should be emitted.
Definition: AVSConnectionManager.h:36
ReaderPolicy
Specifies the policy to use for reading from the stream.
Definition: ReaderPolicy.h:25
AttachmentManager(AttachmentType attachmentType)
Definition: AttachmentManager.cpp:57
std::unique_ptr< AttachmentWriter > createWriter(const std::string &attachmentId, utils::sds::WriterPolicy policy=avsCommon::utils::sds::WriterPolicy::ALL_OR_NOTHING) override
Definition: AttachmentManager.cpp:123

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