herocode/herodb
12
0
Fork 0
Code Issues 6 Pull Requests Actions Packages Projects Releases Wiki Activity

testing RPC over Unix socket + updated docs

Browse Source
This commit is contained in:
Maxime Van Hees
2025-10-23 15:42:05 +02:00
parent 219e612eca
commit 6ae5d6f4f9
2 changed files with 2 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/basics.md
View File

@@ -29,10 +29,8 @@ Test the IPC endpoint interactively with socat (non-HTTP transport):
```bash ```bash
sudo socat -d -d -t 5 - UNIX-CONNECT:/tmp/herodb.sock sudo socat -d -d -t 5 - UNIX-CONNECT:/tmp/herodb.sock
``` ```
Then paste a framed JSON-RPC request (Content-Length header, blank line, then JSON body). Example: Then paste a framed JSON-RPC request. Example:
``` ```
Content-Length: 73
{"jsonrpc":"2.0","method":"hero_listDatabases","params":[],"id":3} {"jsonrpc":"2.0","method":"hero_listDatabases","params":[],"id":3}
``` ```
More IPC examples are in [docs/rpc_examples.md](docs/rpc_examples.md). More IPC examples are in [docs/rpc_examples.md](docs/rpc_examples.md).

8
docs/rpc_examples.md
View File

@@ -158,10 +158,4 @@ sudo socat -d -d -t 5 - UNIX-CONNECT:/tmp/herodb.sock
2) Paste a framed JSON-RPC request (Content-Length header, then a blank line, then the JSON body). For example to call hero_listDatabases: 2) Paste a framed JSON-RPC request (Content-Length header, then a blank line, then the JSON body). For example to call hero_listDatabases:
Content-Length: <LEN-BYTES-OF-JSON> {"jsonrpc":"2.0","id":3,"method":"hero_listDatabases","params":[]}
{"jsonrpc":"2.0","id":3,"method":"hero_listDatabases","params":[]}
Notes:
- Replace <LEN-BYTES-OF-JSON> with the byte-length of the exact JSON payload you paste. There must be an empty line between the header and the JSON.
- The response will appear in the same terminal, also framed with Content-Length.