Skip to content

Commit 18c1a2f

Browse files
committed
Update JSON RPC API doc
1 parent 9e7056e commit 18c1a2f

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/2022-07-18-JSON-RPC-Server-API.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
JSON RPC Server API
22
===================
33

4-
This document details the API and working of the `kore-rpc` executable. This binary has a similar CLI interface to `kore-exec` and running
4+
This document details the API and working of the `kore-rpc`, `kore-rpc-booster` and `booster-dev` executables. Running
55

66
```bash
77
kore-rpc <DEFINITION>.kore --module <MODULE> --server-port <PORT>
88
```
99

1010
will parse the `<DEFINITION>.kore` file with `<MODULE>` as the main module and then launch a JSON RPC server on port `<PORT>`.
1111

12-
The server runs over sockets and can be interacted with by sending JSON RPC messages. Note that the server listens over raw sockets and doesn't use a high(er)-level protocol like HTTP. The server sends responses as single line strings, with `\n` used as the message delimiter. The server allows for bidirectional communication and once opened, a socket connection can be maintained throughout the session. However, this is not strictly necessary as all the API functions (except for `cancel`) are pure. Also note that the server uses the `id` of the request message as the `id` of the response, which allows the client to link responses back to their requests. It is therefore important to always send a unique `id` with each request witin the current socket session.
12+
The server runs over sockets and can be interacted with by sending JSON RPC messages. Note that the server listens over raw sockets and doesn't use a high(er)-level protocol like HTTP. The server sends responses as single line strings, with `\n` used as the message delimiter. The server allows for bidirectional communication and once opened, a socket connection can be maintained throughout the session. However, this is not strictly necessary as all the API functions (except for `cancel` and `add-module`) are pure. Also note that the server uses the `id` of the request message as the `id` of the response, which allows the client to link responses back to their requests. It is therefore important to always send a unique `id` with each request witin the current socket session.
1313

1414
# API
1515

0 commit comments

Comments
 (0)