File: SpanEvent.h

package info (click to toggle)
thunderbird 1%3A143.0.1-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 4,703,968 kB
  • sloc: cpp: 7,770,492; javascript: 5,943,842; ansic: 3,918,754; python: 1,418,263; xml: 653,354; asm: 474,045; java: 183,079; sh: 111,238; makefile: 20,410; perl: 14,359; objc: 13,059; yacc: 4,583; pascal: 3,405; lex: 1,720; ruby: 999; exp: 762; sql: 715; awk: 580; php: 436; lisp: 430; sed: 69; csh: 10
file content (70 lines) | stat: -rw-r--r-- 2,148 bytes parent folder | download | duplicates (3)
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
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */

#ifndef GECKO_TRACE_SPAN_EVENT_H
#define GECKO_TRACE_SPAN_EVENT_H

#include "nsVariant.h"

namespace mozilla::gecko_trace {

using string_view = std::string_view;

// TODO: Support Span types in AttributeValue
using AttributeValue = Variant<bool, int64_t, string_view
                               // ,Span<bool>,
                               // Span<int64_t>,
                               // Span<string_view>
                               >;

// Note: Consider adding a mechanism to prevent manual implementation of
// this interface for types.
class SpanEvent {
 public:
  virtual ~SpanEvent() = default;

  /**
   * Iterate over all key-value pairs in this event.
   *
   * Calls the provided callback function for each attribute set on this event
   * instance. The iteration includes attributes from parent classes if this
   * event inherits from other events.
   *
   * @param aCallback Function to call for each key-value pair.
   *                  Should return true to continue iteration, false to stop.
   * @return true if all callbacks returned true, false if any returned false
   */
  virtual bool ForEachKeyValue(
      std::function<bool(string_view, AttributeValue)> aCallback) const = 0;

  /**
   * Get the name identifier for this trace event.
   *
   * Returns the string identifier used to categorize and filter this event
   * type in trace collection and analysis tools.
   *
   * @return String view containing the event name
   */
  virtual string_view GetEventName() const = 0;

  /**
   * Get the total number of attributes this event can contain.
   *
   * Returns the count of all possible attributes, including those inherited
   * from parent event classes.
   *
   * @return Total attribute count
   */
  virtual size_t Size() const = 0;

#ifdef GECKO_TRACE_ENABLE
  void Emit();
#else
  constexpr void Emit() {};
#endif
};

}  // namespace mozilla::gecko_trace

#endif  // GECKO_TRACE_SPAN_EVENT_H