WebSocketConnection
La API de la clase WebSocketConnection te permite gestionar conexiones WebSocket, una vez establecidas usando la clase WebSocketServer.
Para una visión general y algunos ejemplos de la implementación del servidor WebSocket en 4D, por favor consulte la clase WebSocketServer class.
Historia
| Lanzamiento | Modificaciones |
|---|---|
| 20 | Añadidos |
Objeto WebSocketConnection
Un objeto WebSocketConnection se crea automáticamente cuando la función de retrollamada WSHandler.onConnection del objeto WebSocketServer devuelve un objeto connectionHandler.
Los objetos WebSocketConnection ofrecen las siguientes propiedades y funciones:
| .handler : Object el accessor que recupera el objeto connectionHandler utilizado para iniciar la conexión |
| .id : Integer el identificador único de la conexión |
| .send( message : Text ) .send( message : Blob ) .send( message : Object ) envía un message al cliente |
| .status : Text el estado de la conexión (puede ser "Closing", "Closed" o "Connected") |
| .terminate( { code : Integer ; message : Text } ) fuerza el cierre de la conexión |
| .wss : 4D.WebSocketServer el objeto padre WebSocketServer` de la conexión |
.handler
.handler : Object
Descripción
La propiedad .handler contiene el accessor que recupera el objeto connectionHandler utilizado para iniciar la conexión.
.id
.id : Integer
Descripción
La propiedad .id contiene el identificador único de la conexión.
Esta propiedad es de sólo lectura.
.send()
.send( message : Text )
.send( message : Blob )
.send( message : Object )
| Parámetros | Tipo | Descripción | |
|---|---|---|---|
| message | Text / Blob / Object | -> | El mensaje a enviar |
Descripción
La función .send() envía un message al cliente.
Los siguientes contenidos se envían en función del tipo de message:
| Tipo | Contenido |
|---|---|
| Text | Texto en UTF-8 |
| Blob | Datos binarios |
| Object | Texto en JSON UTF-8 (mismo resultado que con JSON Stringify) |
.status
.status : Text
Descripción
La propiedad .status contiene el estado de la conexión (puede ser "Closing", "Closed" o "Connected").
Esta propiedad es de sólo lectura.
.terminate()
.terminate( { code : Integer ; message : Text } )
| Parámetros | Tipo | Descripción | |
|---|---|---|---|
| code | Integer | -> | Código de error enviado al cliente (debe ser > 3000, de lo contrario el mensaje no se envía) |
| message | Text | -> | Mensaje de error enviado al cliente |
Descripción
La función .terminate() fuerza el cierre de la conexión.
Un code y un message pueden ser enviados al cliente durante el cierre para indicar la razón de la terminación.
.wss
.wss : 4D.WebSocketServer
Descripción
La propiedad .wss contiene el objeto padre WebSocketServer` de la conexión.
Esta propiedad es de sólo lectura.