Chromium Code Reviews| OLD | NEW |
|---|---|
| 1 # Dart VM Service Protocol 3.0 | 1 # Dart VM Service Protocol 3.0 |
| 2 | 2 |
| 3 > Please post feedback to the [observatory-discuss group][discuss-list] | 3 > Please post feedback to the [observatory-discuss group][discuss-list] |
| 4 | 4 |
| 5 This document describes of _version 3.0_ of the Dart VM Service Protocol. This | 5 This document describes of _version 3.0_ of the Dart VM Service Protocol. This |
| 6 protocol is used to communicate with a running Dart Virtual Machine. | 6 protocol is used to communicate with a running Dart Virtual Machine. |
| 7 | 7 |
| 8 To use the Service Protocol, start the VM with the *--observe* flag. | 8 To use the Service Protocol, start the VM with the *--observe* flag. |
| 9 The VM will start a webserver which services protocol requests via WebSocket. | 9 The VM will start a webserver which services protocol requests via WebSocket. |
| 10 It is possible to make HTTP (non-WebSocket) requests, | 10 It is possible to make HTTP (non-WebSocket) requests, |
| (...skipping 699 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 710 If the client is not subscribed to the stream, the _103_ (Stream already | 710 If the client is not subscribed to the stream, the _103_ (Stream already |
| 711 subscribed) error code is returned. | 711 subscribed) error code is returned. |
| 712 | 712 |
| 713 The _streamId_ parameter may have the following published values: | 713 The _streamId_ parameter may have the following published values: |
| 714 | 714 |
| 715 streamId | event types provided | 715 streamId | event types provided |
| 716 -------- | ----------- | 716 -------- | ----------- |
| 717 VM | VMUpdate | 717 VM | VMUpdate |
| 718 Isolate | IsolateStart, IsolateRunnable, IsolateExit, IsolateUpdate | 718 Isolate | IsolateStart, IsolateRunnable, IsolateExit, IsolateUpdate |
| 719 Debug | PauseStart, PauseExit, PauseBreakpoint, PauseInterrupted, PauseException , Resume, BreakpointAdded, BreakpointResolved, BreakpointRemoved, Inspect | 719 Debug | PauseStart, PauseExit, PauseBreakpoint, PauseInterrupted, PauseException , Resume, BreakpointAdded, BreakpointResolved, BreakpointRemoved, Inspect |
| 720 GC | GC | 720 GC | GC |
|
turnidge
2015/11/23 23:54:40
You should add the event type here as well.
rmacnak
2015/11/24 00:55:59
It's already listed here as part of the Debug stre
| |
| 721 | 721 |
| 722 Additionally, some embedders provide the _Stdout_ and _Stderr_ | 722 Additionally, some embedders provide the _Stdout_ and _Stderr_ |
| 723 streams. These streams allow the client to subscribe to writes to | 723 streams. These streams allow the client to subscribe to writes to |
| 724 stdout and stderr. | 724 stdout and stderr. |
| 725 | 725 |
| 726 streamId | event types provided | 726 streamId | event types provided |
| 727 -------- | ----------- | 727 -------- | ----------- |
| 728 Stdout | WriteEvent | 728 Stdout | WriteEvent |
| 729 Stderr | WriteEvent | 729 Stderr | WriteEvent |
| 730 | 730 |
| (...skipping 396 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 1127 Frame topFrame [optional]; | 1127 Frame topFrame [optional]; |
| 1128 | 1128 |
| 1129 // The exception associated with this event, if this is a | 1129 // The exception associated with this event, if this is a |
| 1130 // PauseException event. | 1130 // PauseException event. |
| 1131 @Instance exception [optional]; | 1131 @Instance exception [optional]; |
| 1132 | 1132 |
| 1133 // An array of bytes, encoded as a base64 string. | 1133 // An array of bytes, encoded as a base64 string. |
| 1134 // | 1134 // |
| 1135 // This is provided for the WriteEvent event. | 1135 // This is provided for the WriteEvent event. |
| 1136 string bytes [optional]; | 1136 string bytes [optional]; |
| 1137 | |
| 1138 // The argument passed to dart:developer.inspect. | |
| 1139 // | |
| 1140 // This is provided for the Inspect event. | |
| 1141 @Instance inspectee [optional]; | |
| 1137 } | 1142 } |
| 1138 ``` | 1143 ``` |
| 1139 | 1144 |
| 1140 An _Event_ is an asynchronous notification from the VM. It is delivered | 1145 An _Event_ is an asynchronous notification from the VM. It is delivered |
| 1141 only when the client has subscribed to an event stream using the | 1146 only when the client has subscribed to an event stream using the |
| 1142 [streamListen](#streamListen) RPC. | 1147 [streamListen](#streamListen) RPC. |
| 1143 | 1148 |
| 1144 For more information, see [events](#events). | 1149 For more information, see [events](#events). |
| 1145 | 1150 |
| 1146 ### EventKind | 1151 ### EventKind |
| (...skipping 42 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 1189 // An unresolved breakpoint has been resolved for an isolate. | 1194 // An unresolved breakpoint has been resolved for an isolate. |
| 1190 BreakpointResolved, | 1195 BreakpointResolved, |
| 1191 | 1196 |
| 1192 // A breakpoint has been removed. | 1197 // A breakpoint has been removed. |
| 1193 BreakpointRemoved, | 1198 BreakpointRemoved, |
| 1194 | 1199 |
| 1195 // A garbage collection event. | 1200 // A garbage collection event. |
| 1196 GC, | 1201 GC, |
| 1197 | 1202 |
| 1198 // Notification of bytes written, for example, to stdout/stderr. | 1203 // Notification of bytes written, for example, to stdout/stderr. |
| 1199 WriteEvent | 1204 WriteEvent, |
| 1205 | |
| 1206 // Notification from dart:developer.inspect. | |
| 1207 Inspect | |
| 1200 } | 1208 } |
| 1201 ``` | 1209 ``` |
| 1202 | 1210 |
| 1203 Adding new values to _EventKind_ is considered a backwards compatible | 1211 Adding new values to _EventKind_ is considered a backwards compatible |
| 1204 change. Clients should ignore unrecognized events. | 1212 change. Clients should ignore unrecognized events. |
| 1205 | 1213 |
| 1206 ### Field | 1214 ### Field |
| 1207 | 1215 |
| 1208 ``` | 1216 ``` |
| 1209 class @Field extends @Object { | 1217 class @Field extends @Object { |
| (...skipping 1060 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 2270 ## Revision History | 2278 ## Revision History |
| 2271 | 2279 |
| 2272 version | comments | 2280 version | comments |
| 2273 ------- | -------- | 2281 ------- | -------- |
| 2274 1.0 | initial revision | 2282 1.0 | initial revision |
| 2275 2.0 | Describe protocol version 2.0. | 2283 2.0 | Describe protocol version 2.0. |
| 2276 3.0 | Describe protocol version 3.0. Added UnresolvedSourceLocation. Added Sen tinel return to getIsolate. Add AddedBreakpointWithScriptUri. Removed Isolate. entry. The type of VM.pid was changed from string to int. Added VMUpdate events . Add offset and count parameters to getObject() and offset and count fields to Instance. | 2284 3.0 | Describe protocol version 3.0. Added UnresolvedSourceLocation. Added Sen tinel return to getIsolate. Add AddedBreakpointWithScriptUri. Removed Isolate. entry. The type of VM.pid was changed from string to int. Added VMUpdate events . Add offset and count parameters to getObject() and offset and count fields to Instance. |
| 2277 | 2285 |
| 2278 | 2286 |
| 2279 [discuss-list]: https://groups.google.com/a/dartlang.org/forum/#!forum/observato ry-discuss | 2287 [discuss-list]: https://groups.google.com/a/dartlang.org/forum/#!forum/observato ry-discuss |
| OLD | NEW |