avs-device-sdk/AVSCommon/AVS/src/WaitableMessageRequest.cpp

75 lines
2.6 KiB
C++

/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0/
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
#include "AVSCommon/AVS/WaitableMessageRequest.h"
#include <AVSCommon/Utils/Logger/Logger.h>
namespace alexaClientSDK {
namespace avsCommon {
namespace avs {
using namespace avsCommon::sdkInterfaces;
/// String to identify log entries originating from this file.
static const std::string TAG("WaitableMessageRequest");
/**
* Create a LogEntry using this file's TAG and the specified event string.
*
* @param event The event string for this @c LogEntry.
*/
#define LX(event) alexaClientSDK::avsCommon::utils::logger::LogEntry(TAG, event)
/// The connection timeout indicating how long to wait for the response to be received.
static const auto CONNECTION_TIMEOUT = std::chrono::seconds(15);
WaitableMessageRequest::WaitableMessageRequest(const std::string& jsonContent) :
MessageRequest{jsonContent},
m_sendMessageStatus{MessageRequestObserverInterface::Status::TIMEDOUT},
m_responseReceived{false},
m_isRequestShuttingDown{false} {
}
void WaitableMessageRequest::sendCompleted(
alexaClientSDK::avsCommon::sdkInterfaces::MessageRequestObserverInterface::Status sendMessageStatus) {
MessageRequest::sendCompleted(sendMessageStatus);
std::lock_guard<std::mutex> lock{m_requestMutex};
if (!m_responseReceived) {
m_sendMessageStatus = sendMessageStatus;
m_responseReceived = true;
} else {
ACSDK_WARN(LX("sendCompleted").d("reason", "sendCompletedCalled when m_responseReceived"));
}
m_requestCv.notify_one();
}
MessageRequestObserverInterface::Status WaitableMessageRequest::waitForCompletion() {
std::unique_lock<std::mutex> lock(m_requestMutex);
m_requestCv.wait_for(lock, CONNECTION_TIMEOUT, [this] { return m_isRequestShuttingDown || m_responseReceived; });
return m_sendMessageStatus;
}
void WaitableMessageRequest::shutdown() {
std::lock_guard<std::mutex> lock{m_requestMutex};
m_isRequestShuttingDown = true;
m_sendMessageStatus = MessageRequestObserverInterface::Status::CANCELED;
m_requestCv.notify_one();
}
} // namespace avs
} // namespace avsCommon
} // namespace alexaClientSDK