ExchangeHandlerContextInterface.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_EXCHANGEHANDLERCONTEXTINTERFACE_H_
#define ALEXA_CLIENT_SDK_ACL_INCLUDE_ACL_TRANSPORT_EXCHANGEHANDLERCONTEXTINTERFACE_H_

#include <memory>
#include <string>

#include <AVSCommon/AVS/MessageRequest.h>
#include <AVSCommon/Utils/HTTP2/HTTP2RequestConfig.h>
#include <AVSCommon/Utils/HTTP2/HTTP2RequestInterface.h>

namespace alexaClientSDK {
namespace acl {

class ExchangeHandlerContextInterface {
public:
    virtual ~ExchangeHandlerContextInterface() = default;

    virtual void onDownchannelConnected() = 0;

    virtual void onDownchannelFinished() = 0;

    virtual void onMessageRequestSent(const std::shared_ptr<avsCommon::avs::MessageRequest>& request) = 0;

    virtual void onMessageRequestTimeout() = 0;

    virtual void onMessageRequestAcknowledged(const std::shared_ptr<avsCommon::avs::MessageRequest>& request) = 0;

    virtual void onMessageRequestFinished() = 0;

    virtual void onPingRequestAcknowledged(bool success) = 0;

    virtual void onPingTimeout() = 0;

    virtual void onActivity() = 0;

    virtual void onForbidden(const std::string& authToken = "") = 0;

    virtual std::shared_ptr<avsCommon::utils::http2::HTTP2RequestInterface> createAndSendRequest(
        const avsCommon::utils::http2::HTTP2RequestConfig& cfg) = 0;

    virtual std::string getAVSGateway() = 0;
};

}  // namespace acl
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_ACL_INCLUDE_ACL_TRANSPORT_EXCHANGEHANDLERCONTEXTINTERFACE_H_