edge/doc/apps/server-api/net.md

63 lines
1.2 KiB
Markdown
Raw Normal View History

2023-02-09 12:16:36 +01:00
# Module `net`
Ce module permet d'envoyer des messages aux clients connectés au serveur.
## Fonctions de rappel
### `onClientMessage(ctx: Context, msg: Message)`
Cette méthode est appelée pour chaque message reçu par le serveur depuis un client connecté.
> `TODO`
## Méthodes
### `net.send(ctx: string|Context, data: Object): void`
Envoie un message au client connecté au serveur.
#### Arguments
- `ctx` **string|Context** Identifiant de session du client ou contexte portant l'identifiant de session du client. Voir la documentation du module [`context`](./context.md).
- `data` **Object** Données à envoyer au client
#### Valeur de retour
Aucune
#### Usage
**Côté client**
```js
// Les données envoyées par le serveur sont accessibles
// via la propriété evt.detail.
Edge.Client.on('message', evt => console.log(evt.detail));
2023-02-09 12:16:36 +01:00
Edge.Client.connect();
2023-02-09 12:16:36 +01:00
```
**Côté serveur**
```js
function onInit() {
var ctx = context.background();
net.send(ctx, {"foo", "bar"});
}
```
### `net.broadcast(data: Object): void`
Envoie un message à l'ensemble des clients connectés au serveur.
#### Arguments
- `data` **object** Données à envoyer aux clients connectés
#### Valeur de retour
Aucune
#### Usage
Voir usage `net.send()`.