nginstack

Class: WebSocket

@nginstack/engine/lib/net/WebSocket~ WebSocket

new WebSocket(origin)

Fornece uma interface que permite às aplicações que atuem como clientes numa conexão WebSocket. A versão do protocolo utilizada é a versão 13(RFC 6455).

Parameters:
Name Type Description
origin string

A origem do cliente, como especificado na RFC 6454(não obrigatório para clientes que não são browsers)

Members

lastError :string

Descrição do último erro ocorrido Propriedade ReadOnly

Type:
  • string

Methods

close(code, reason)

Fecha a conexão graciosamente, esvaziando antes o buffer de escrita do socket.

Parameters:
Name Type Description
code number

Código de fechamento, conforme descrito em rfc6455
reason string

Texto descritivo do motivo do fechamento

open(url [, timeout])

Abre uma conexão

Parameters:
Name Type Argument Description
url string

Endereço de rede do servidor, contendo o prefixo ws://, indicativo de uso do protocolo WebSocket
timeout number <optional>

Número máximo de milisegundos para se estabelecer a conexão
Returns:

Retorna true se a conexão foi estabelecida com sucesso

Type
boolean

ping(payload [, timeout])

Envia uma mensagem Ping, indicando que a conexão ainda está ativa e aguarda um Pong de confirmação

Parameters:
Name Type Argument Description
payload string | ArrayBuffer

Dado enviado na mensagem, sendo limitado a 125 bytes
timeout number <optional>

Limite máximo em segundos para completar o envio e recepção da confirmação
Returns:

Payload de retorno, ou Null se não houve sucesso.

Type
ArrayBuffer

receiveMessage(timeout)

Recebe uma mensagem

Parameters:
Name Type Description
timeout number

Tempo máximo em milisegundos para a recepção da mensagem
Returns:

Conteúdo que foi lido. Será uma string, caso a mensagem seja de texto, ou um objeto ArrayBuffer se a mensagem for binária. Caso não haja sucesso, será retornado Null

Type
string | ArrayBuffer

sendBinaryMessage(msg)

Envia uma mensagem binária

Parameters:
Name Type Description
msg string | ArrayBuffer

Conteúdo da mensagem. Parâmetros do tipo string são enviados como binário na codificação Latin1
Returns:

True se enviou com sucesso

Type
boolean

sendTextMessage(msg)

Envia uma mensagem de texto

Parameters:
Name Type Description
msg string

Conteúdo da mensagem
Returns:

True se enviou com sucesso

Type
boolean