mirror/galene
1
Fork 0
mirror of https://github.com/jech/galene.git synced 2024-11-25 01:55:57 +01:00
Code Activity

Update README.FRONTEND.

Browse source
This commit is contained in:
Juliusz Chroboczek 2024-06-23 13:11:46 +02:00
parent 8fe2e9ca5f
commit 33eaa5e794
1 changed files with 14 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.FRONTEND
View file

@ -6,6 +6,8 @@ The frontend is written in JavaScript and is split into two files:
server; server;
- `galene.js` contains the user interface. - `galene.js` contains the user interface.
A simpler example client can be found in the directory `static/example`.
A new frontend may either implement Galène's client-server protocol from A new frontend may either implement Galène's client-server protocol from
scratch, or it may use the functionality of `protocol.js`. This document scratch, or it may use the functionality of `protocol.js`. This document
documents the latter approach. documents the latter approach.
@ -25,7 +27,17 @@ by the client (your frontend), streams going down are created by the server.
## Connecting to the server ## Connecting to the server
First, create a `ServerConnection` and set up all the callbacks: First, fetch the `.status` JSON at the group URL:
```javascript
let r = await fetch(url + ".status");
if(!r.ok) {
throw new Error(`${r.status} ${r.statusText}`);
}
let status = await r.json();
```
Create a `ServerConnection` and set up all the callbacks:
```javascript ```javascript
let sc = new ServerConnection() let sc = new ServerConnection()
@ -57,7 +69,7 @@ see the section below about streams.
You may now connect to the server: You may now connect to the server:
```javascript ```javascript
serverConnection.connect(`wss://${location.host}/ws`); serverConnection.connect(status.endpoint);
``` ```
You typically join a group in the `onconnected` callback: You typically join a group in the `onconnected` callback: