diff options
| author | metamuffin <yvchraiqi@protonmail.com> | 2022-08-18 09:15:00 +0200 |
|---|---|---|
| committer | metamuffin <yvchraiqi@protonmail.com> | 2022-08-18 09:15:00 +0200 |
| commit | e8032b255edc277a69d410558ec32ff118944b16 (patch) | |
| tree | fa406e6cd7ac3a15e578a7487f2bdbc7d2f39546 | |
| parent | 5adc00cc57bc9fec072bc81a202a6784aa2307a1 (diff) | |
| download | karlender-e8032b255edc277a69d410558ec32ff118944b16.tar karlender-e8032b255edc277a69d410558ec32ff118944b16.tar.bz2 karlender-e8032b255edc277a69d410558ec32ff118944b16.tar.zst | |
Expand readme for new transport methods
| -rw-r--r-- | karld/src/interface/websocket.rs | 2 | ||||
| -rw-r--r-- | readme.md | 13 |
2 files changed, 7 insertions, 8 deletions
diff --git a/karld/src/interface/websocket.rs b/karld/src/interface/websocket.rs index e983e06..da7d918 100644 --- a/karld/src/interface/websocket.rs +++ b/karld/src/interface/websocket.rs @@ -52,7 +52,7 @@ fn handle_connection(stream: Result<TcpStream, std::io::Error>) -> anyhow::Resul } Err(tungstenite::Error::Io(e)) if let std::io::ErrorKind::WouldBlock = e.kind() => { - // its fine^ + // its fine } Err(e) => Err(e)?, } @@ -21,13 +21,12 @@ A bloated calender software. Packets with JSON-serialized instances of either `ServerboundPacket` or `ClientboundPacket` respectively as declared in ([karlcommon/protocol.d.ts](./karlcommon/protocol.d.ts)) are sent over one of the supported methods. -### Unix domain socket - -Every line is a packet. Default location for the socket is `/run/user/<uid>/karlender`. - -### Websocket - -Packets are text messages. Default bind address is `127.0.0.1:18752`. +| Transport | Note | Default location/address | +| ------------------ | -------------------------- | ---------------------------- | +| Unix domain socket | Every line is a packet. | `/run/user/<uid>/karlender`. | +| Websocket | Packets are text messages. | `127.0.0.1:18752`. | +| TCP | Every line is a packet | `127.0.0.1:18751`. | +| Stdio | Every line is a packet | stdin / stdout | ## Licence |