File: trace_logging_activation.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 (54 lines) | stat: -rw-r--r-- 2,238 bytes parent folder | download | duplicates (11)
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
// 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_BASE_TRACE_LOGGING_ACTIVATION_H_
#define PLATFORM_BASE_TRACE_LOGGING_ACTIVATION_H_

namespace openscreen {

class TraceLoggingPlatform;

// Start or Stop trace logging. It is illegal to call StartTracing() a second
// time without having called StopTracing() to stop the prior tracing session.
//
// Note that StopTracing() may block until all threads have returned from any
// in-progress calls into the TraceLoggingPlatform's methods.
void StartTracing(TraceLoggingPlatform* destination);
void StopTracing();

// An immutable, non-copyable and non-movable smart pointer that references the
// current trace logging destination. If tracing was active when this class was
// intantiated, the pointer is valid for the life of the instance, and can be
// used to directly invoke the methods of the TraceLoggingPlatform API. If
// tracing was not active when this class was intantiated, the pointer is null
// for the life of the instance and must not be dereferenced.
//
// An instance should be short-lived, as a platform's call to StopTracing() will
// be blocked until there are no instances remaining.
//
// NOTE: This is generally not used directly, but instead via the
// util/trace_logging macros.
class CurrentTracingDestination {
 public:
  CurrentTracingDestination();
  ~CurrentTracingDestination();

  explicit operator bool() const noexcept { return !!destination_; }
  TraceLoggingPlatform* operator->() const noexcept { return destination_; }

 private:
  CurrentTracingDestination(const CurrentTracingDestination&) = delete;
  CurrentTracingDestination(CurrentTracingDestination&&) = delete;
  CurrentTracingDestination& operator=(const CurrentTracingDestination&) =
      delete;
  CurrentTracingDestination& operator=(CurrentTracingDestination&&) = delete;

  // The destination at the time this class was constructed, and is valid for
  // the lifetime of this class. This is nullptr if tracing was inactive.
  TraceLoggingPlatform* const destination_;
};

}  // namespace openscreen

#endif  // PLATFORM_BASE_TRACE_LOGGING_ACTIVATION_H_