Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/premiering/wubsub

A tiny ws:// RPC server using a JSON protocol.
https://github.com/premiering/wubsub

go ipc melody pubsub rpc websocket

Last synced: 22 days ago
JSON representation

A tiny ws:// RPC server using a JSON protocol.

Host: GitHub
URL: https://github.com/premiering/wubsub
Owner: premiering
Created: 2024-07-10T16:26:18.000Z (7 months ago)
Default Branch: main
Last Pushed: 2024-08-16T19:51:50.000Z (5 months ago)
Last Synced: 2024-11-09T01:59:30.139Z (3 months ago)
Topics: go, ipc, melody, pubsub, rpc, websocket
Language: Go
Homepage:
Size: 35.2 KB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

## wubsub
wubsub is a simple RPC server built on top of websockets [using melody](https://github.com/olahol/melody) with a simple JSON protocol.

## Features
- 🤏 Small codebase for easy iteration and adaptation (currently ~400 lines)
- 👂 Single-publisher Pub/Sub support
- 🎆 Traditional RPC function calling (named `restpie` in wubsub)
- 🔒 SSL support

## Run the server
```bash
go run .
```

With TLS:
```bash
go run . --tls --keyfile server.key --certfile server.cert
```

With TLS and debug:
```bash
go run . --tls --debug --keyfile server.key --certfile server.cert
```

## Protocol
C->S indicates Client to Server.

S->C indicates Server to Client.

### General commands
#### C->S Creating a channel
```json
{
"type": "register",
"channel": "sample_channel",
"data": {
"name": "sample_channel",
"description": "Assistant chatting service",
"pubsub": {
"topics": [
"responses"
]
},
"restpie": {
"methods": [
"status",
"get-opts",
"get-opts-schema"
]
}
}
}
```

#### S->C Global, error is received from server due to receive client's action
```json
{
"type": "error",
"data": "Tried to publish to channel you aren't a publisher for."
}
```

### Pub/Sub commands
#### C->S pubsub owner publishes data
```json
{
"type": "ps-pub",
"channel": "sample_channel",
"topic": "responses",
"data": {
"text": "Why is the sky blue?"
}
}
```

#### C->S general user subscribes to pubsub
```json
{
"type": "ps-sub",
"channel": "sample_channel",
"topic": "responses"
}
```

#### S->C general user receives data from topic they subscribed to
```json
{
"type": "ps-recv",
"channel": "sample_channel",
"topic": "responses",
"data": {
"text": "Why is the sky blue?"
}
}
```

### restpie commands
The following restpie commands are shown with an example of the channel `sample_channel`, which has a restpie method/topic named `status`.

General user refers to the client that intiates the request.

Channel owner is the owner of the `sample_channel` channel.
#### C->S general user initiates request
```json
{
"type": "pie-do",
"channel": "sample_channel",
"topic": "status"
}
```

#### S->C server confirms latest sent restpie request with ID with general user
This is done to ensure ordering and to know whom a packet should be sent to when receiving the response from the publisher of the restpie

```json
{
"type": "pie-ack",
"channel": "ollama",
"topic": "status",
"reqid": "3642af4c-1bde-4dc8-9833-e4d2104c33f2"
}
```

#### S->C channel owner receives request
```json
{
"type": "pie-req",
"channel": "sample_channel",
"topic": "status",
"reqid": "3642af4c-1bde-4dc8-9833-e4d2104c33f2"
}
```

#### C->S channel owner responds to the request
```json
{
"type": "pie-resp",
"channel": "sample_channel",
"topic": "status",
"reqid": "3642af4c-1bde-4dc8-9833-e4d2104c33f2",
"data": {
"text": "Ok!",
"cpu_load": "5.2%"
}
}
```

Server will then receive this request and send the data to the general user

#### S->C general user receives response from request
```json
{
"type": "pie-recv",
"channel": "sample_channel",
"reqid": "3642af4c-1bde-4dc8-9833-e4d2104c33f2",
"topic": "status",
"data": {
"text": "Ok!",
"cpu_load": "5.2%"
}
}
```

The request is then considered complete.

## License
Uses the MIT license; do whatever you wish.