DeviceProtocolTracer.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_DIAGNOSTICS_INCLUDE_DIAGNOSTICS_DEVICEPROTOCOLTRACER_H_
#define ALEXA_CLIENT_SDK_DIAGNOSTICS_INCLUDE_DIAGNOSTICS_DEVICEPROTOCOLTRACER_H_

#include <memory>
#include <mutex>
#include <vector>

#include <AVSCommon/SDKInterfaces/Diagnostics/ProtocolTracerInterface.h>

namespace alexaClientSDK {
namespace diagnostics {

class DeviceProtocolTracer : public avsCommon::sdkInterfaces::diagnostics::ProtocolTracerInterface {
public:
    static std::shared_ptr<DeviceProtocolTracer> create();

    unsigned int getMaxMessages() override;
    bool setMaxMessages(unsigned int limit) override;
    void setProtocolTraceFlag(bool enabled) override;
    std::string getProtocolTrace() override;
    void clearTracedMessages() override;

    void traceEvent(const std::string& messageContent) override;

    void receive(const std::string& contextId, const std::string& message) override;

private:
    DeviceProtocolTracer(unsigned int maxMessages);

    void clearTracedMessagesLocked();

    void traceMessageLocked(const std::string& messageContent);

    std::mutex m_mutex;

    bool m_isProtocolTraceEnabled;

    unsigned int m_maxMessages;

    std::vector<std::string> m_tracedMessages;
};

}  // namespace diagnostics
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_DIAGNOSTICS_INCLUDE_DIAGNOSTICS_DEVICEPROTOCOLTRACER_H_