OLD | NEW |
---|---|
1 # Dart VM Service Protocol 3.3 | 1 # Dart VM Service Protocol 3.3 |
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.3_ of the Dart VM Service Protocol. This | 5 This document describes of _version 3.3_ 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 754 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
765 | 765 |
766 The _streamId_ parameter may have the following published values: | 766 The _streamId_ parameter may have the following published values: |
767 | 767 |
768 streamId | event types provided | 768 streamId | event types provided |
769 -------- | ----------- | 769 -------- | ----------- |
770 VM | VMUpdate | 770 VM | VMUpdate |
771 Isolate | IsolateStart, IsolateRunnable, IsolateExit, IsolateUpdate, ServiceExte nsionAdded | 771 Isolate | IsolateStart, IsolateRunnable, IsolateExit, IsolateUpdate, ServiceExte nsionAdded |
772 Debug | PauseStart, PauseExit, PauseBreakpoint, PauseInterrupted, PauseException , Resume, BreakpointAdded, BreakpointResolved, BreakpointRemoved, Inspect | 772 Debug | PauseStart, PauseExit, PauseBreakpoint, PauseInterrupted, PauseException , Resume, BreakpointAdded, BreakpointResolved, BreakpointRemoved, Inspect |
773 GC | GC | 773 GC | GC |
774 Extension | Extension | 774 Extension | Extension |
775 Timeline | TimelineEvents | |
775 | 776 |
776 Additionally, some embedders provide the _Stdout_ and _Stderr_ | 777 Additionally, some embedders provide the _Stdout_ and _Stderr_ |
777 streams. These streams allow the client to subscribe to writes to | 778 streams. These streams allow the client to subscribe to writes to |
778 stdout and stderr. | 779 stdout and stderr. |
779 | 780 |
780 streamId | event types provided | 781 streamId | event types provided |
781 -------- | ----------- | 782 -------- | ----------- |
782 Stdout | WriteEvent | 783 Stdout | WriteEvent |
783 Stderr | WriteEvent | 784 Stderr | WriteEvent |
784 | 785 |
(...skipping 334 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
1119 InternalError, | 1120 InternalError, |
1120 | 1121 |
1121 // The isolate has been terminated by an external source. | 1122 // The isolate has been terminated by an external source. |
1122 TerminationError | 1123 TerminationError |
1123 } | 1124 } |
1124 ``` | 1125 ``` |
1125 | 1126 |
1126 ### Event | 1127 ### Event |
1127 | 1128 |
1128 ``` | 1129 ``` |
1129 class Event extends Response { | 1130 class Event extends Response { |
turnidge
2016/03/03 19:18:16
Document the timelineEvents property here...
Cutch
2016/03/03 19:43:25
Done.
| |
1130 // What kind of event is this? | 1131 // What kind of event is this? |
1131 EventKind kind; | 1132 EventKind kind; |
1132 | 1133 |
1133 // The isolate with which this event is associated. | 1134 // The isolate with which this event is associated. |
1134 // | 1135 // |
1135 // This is provided for all event kinds except for: | 1136 // This is provided for all event kinds except for: |
1136 // VMUpdate | 1137 // VMUpdate |
1137 @Isolate isolate [optional]; | 1138 @Isolate isolate [optional]; |
1138 | 1139 |
1139 // The vm with which this event is associated. | 1140 // The vm with which this event is associated. |
(...skipping 143 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
1283 // A garbage collection event. | 1284 // A garbage collection event. |
1284 GC, | 1285 GC, |
1285 | 1286 |
1286 // Notification of bytes written, for example, to stdout/stderr. | 1287 // Notification of bytes written, for example, to stdout/stderr. |
1287 WriteEvent, | 1288 WriteEvent, |
1288 | 1289 |
1289 // Notification from dart:developer.inspect. | 1290 // Notification from dart:developer.inspect. |
1290 Inspect, | 1291 Inspect, |
1291 | 1292 |
1292 // Event from dart:developer.postEvent. | 1293 // Event from dart:developer.postEvent. |
1293 Extension | 1294 Extension |
turnidge
2016/03/03 19:18:16
Add TimelineEvents here too?
The name TimelineEve
Cutch
2016/03/03 19:43:25
Stuck with TimelineEvents.
| |
1294 } | 1295 } |
1295 ``` | 1296 ``` |
1296 | 1297 |
1297 Adding new values to _EventKind_ is considered a backwards compatible | 1298 Adding new values to _EventKind_ is considered a backwards compatible |
1298 change. Clients should ignore unrecognized events. | 1299 change. Clients should ignore unrecognized events. |
1299 | 1300 |
1300 ### ExtensionData | 1301 ### ExtensionData |
1301 | 1302 |
1302 ``` | 1303 ``` |
1303 class ExtensionData { | 1304 class ExtensionData { |
(...skipping 1180 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
2484 version | comments | 2485 version | comments |
2485 ------- | -------- | 2486 ------- | -------- |
2486 1.0 | initial revision | 2487 1.0 | initial revision |
2487 2.0 | Describe protocol version 2.0. | 2488 2.0 | Describe protocol version 2.0. |
2488 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. | 2489 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. |
2489 3.1 | Add the getSourceReport RPC. The getObject RPC now accepts offset and cou nt for string objects. String objects now contain length, offset, and count pro perties. | 2490 3.1 | Add the getSourceReport RPC. The getObject RPC now accepts offset and cou nt for string objects. String objects now contain length, offset, and count pro perties. |
2490 3.2 | Isolate objects now include the runnable bit and many debugger related RPC s will return an error if executed on an isolate before it is runnable. | 2491 3.2 | Isolate objects now include the runnable bit and many debugger related RPC s will return an error if executed on an isolate before it is runnable. |
2491 3.3 | Pause event now indicates if the isolate is paused at an await, yield, or yield* suspension point via the 'atAsyncSuspension' field. Resume command now su pports the step parameter 'OverAsyncSuspension'. A Breakpoint added syntheticall y by an 'OverAsyncSuspension' resume command identifies itself as such via the ' isSyntheticAsyncContinuation' field. | 2492 3.3 | Pause event now indicates if the isolate is paused at an await, yield, or yield* suspension point via the 'atAsyncSuspension' field. Resume command now su pports the step parameter 'OverAsyncSuspension'. A Breakpoint added syntheticall y by an 'OverAsyncSuspension' resume command identifies itself as such via the ' isSyntheticAsyncContinuation' field. |
2492 | 2493 |
2493 [discuss-list]: https://groups.google.com/a/dartlang.org/forum/#!forum/observato ry-discuss | 2494 [discuss-list]: https://groups.google.com/a/dartlang.org/forum/#!forum/observato ry-discuss |
OLD | NEW |