OLD | NEW |
1 // Copyright 2013 The Chromium Authors. All rights reserved. | 1 // Copyright 2013 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 // Use the <code>chrome.webrtcLoggingPrivate</code> API to control diagnostic | 5 // Use the <code>chrome.webrtcLoggingPrivate</code> API to control diagnostic |
6 // WebRTC logging. | 6 // WebRTC logging. |
7 [nodoc] namespace webrtcLoggingPrivate { | 7 [nodoc] namespace webrtcLoggingPrivate { |
| 8 dictionary MetaDataEntry { |
| 9 // The meta data entry key. |
| 10 DOMString key; |
| 11 |
| 12 // The meta data entry value. |
| 13 DOMString value; |
| 14 }; |
| 15 |
8 dictionary UploadResult { | 16 dictionary UploadResult { |
9 // The report ID for the uploaded log. Will be empty if not successful. | 17 // The report ID for the uploaded log. Will be empty if not successful. |
10 DOMString reportId; | 18 DOMString reportId; |
11 }; | 19 }; |
12 | 20 |
13 callback GenericDoneCallback = void (); | 21 callback GenericDoneCallback = void (); |
14 callback UploadDoneCallback = void (UploadResult result); | 22 callback UploadDoneCallback = void (UploadResult result); |
15 | 23 |
16 interface Functions { | 24 interface Functions { |
17 // Sets additional custom meta data that will be uploaded along with the | 25 // Sets additional custom meta data that will be uploaded along with the |
18 // log. |metaData| is a dictionary of the metadata (key, value). | 26 // log. |metaData| is a dictionary of the metadata (key, value). |
19 static void setMetaData(object metaData, GenericDoneCallback callback); | 27 static void setMetaData(MetaDataEntry[] metaData, |
| 28 GenericDoneCallback callback); |
20 | 29 |
21 // Starts logging. If logging has already been started for this render | 30 // Starts logging. If logging has already been started for this render |
22 // process, the call will be ignored. |appSessionId| is the unique session | 31 // process, the call will be ignored. |appSessionId| is the unique session |
23 // ID which will be added to the log. | 32 // ID which will be added to the log. |
24 static void start(GenericDoneCallback callback); | 33 static void start(GenericDoneCallback callback); |
25 | 34 |
26 // Sets whether the log should be uploaded automatically for the case when | 35 // Sets whether the log should be uploaded automatically for the case when |
27 // the render process goes away (tab is closed or crashes) and stop has not | 36 // the render process goes away (tab is closed or crashes) and stop has not |
28 // been called before that. If |shouldUpload| is true it will be uploaded, | 37 // been called before that. If |shouldUpload| is true it will be uploaded, |
29 // otherwise it will be discarded. The default setting is to discard it. | 38 // otherwise it will be discarded. The default setting is to discard it. |
30 static void setUploadOnRenderClose(boolean shouldUpload); | 39 static void setUploadOnRenderClose(boolean shouldUpload); |
31 | 40 |
32 // Stops logging. After stop has finished, either upload() or discard() | 41 // Stops logging. After stop has finished, either upload() or discard() |
33 // should be called, otherwise the log will be kept in memory until the | 42 // should be called, otherwise the log will be kept in memory until the |
34 // render process is closed or logging restarted. | 43 // render process is closed or logging restarted. |
35 static void stop(GenericDoneCallback callback); | 44 static void stop(GenericDoneCallback callback); |
36 | 45 |
37 // Uploads the log. Logging must be stopped before this function is called. | 46 // Uploads the log. Logging must be stopped before this function is called. |
38 static void upload(UploadDoneCallback callback); | 47 static void upload(UploadDoneCallback callback); |
39 | 48 |
40 // Discards the log. Logging must be stopped before this function is called. | 49 // Discards the log. Logging must be stopped before this function is called. |
41 static void discard(GenericDoneCallback callback); | 50 static void discard(GenericDoneCallback callback); |
42 }; | 51 }; |
43 }; | 52 }; |
OLD | NEW |