Saltar para o conteúdo principal
Versão: 20 R9 BETA

WebSocketConnection

A API da classe WebSocketConnection permite que você gerencie conexões WebSocket, uma vez estabelecida usando a classe WebSocketServer.

info

Para obter uma visão geral e alguns exemplos da implementação do servidor WebSocket em 4D, consulte a classe WebSocketServer.

História
ReleaseMudanças
20Adicionado

Objecto WebSocketConnection

Um objeto WebSocketConnection é criado automaticamente quando a função de retorno de chamada WSHandler.onConnection do objeto WebSocketServer retorna um objeto connectionHandler.

Os objectos Httprequest fornecem as seguintes propriedades e funções:

.handler : Object
o acessório que obtém o objeto connectionHandler usado para iniciar a conexão
.id : Integer
o identificador único da conexão
.send( message : Text )
.send( message : Blob )
.send( message : Object )

envia uma message para o cliente
.status : Text
o status da conexão (pode ser "Closing", "Closed" ou "Connected")
.terminate( { code : Integer ; message : Text } )
força a conexão a fechar
.wss : 4D.WebSocketServer
o objeto pai WebSocketServer da conexão

.handler

.handler : Object

Descrição

A propriedade .handler contém o acessório que obtém o objeto connectionHandler usado para iniciar a conexão.

.id

.id : Integer

Descrição

A propriedade .id contém o identificador único da conexão.

Esta propriedade é só de leitura.

.send()

.send( message : Text )
.send( message : Blob )
.send( message : Object )

ParâmetroTipoDescrição
messageText / Blob / Object->A mensagem a enviar

Descrição

A função .send() envia uma message para o cliente.

Os conteúdos seguintes são enviados em função do tipo de message:

TipoConteúdo
TextTexto em UTF-8
BlobDados binários
ObjectTexto em JSON UTF-8 (o mesmo resultado que com JSON Stringify)

.status

.status : Text

Descrição

A propriedade .status contém o status da conexão (pode ser "Closing", "Closed" ou "Connected").

Esta propriedade é só de leitura.

.terminate()

.terminate( { code : Integer ; message : Text } )

ParâmetroTipoDescrição
codeInteger->Código de erro enviado ao cliente (deve ser > 3000, caso contrário a mensagem não é enviada)
messageText->Mensagem de erro enviada ao cliente

Descrição

A função .terminate() força a conexão a fechar.

Um code e uma message podem ser enviados ao cliente durante o encerramento para indicar o motivo da rescisão.

.wss

.wss : 4D.WebSocketServer

Descrição

A propriedade .wss contém o objeto pai WebSocketServer da conexão.

Esta propriedade é só de leitura.