AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::acl::MessageRequestQueue Class Reference

#include <MessageRequestQueue.h>

Inheritance diagram for alexaClientSDK::acl::MessageRequestQueue:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::acl::MessageRequestQueue:
Collaboration graph
[legend]

Public Member Functions

 MessageRequestQueue ()
 
void enqueueRequest (std::shared_ptr< avsCommon::avs::MessageRequest > messageRequest) override
 
avsCommon::utils::Optional< std::chrono::time_point< std::chrono::steady_clock > > peekRequestTime () override
 
std::shared_ptr< avsCommon::avs::MessageRequestdequeueOldestRequest () override
 
std::shared_ptr< avsCommon::avs::MessageRequestdequeueSendableRequest () override
 
bool isMessageRequestAvailable () const override
 
void setWaitingForSendAcknowledgement () override
 
void clearWaitingForSendAcknowledgement () override
 
bool empty () const override
 
void clear () override
 
- Public Member Functions inherited from alexaClientSDK::acl::MessageRequestQueueInterface
virtual ~MessageRequestQueueInterface ()=default
 

Detailed Description

Class to manage MessageRequest send queues in HTTP2Transport.

Note: This class is not thread safe. The user should ensure thread safety.

Constructor & Destructor Documentation

◆ MessageRequestQueue()

alexaClientSDK::acl::MessageRequestQueue::MessageRequestQueue ( )

Constructor.

Member Function Documentation

◆ clear()

void alexaClientSDK::acl::MessageRequestQueue::clear ( )
overridevirtual

◆ clearWaitingForSendAcknowledgement()

void alexaClientSDK::acl::MessageRequestQueue::clearWaitingForSendAcknowledgement ( )
overridevirtual

◆ dequeueOldestRequest()

std::shared_ptr<avsCommon::avs::MessageRequest> alexaClientSDK::acl::MessageRequestQueue::dequeueOldestRequest ( )
overridevirtual

◆ dequeueSendableRequest()

std::shared_ptr<avsCommon::avs::MessageRequest> alexaClientSDK::acl::MessageRequestQueue::dequeueSendableRequest ( )
overridevirtual

◆ empty()

bool alexaClientSDK::acl::MessageRequestQueue::empty ( ) const
overridevirtual

◆ enqueueRequest()

void alexaClientSDK::acl::MessageRequestQueue::enqueueRequest ( std::shared_ptr< avsCommon::avs::MessageRequest messageRequest)
overridevirtual

◆ isMessageRequestAvailable()

bool alexaClientSDK::acl::MessageRequestQueue::isMessageRequestAvailable ( ) const
overridevirtual

◆ peekRequestTime()

avsCommon::utils::Optional<std::chrono::time_point<std::chrono::steady_clock> > alexaClientSDK::acl::MessageRequestQueue::peekRequestTime ( )
overridevirtual

◆ setWaitingForSendAcknowledgement()

void alexaClientSDK::acl::MessageRequestQueue::setWaitingForSendAcknowledgement ( )
overridevirtual

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

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