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 751 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
762 | 762 |
763 If the client is not subscribed to the stream, the _103_ (Stream already | 763 If the client is not subscribed to the stream, the _103_ (Stream already |
764 subscribed) error code is returned. | 764 subscribed) error code is returned. |
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, None |
773 GC | GC | 773 GC | GC |
774 Extension | Extension | 774 Extension | Extension |
775 | 775 |
776 Additionally, some embedders provide the _Stdout_ and _Stderr_ | 776 Additionally, some embedders provide the _Stdout_ and _Stderr_ |
777 streams. These streams allow the client to subscribe to writes to | 777 streams. These streams allow the client to subscribe to writes to |
778 stdout and stderr. | 778 stdout and stderr. |
779 | 779 |
780 streamId | event types provided | 780 streamId | event types provided |
781 -------- | ----------- | 781 -------- | ----------- |
782 Stdout | WriteEvent | 782 Stdout | WriteEvent |
(...skipping 481 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1264 | 1264 |
1265 // An isolate has paused due to interruption via pause. | 1265 // An isolate has paused due to interruption via pause. |
1266 PauseInterrupted, | 1266 PauseInterrupted, |
1267 | 1267 |
1268 // An isolate has paused due to an exception. | 1268 // An isolate has paused due to an exception. |
1269 PauseException, | 1269 PauseException, |
1270 | 1270 |
1271 // An isolate has started or resumed execution. | 1271 // An isolate has started or resumed execution. |
1272 Resume, | 1272 Resume, |
1273 | 1273 |
| 1274 // Indicates an isolate is not yet runnable. Only appears in an Isolate's |
| 1275 // pauseEvent. Never sent over a stream. |
| 1276 None, |
| 1277 |
1274 // A breakpoint has been added for an isolate. | 1278 // A breakpoint has been added for an isolate. |
1275 BreakpointAdded, | 1279 BreakpointAdded, |
1276 | 1280 |
1277 // An unresolved breakpoint has been resolved for an isolate. | 1281 // An unresolved breakpoint has been resolved for an isolate. |
1278 BreakpointResolved, | 1282 BreakpointResolved, |
1279 | 1283 |
1280 // A breakpoint has been removed. | 1284 // A breakpoint has been removed. |
1281 BreakpointRemoved, | 1285 BreakpointRemoved, |
1282 | 1286 |
1283 // A garbage collection event. | 1287 // A garbage collection event. |
(...skipping 1200 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2484 version | comments | 2488 version | comments |
2485 ------- | -------- | 2489 ------- | -------- |
2486 1.0 | initial revision | 2490 1.0 | initial revision |
2487 2.0 | Describe protocol version 2.0. | 2491 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. | 2492 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. | 2493 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. | 2494 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. | 2495 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 | 2496 |
2493 [discuss-list]: https://groups.google.com/a/dartlang.org/forum/#!forum/observato
ry-discuss | 2497 [discuss-list]: https://groups.google.com/a/dartlang.org/forum/#!forum/observato
ry-discuss |
OLD | NEW |