summaryrefslogtreecommitdiffstats
path: root/src/lib/util/unlock_guard.h
blob: 30be51486c8713d6815462d56b7bc1d16efa1712 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
// Copyright (C) 2020 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

#ifndef UNLOCK_GUARD_H
#define UNLOCK_GUARD_H

#include <boost/noncopyable.hpp>

namespace isc {
namespace util {

/// @brief Unlock Guard.
///
/// Acts as a reverse std::lock_guard.
///
/// @tparam Mutex a mutex object.
template<typename Mutex>
class UnlockGuard : public boost::noncopyable {
public:
    /// @brief Constructor.
    ///
    /// Unlock mutex object on constructor.
    ///
    /// @param lock the mutex used for unlocking and locking.
    explicit UnlockGuard(Mutex& lock) : lock_(lock) {
        lock_.unlock();
    }

    /// @brief Destructor.
    ///
    /// Lock mutex object on destructor.
    ~UnlockGuard() {
        lock_.lock();
    }

private:
    /// @brief The mutex object.
    Mutex& lock_;
};

} // namespace util
} // namespace isc

#endif // UNLOCK_GUARD_H