File: scoped_wake_lock.h

package info (click to toggle)
android-platform-tools 34.0.5-12
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 150,900 kB
  • sloc: cpp: 805,786; java: 293,500; ansic: 128,288; xml: 127,491; python: 41,481; sh: 14,245; javascript: 9,665; cs: 3,846; asm: 2,049; makefile: 1,917; yacc: 440; awk: 368; ruby: 183; sql: 140; perl: 88; lex: 67
file content (40 lines) | stat: -rw-r--r-- 1,388 bytes parent folder | download | duplicates (10)
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
// Copyright 2019 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef PLATFORM_API_SCOPED_WAKE_LOCK_H_
#define PLATFORM_API_SCOPED_WAKE_LOCK_H_

#include <memory>

#include "platform/api/serial_delete_ptr.h"
#include "platform/api/task_runner.h"

namespace openscreen {

// Ensures that the device does not got to sleep. This is used, for example,
// while Open Screen is communicating with peers over the network for things
// like media streaming.
//
// The wake lock is RAII: It is automatically engaged when the ScopedWakeLock is
// created and released when the ScopedWakeLock is destroyed. Open Screen code
// may sometimes create multiple instances. In that case, the wake lock should
// be engaged upon creating the first instance, and then held until all
// instances have been destroyed.
class ScopedWakeLock {
 public:
  static SerialDeletePtr<ScopedWakeLock> Create(TaskRunner* task_runner);

  // Instances are not copied nor moved.
  ScopedWakeLock(const ScopedWakeLock&) = delete;
  ScopedWakeLock(ScopedWakeLock&&) = delete;
  ScopedWakeLock& operator=(const ScopedWakeLock&) = delete;
  ScopedWakeLock& operator=(ScopedWakeLock&&) = delete;

  ScopedWakeLock();
  virtual ~ScopedWakeLock();
};

}  // namespace openscreen

#endif  // PLATFORM_API_SCOPED_WAKE_LOCK_H_