MessageRequestHandler.h

Go to the documentation of this file.

/*
 * 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.
 */

#ifndef ALEXA_CLIENT_SDK_ACL_INCLUDE_ACL_TRANSPORT_MESSAGEREQUESTHANDLER_H_
#define ALEXA_CLIENT_SDK_ACL_INCLUDE_ACL_TRANSPORT_MESSAGEREQUESTHANDLER_H_

#include <memory>

#include <AVSCommon/AVS/Attachment/AttachmentManagerInterface.h>
#include <AVSCommon/AVS/MessageRequest.h>
#include <AVSCommon/SDKInterfaces/EventTracerInterface.h>
#include <AVSCommon/SDKInterfaces/MessageRequestObserverInterface.h>
#include <AVSCommon/Utils/Power/PowerResource.h>
#include <AVSCommon/Utils/HTTP2/HTTP2MimeRequestSourceInterface.h>
#include <AVSCommon/Utils/Metrics/MetricRecorderInterface.h>

#include "ACL/Transport/ExchangeHandler.h"
#include "ACL/Transport/MessageConsumerInterface.h"
#include "ACL/Transport/MimeResponseStatusHandlerInterface.h"

namespace alexaClientSDK {
namespace acl {

class MessageRequestHandler
        : public ExchangeHandler
        , public avsCommon::utils::http2::HTTP2MimeRequestSourceInterface
        , public MimeResponseStatusHandlerInterface
        , public std::enable_shared_from_this<MessageRequestHandler> {
public:
    ~MessageRequestHandler() override;

    static std::shared_ptr<MessageRequestHandler> create(
        std::shared_ptr<ExchangeHandlerContextInterface> context,
        const std::string& authToken,
        std::shared_ptr<avsCommon::avs::MessageRequest> messageRequest,
        std::shared_ptr<MessageConsumerInterface> messageConsumer,
        std::shared_ptr<avsCommon::avs::attachment::AttachmentManagerInterface> attachmentManager,
        std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> metricRecorder,
        std::shared_ptr<avsCommon::sdkInterfaces::EventTracerInterface> eventTracer = nullptr,
        const std::shared_ptr<avsCommon::utils::power::PowerResource>& powerResource = nullptr);

    avsCommon::utils::http2::HTTP2GetMimeHeadersResult getMimePartHeaderLines() override;
    std::vector<std::string> getRequestHeaderLines() override;
    avsCommon::utils::http2::HTTP2SendDataResult onSendMimePartData(char* bytes, size_t size) override;

    void onActivity() override;
    bool onReceiveResponseCode(long responseCode) override;
    void onResponseFinished(avsCommon::utils::http2::HTTP2ResponseFinishedStatus status, const std::string& nonMimeBody)
        override;
private:
    MessageRequestHandler(
        std::shared_ptr<ExchangeHandlerContextInterface> context,
        const std::string& authToken,
        std::shared_ptr<avsCommon::avs::MessageRequest> messageRequest,
        std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> metricRecorder,
        const std::shared_ptr<avsCommon::utils::power::PowerResource>& powerResource);

    void reportMessageRequestAcknowledged();

    void reportMessageRequestFinished();

    void recordStreamMetric(std::size_t bytes);

    void recordStartOfEventMetric();

    std::shared_ptr<avsCommon::avs::MessageRequest> m_messageRequest;

    std::string m_json;

    const char* m_jsonNext;

    size_t m_countOfJsonBytesLeft;

    size_t m_countOfPartsSent;

    std::shared_ptr<avsCommon::avs::MessageRequest::NamedReader> m_namedReader;

    std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> m_metricRecorder;

    bool m_wasMessageRequestAcknowledgeReported;

    bool m_wasMessageRequestFinishedReported;

    long m_responseCode;

    std::shared_ptr<avsCommon::utils::power::PowerResource> m_powerResource;

    avsCommon::sdkInterfaces::MessageRequestObserverInterface::Status m_resultStatus;

    std::size_t m_streamBytesRead;

    bool m_recordedStreamMetric;
};

}  // namespace acl
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_ACL_INCLUDE_ACL_TRANSPORT_MESSAGEREQUESTHANDLER_H_