ProtocolTracerInterface.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_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_DIAGNOSTICS_PROTOCOLTRACERINTERFACE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_DIAGNOSTICS_PROTOCOLTRACERINTERFACE_H_

#include <AVSCommon/SDKInterfaces/EventTracerInterface.h>
#include <AVSCommon/SDKInterfaces/MessageObserverInterface.h>

namespace alexaClientSDK {
namespace avsCommon {
namespace sdkInterfaces {
namespace diagnostics {

class ProtocolTracerInterface
        : public avsCommon::sdkInterfaces::MessageObserverInterface
        , public avsCommon::sdkInterfaces::EventTracerInterface {
public:
    virtual ~ProtocolTracerInterface() = default;

    /*
     * Return the max number of messages.
     *
     * @return The max number of messages.
     */
    virtual unsigned int getMaxMessages() = 0;

    virtual bool setMaxMessages(unsigned int limit) = 0;

    virtual void setProtocolTraceFlag(bool enabled) = 0;

    virtual std::string getProtocolTrace() = 0;

    virtual void clearTracedMessages() = 0;
};

}  // namespace diagnostics
}  // namespace sdkInterfaces
}  // namespace avsCommon
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_DIAGNOSTICS_PROTOCOLTRACERINTERFACE_H_