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 700 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
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, ServiceExte nsionAdded | 718 Isolate | IsolateStart, IsolateRunnable, IsolateExit, IsolateUpdate, ServiceExte nsionAdded |
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 |
721 Extension | Extension | |
721 | 722 |
722 Additionally, some embedders provide the _Stdout_ and _Stderr_ | 723 Additionally, some embedders provide the _Stdout_ and _Stderr_ |
723 streams. These streams allow the client to subscribe to writes to | 724 streams. These streams allow the client to subscribe to writes to |
724 stdout and stderr. | 725 stdout and stderr. |
725 | 726 |
726 streamId | event types provided | 727 streamId | event types provided |
727 -------- | ----------- | 728 -------- | ----------- |
728 Stdout | WriteEvent | 729 Stdout | WriteEvent |
729 Stderr | WriteEvent | 730 Stderr | WriteEvent |
730 | 731 |
(...skipping 404 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
1135 // This is provided for the WriteEvent event. | 1136 // This is provided for the WriteEvent event. |
1136 string bytes [optional]; | 1137 string bytes [optional]; |
1137 | 1138 |
1138 // The argument passed to dart:developer.inspect. | 1139 // The argument passed to dart:developer.inspect. |
1139 // | 1140 // |
1140 // This is provided for the Inspect event. | 1141 // This is provided for the Inspect event. |
1141 @Instance inspectee [optional]; | 1142 @Instance inspectee [optional]; |
1142 | 1143 |
1143 // The RPC name of the extension that was added. | 1144 // The RPC name of the extension that was added. |
1144 // | 1145 // |
1145 // This is provided for the ServiceExtensionAdded. | 1146 // This is provided for the ServiceExtensionAdded event. |
1146 string extensionRPC [optional]; | 1147 string extensionRPC [optional]; |
1148 | |
1149 // The extension event kind. | |
1150 // | |
1151 // This is provided for the Extension event. | |
1152 string extensionKind [optional]; | |
1153 | |
1154 // The extension event data. | |
1155 // | |
1156 // This is provided for the Extension event. | |
1157 object extensionData [optional]; | |
turnidge
2015/12/17 17:27:15
Change this to ExtensionData or something as discu
Cutch
2015/12/17 17:34:39
Added ExtensionData.
| |
1147 } | 1158 } |
1148 ``` | 1159 ``` |
1149 | 1160 |
1150 An _Event_ is an asynchronous notification from the VM. It is delivered | 1161 An _Event_ is an asynchronous notification from the VM. It is delivered |
1151 only when the client has subscribed to an event stream using the | 1162 only when the client has subscribed to an event stream using the |
1152 [streamListen](#streamListen) RPC. | 1163 [streamListen](#streamListen) RPC. |
1153 | 1164 |
1154 For more information, see [events](#events). | 1165 For more information, see [events](#events). |
1155 | 1166 |
1156 ### EventKind | 1167 ### EventKind |
(...skipping 48 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
1205 // A breakpoint has been removed. | 1216 // A breakpoint has been removed. |
1206 BreakpointRemoved, | 1217 BreakpointRemoved, |
1207 | 1218 |
1208 // A garbage collection event. | 1219 // A garbage collection event. |
1209 GC, | 1220 GC, |
1210 | 1221 |
1211 // Notification of bytes written, for example, to stdout/stderr. | 1222 // Notification of bytes written, for example, to stdout/stderr. |
1212 WriteEvent, | 1223 WriteEvent, |
1213 | 1224 |
1214 // Notification from dart:developer.inspect. | 1225 // Notification from dart:developer.inspect. |
1215 Inspect | 1226 Inspect, |
1227 | |
1228 // Event from dart:developer.postEvent. | |
1229 Extension | |
1216 } | 1230 } |
1217 ``` | 1231 ``` |
1218 | 1232 |
1219 Adding new values to _EventKind_ is considered a backwards compatible | 1233 Adding new values to _EventKind_ is considered a backwards compatible |
1220 change. Clients should ignore unrecognized events. | 1234 change. Clients should ignore unrecognized events. |
1221 | 1235 |
1222 ### Field | 1236 ### Field |
1223 | 1237 |
1224 ``` | 1238 ``` |
1225 class @Field extends @Object { | 1239 class @Field extends @Object { |
(...skipping 1063 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
2289 ## Revision History | 2303 ## Revision History |
2290 | 2304 |
2291 version | comments | 2305 version | comments |
2292 ------- | -------- | 2306 ------- | -------- |
2293 1.0 | initial revision | 2307 1.0 | initial revision |
2294 2.0 | Describe protocol version 2.0. | 2308 2.0 | Describe protocol version 2.0. |
2295 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. Added ServiceExtensionAdded event. | 2309 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. Added ServiceExtensionAdded event. |
2296 | 2310 |
2297 | 2311 |
2298 [discuss-list]: https://groups.google.com/a/dartlang.org/forum/#!forum/observato ry-discuss | 2312 [discuss-list]: https://groups.google.com/a/dartlang.org/forum/#!forum/observato ry-discuss |
OLD | NEW |