File: lock.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (56 lines) | stat: -rw-r--r-- 1,794 bytes parent folder | download | duplicates (6)
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
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_NAMED_SYSTEM_LOCK_LOCK_H_
#define COMPONENTS_NAMED_SYSTEM_LOCK_LOCK_H_

#include <memory>
#include <string>

#include "build/build_config.h"

#if BUILDFLAG(IS_WIN)
#include <windows.h>

#include "base/win/atl.h"
#endif

namespace base {
class TimeDelta;
}  // namespace base

namespace named_system_lock {

class ScopedLockImpl;

// ScopedLock represents a held lock. Destroying the ScopedLock releases the
// lock. ScopedLock is reentrant on Windows, but not on Mac or Linux.
class ScopedLock {
 public:
  explicit ScopedLock(std::unique_ptr<ScopedLockImpl> impl);
  ScopedLock(const ScopedLock&) = delete;
  ScopedLock& operator=(const ScopedLock&) = delete;
  ~ScopedLock();

  // Returns a ScopedLock, or nullptr if the lock could not be acquired within
  // the timeout. While the ScopedLock exists, no other process on the machine
  // may acquire that lock. The lock name has different meanings per platform:
  // Linux: A shared memory object name starting with `/`. E.g. `/MyApp.lock`.
  // Mac: A bootstrap service name (see `man bootstrap_check_in`).
#if BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_MAC)
  static std::unique_ptr<ScopedLock> Create(const std::string& name,
                                            base::TimeDelta timeout);
#elif BUILDFLAG(IS_WIN)
  static std::unique_ptr<ScopedLock> Create(const std::wstring& mutex_name,
                                            CSecurityAttributes* sa,
                                            base::TimeDelta timeout);
#endif

 private:
  std::unique_ptr<ScopedLockImpl> impl_;
};

}  // namespace named_system_lock

#endif  // COMPONENTS_NAMED_SYSTEM_LOCK_LOCK_H_