RequiresShutdown.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_UTILS_INCLUDE_AVSCOMMON_UTILS_REQUIRESSHUTDOWN_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_REQUIRESSHUTDOWN_H_

#include <atomic>
#include <memory>
#include <mutex>
#include <string>

namespace alexaClientSDK {
namespace avsCommon {
namespace utils {

class RequiresShutdown {
public:
    RequiresShutdown(const std::string& name);

    virtual ~RequiresShutdown();

    const std::string& name() const;

    void shutdown();

    bool isShutdown() const;

protected:
    virtual void doShutdown() = 0;

private:
    const std::string m_name;

    mutable std::mutex m_mutex;

    bool m_isShutdown;
};

}  // namespace utils
}  // namespace avsCommon
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_REQUIRESSHUTDOWN_H_