Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(709)

Unified Diff: runtime/vm/service/service.md

Issue 1257943003: Support JSON-RPC 2.0-compatible VM service events. (Closed) Base URL: git@github.com:dart-lang/sdk.git@master
Patch Set: cr Created 5 years, 5 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « runtime/vm/service.cc ('k') | no next file » | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: runtime/vm/service/service.md
diff --git a/runtime/vm/service/service.md b/runtime/vm/service/service.md
index f1c0622de4b93dab658bdaae505ac176ba395854..347f12d8f77bc953cfdd6d435cccb3e86264e8d9 100644
--- a/runtime/vm/service/service.md
+++ b/runtime/vm/service/service.md
@@ -12,10 +12,9 @@ It is possible to make HTTP (non-WebSocket) requests,
but this does not allow access to VM _events_ and is not documented
here.
-The Service Protocol is based on JSON-RPC 2.0
-(http://www.jsonrpc.org/specification). The Service Protocol has been
-extended to support pushing _events_ to the client, which is
-apparently outside the scope of the JSON-RPC specification.
+The Service Protocol uses [JSON-RPC 2.0][].
+
+[JSON-RPC 2.0]: http://www.jsonrpc.org/specification
**Table of Contents**
@@ -189,22 +188,27 @@ Each stream provides access to certain kinds of events. For example the _Isolate
access to events pertaining to isolate births, deaths, and name changes. See [streamListen](#streamlisten)
for a list of the well-known stream ids and their associated events.
-Events arrive asynchronously over the WebSocket and always have the
-_streamId_ and _event_ properties:
+Stream events arrive asynchronously over the WebSocket. They're structured as
+JSON-RPC 2.0 requests with no _id_ property. The _method_ property will be
+_streamNotify_, and the _params_ will have _streamId_ and _event_ properties:
-```
+```json
{
- "event": {
- "type": "Event",
- "kind": "IsolateExit",
- "isolate": {
- "type": "@Isolate",
- "id": "isolates/33",
- "number": "51048743613",
- "name": "worker-isolate"
+ "json-rpc": "2.0",
+ "method": "streamNotify",
+ "params": {
+ "streamId": "Isolate",
+ "event": {
+ "type": "Event",
+ "kind": "IsolateExit",
+ "isolate": {
+ "type": "@Isolate",
+ "id": "isolates/33",
+ "number": "51048743613",
+ "name": "worker-isolate"
+ }
}
}
- "streamId": "Isolate"
}
```
@@ -212,6 +216,7 @@ It is considered a _backwards compatible_ change to add a new type of event to a
Clients should be written to handle this gracefully.
+
## Types
By convention, every result and event provided by the Service Protocol
« no previous file with comments | « runtime/vm/service.cc ('k') | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698