summaryrefslogtreecommitdiffstats
path: root/devtools/shared/specs/performance.js
blob: 496cf9be76bbcaf0fd0be9e4311d67a545598679 (plain)
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
/* 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 http://mozilla.org/MPL/2.0/. */
"use strict";

const { Arg, RetVal, generateActorSpec } = require("devtools/shared/protocol");

const performanceSpec = generateActorSpec({
  typeName: "performance",

  /**
   * The set of events the PerformanceActor emits over RDP.
   */
  events: {
    "recording-started": {
      recording: Arg(0, "performance-recording"),
    },
    "recording-stopping": {
      recording: Arg(0, "performance-recording"),
    },
    "recording-stopped": {
      recording: Arg(0, "performance-recording"),
      data: Arg(1, "json"),
    },
    "profiler-status": {
      data: Arg(0, "json"),
    },
    "console-profile-start": {},
    "timeline-data": {
      name: Arg(0, "string"),
      data: Arg(1, "json"),
      recordings: Arg(2, "array:performance-recording"),
    },
  },

  methods: {
    connect: {
      request: { options: Arg(0, "nullable:json") },
      response: RetVal("json"),
    },

    canCurrentlyRecord: {
      request: {},
      response: { value: RetVal("json") },
    },

    startRecording: {
      request: {
        options: Arg(0, "nullable:json"),
      },
      response: {
        recording: RetVal("nullable:performance-recording"),
      },
    },

    stopRecording: {
      request: {
        options: Arg(0, "performance-recording"),
      },
      response: {
        recording: RetVal("performance-recording"),
      },
    },

    isRecording: {
      request: {},
      response: { isRecording: RetVal("boolean") },
    },

    getRecordings: {
      request: {},
      response: { recordings: RetVal("array:performance-recording") },
    },

    getConfiguration: {
      request: {},
      response: { config: RetVal("json") },
    },

    setProfilerStatusInterval: {
      request: { interval: Arg(0, "number") },
      oneway: true,
    },
  },
});

exports.performanceSpec = performanceSpec;