File: waitable_event.h

package info (click to toggle)
chromium-browser 70.0.3538.110-1~deb9u1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 1,619,476 kB
  • sloc: cpp: 13,024,755; ansic: 1,349,823; python: 916,672; xml: 314,489; java: 280,047; asm: 276,936; perl: 75,771; objc: 66,634; sh: 45,860; cs: 28,354; php: 11,064; makefile: 10,911; yacc: 9,109; tcl: 8,403; ruby: 4,065; lex: 1,779; pascal: 1,411; lisp: 1,055; awk: 41; jsp: 39; sed: 17; sql: 3
file content (90 lines) | stat: -rw-r--r-- 3,644 bytes parent folder | download
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
/*
 * Copyright (C) 2014 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef THIRD_PARTY_BLINK_RENDERER_PLATFORM_WAITABLE_EVENT_H_
#define THIRD_PARTY_BLINK_RENDERER_PLATFORM_WAITABLE_EVENT_H_

#include <memory>
#include "third_party/blink/renderer/platform/platform_export.h"
#include "third_party/blink/renderer/platform/wtf/vector.h"

namespace base {
class WaitableEvent;
};  // namespace base

namespace blink {

// DEPRECATED, use base::WaitableEvent instead of blink::WaitableEvent.
//
// Provides a thread synchronization that can be used to allow one thread to
// wait until another thread to finish some work.
// TODO(crbug.com/796799): Remove this class in favor of base::WaitableEvent.
class PLATFORM_EXPORT WaitableEvent {
 public:
  // If ResetPolicy::Manual is specified on creation, to set the event state
  // to non-signaled, a consumer must call reset().  Otherwise, the system
  // automatically resets the event state to non-signaled after a single
  // waiting thread has been released.
  enum class ResetPolicy { kAuto, kManual };

  // Specify the initial state on creation.
  enum class InitialState { kNonSignaled, kSignaled };

  explicit WaitableEvent(ResetPolicy = ResetPolicy::kAuto,
                         InitialState = InitialState::kNonSignaled);

  ~WaitableEvent();

  // Puts the event in the un-signaled state.
  void Reset();

  // Waits indefinitely for the event to be signaled.
  void Wait();

  // Puts the event in the signaled state. Causing any thread blocked on Wait
  // to be woken up. The event state is reset to non-signaled after
  // a waiting thread has been released.
  void Signal();

  // Waits on multiple events and returns the index of the object that
  // has been signaled. Any event objects given to this method must
  // not deleted while this wait is happening.
  static size_t WaitMultiple(const WTF::Vector<WaitableEvent*>& events);

 private:
  WaitableEvent(const WaitableEvent&) = delete;
  void operator=(const WaitableEvent&) = delete;

  std::unique_ptr<base::WaitableEvent> impl_;
};

}  // namespace blink

#endif  // THIRD_PARTY_BLINK_RENDERER_PLATFORM_WAITABLE_EVENT_H_