OLD | NEW |
1 # Dart VM Service Protocol 0.0 | 1 # Dart VM Service Protocol 0.0 |
2 | 2 |
3 This document describes _version 0.0_ of the Dart VM Service Protocol. | 3 This document describes _version 0.0_ of the Dart VM Service Protocol. |
4 This protocol is used to communicate with a running Dart Virtual | 4 This protocol is used to communicate with a running Dart Virtual |
5 Machine. | 5 Machine. |
6 | 6 |
7 To use the Service Protocol, start the VM with the *--observe* flag. | 7 To use the Service Protocol, start the VM with the *--observe* flag. |
8 The VM will start a webserver which services protocol requests via WebSocket. | 8 The VM will start a webserver which services protocol requests via WebSocket. |
9 It is possible to make HTTP (non-WebSocket) requests, | 9 It is possible to make HTTP (non-WebSocket) requests, |
10 but this does not allow access to VM _events_ and is not documented | 10 but this does not allow access to VM _events_ and is not documented |
(...skipping 20 matching lines...) Expand all Loading... |
31 - [getFlagList](#getflaglist) | 31 - [getFlagList](#getflaglist) |
32 - [getIsolate](#getisolate) | 32 - [getIsolate](#getisolate) |
33 - [getObject](#getobject) | 33 - [getObject](#getobject) |
34 - [getStack](#getstack) | 34 - [getStack](#getstack) |
35 - [getVersion](#getversion) | 35 - [getVersion](#getversion) |
36 - [getVM](#getvm) | 36 - [getVM](#getvm) |
37 - [pause](#pause) | 37 - [pause](#pause) |
38 - [removeBreakpoint](#removebreakpoint) | 38 - [removeBreakpoint](#removebreakpoint) |
39 - [resume](#resume) | 39 - [resume](#resume) |
40 - [setName](#setname) | 40 - [setName](#setname) |
| 41 - [setLibraryDebuggable](#setlibrarydebuggable) |
41 - [streamCancel](#streamcancel) | 42 - [streamCancel](#streamcancel) |
42 - [streamListen](#streamlisten) | 43 - [streamListen](#streamlisten) |
43 - [Public Types](#public-types) | 44 - [Public Types](#public-types) |
44 - [Bool](#bool) | 45 - [Bool](#bool) |
45 - [BoundField](#boundfield) | 46 - [BoundField](#boundfield) |
46 - [BoundVariable](#boundvariable) | 47 - [BoundVariable](#boundvariable) |
47 - [Breakpoint](#breakpoint) | 48 - [Breakpoint](#breakpoint) |
48 - [Class](#class) | 49 - [Class](#class) |
49 - [ClassList](#classlist) | 50 - [ClassList](#classlist) |
50 - [Code](#code) | 51 - [Code](#code) |
(...skipping 505 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
556 | 557 |
557 ``` | 558 ``` |
558 Success setName(string isolateId, | 559 Success setName(string isolateId, |
559 string name) | 560 string name) |
560 ``` | 561 ``` |
561 | 562 |
562 The _setName_ RPC is used to change the debugging name for an isolate. | 563 The _setName_ RPC is used to change the debugging name for an isolate. |
563 | 564 |
564 See [Success](#success). | 565 See [Success](#success). |
565 | 566 |
| 567 ### setLibraryDebuggable |
| 568 |
| 569 ``` |
| 570 Success setLibraryDebuggable(string isolateId, |
| 571 string libraryId, |
| 572 bool isDebuggable) |
| 573 ``` |
| 574 |
| 575 The _setLibraryDebuggable_ RPC is used to enable or disable whether |
| 576 breakpoints and stepping work for a given library. |
| 577 |
| 578 See [Success](#success). |
| 579 |
566 ### streamCancel | 580 ### streamCancel |
567 | 581 |
568 ``` | 582 ``` |
569 Success streamCancel(string streamId) | 583 Success streamCancel(string streamId) |
570 ``` | 584 ``` |
571 | 585 |
572 The _streamCancel_ RPC cancels a stream subscription in the VM. | 586 The _streamCancel_ RPC cancels a stream subscription in the VM. |
573 | 587 |
574 If the client is not subscribed to the stream, the _102_ (Stream not | 588 If the client is not subscribed to the stream, the _102_ (Stream not |
575 subscribed) error code is returned. | 589 subscribed) error code is returned. |
(...skipping 713 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1289 _@Library_ is a reference to a _Library_. | 1303 _@Library_ is a reference to a _Library_. |
1290 | 1304 |
1291 ``` | 1305 ``` |
1292 class Library extends Object { | 1306 class Library extends Object { |
1293 // The name of this library. | 1307 // The name of this library. |
1294 string name; | 1308 string name; |
1295 | 1309 |
1296 // The uri of this library. | 1310 // The uri of this library. |
1297 string uri; | 1311 string uri; |
1298 | 1312 |
| 1313 // Is this library debuggable? Default true. |
| 1314 bool debuggable; |
| 1315 |
1299 // A list of the imports for this library. | 1316 // A list of the imports for this library. |
1300 @Library[] imports; | 1317 @Library[] imports; |
1301 | 1318 |
1302 // A list of the scripts which constitute this library. | 1319 // A list of the scripts which constitute this library. |
1303 @Script[] scripts; | 1320 @Script[] scripts; |
1304 | 1321 |
1305 // A list of the top-level variables in this library. | 1322 // A list of the top-level variables in this library. |
1306 @Field[] variables; | 1323 @Field[] variables; |
1307 | 1324 |
1308 // A list of the top-level functions in this library. | 1325 // A list of the top-level functions in this library. |
1309 @Function[] functions; | 1326 @Function[] functions; |
1310 | 1327 |
1311 // A list of all classes in this library. | 1328 // A list of all classes in this library. |
1312 @Class[] classes; | 1329 @Class[] classes; |
1313 } | 1330 } |
1314 ``` | 1331 ``` |
1315 | 1332 |
1316 A _Library_ provides information about a Dart language library. | 1333 A _Library_ provides information about a Dart language library. |
1317 | 1334 |
| 1335 See [setLibraryDebuggable](#setlibrarydebuggable). |
| 1336 |
1318 ### List | 1337 ### List |
1319 | 1338 |
1320 ``` | 1339 ``` |
1321 class @List extends @Instance { | 1340 class @List extends @Instance { |
1322 // The length of this list. | 1341 // The length of this list. |
1323 int length; | 1342 int length; |
1324 } | 1343 } |
1325 ``` | 1344 ``` |
1326 | 1345 |
1327 _@List_ is a reference to a _List_. | 1346 _@List_ is a reference to a _List_. |
(...skipping 357 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1685 // A list of isolates running in the VM. | 1704 // A list of isolates running in the VM. |
1686 @Isolate[] isolates | 1705 @Isolate[] isolates |
1687 } | 1706 } |
1688 ``` | 1707 ``` |
1689 | 1708 |
1690 ## Revision History | 1709 ## Revision History |
1691 | 1710 |
1692 version | comments | 1711 version | comments |
1693 ------- | -------- | 1712 ------- | -------- |
1694 0.0 | draft | 1713 0.0 | draft |
OLD | NEW |