Saltar al contenido principal
Versión: 20

WebSocketConnection

Histórico
LanzamientoModificaciones
20Añadidos

La API de la clase WebSocketConnection permite gestionar conexiones WebSocket, una vez definidas mediante la clase WebSocketServer.

info

Para obtener una visión general y algunos ejemplos de la implementación del servidor WebSocket en 4D, consulte la clase WebSocketServer.

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 accesor que obtiene 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 *mensaje * 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 de la conexión WebSocketServer

.handler

.handler : Object

Descripción

La propiedad .handler contiene el accesor que obtiene 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ámetrosTipoDescripción
messageText / Blob / Object->El mensaje a enviar

|

Descripción

La función .send() envía un *mensaje * al cliente.

Los siguientes contenidos se envían en función del tipo de mensaje:

TipoContenido
TextTexto en UTF-8
BlobDatos binarios
ObjectTexto 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ámetrosTipoDescripción
codeInteger->Código de error enviado al cliente (debe ser > 3000, de lo contrario el mensaje no se envía)
messageText->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 de la conexión WebSocketServer.

Esta propiedad es de sólo lectura.