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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
// Copyright 2018 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_WEB_APPLICATIONS_LOCKS_PARTITIONED_LOCK_H_
#define CHROME_BROWSER_WEB_APPLICATIONS_LOCKS_PARTITIONED_LOCK_H_
#include <iosfwd>
#include "base/functional/callback.h"
#include "chrome/browser/web_applications/locks/partitioned_lock_id.h"
namespace web_app {
// Represents a granted lock by the PartitionedLockManager. When this object is
// destroyed, the lock is released. Since default construction is supported,
// |is_locked()| can be used to inquire locked status. Also, |Release()| can
// be called to manually release the lock, which appropriately updates the
// |is_locked()| result.
class PartitionedLock {
public:
using LockReleasedCallback =
base::OnceCallback<void(PartitionedLockId lock_id)>;
PartitionedLock();
PartitionedLock(const PartitionedLock&) = delete;
PartitionedLock& operator=(const PartitionedLock&) = delete;
~PartitionedLock();
PartitionedLock(PartitionedLock&&) noexcept;
// |lock_released_callback| is called when the lock is released, either by
// destruction of this object or by the |Released()| call. It will be called
// synchronously on the sequence runner this lock is released on.
PartitionedLock(PartitionedLockId lock_id,
LockReleasedCallback lock_released_callback);
// The lock in |other| is not released, and |this| must not be holding a lock.
PartitionedLock& operator=(PartitionedLock&& other) noexcept;
// Returns true if this object is holding a lock.
bool is_locked() const { return !lock_released_callback_.is_null(); }
// Explicitly releases the granted lock.
//
// The lock is also released implicitly when this instance is destroyed.
// This method is idempotent, i.e. it's valid to call Release() on an
// instance that does not hold a granted lock.
void Release();
const PartitionedLockId& lock_id() const { return lock_id_; }
private:
PartitionedLockId lock_id_;
// Closure to run when the lock is released. The lock is held when this is
// non-null.
LockReleasedCallback lock_released_callback_;
};
// Logging support.
std::ostream& operator<<(std::ostream& out, const PartitionedLock& lock_id);
// Equality doesn't take into account whether the lock 'is_locked()' or not,
// only the partition and the lock_id.
bool operator==(const PartitionedLock& x, const PartitionedLock& y);
// Comparison operator to allow sorting for locking / unlocking order.
bool operator<(const PartitionedLock& x, const PartitionedLock& y);
} // namespace web_app
#endif // CHROME_BROWSER_WEB_APPLICATIONS_LOCKS_PARTITIONED_LOCK_H_
|
