WebSocket

O objeto WebSocket fornece a API para criar e gerir uma ligação WebSocket a um servidor, bem como para enviar e receber dados sobre a ligação.

Para criar uma WebSocket, use o construtor WebSocket().

Constructor

WebSocket(url[, protocols])
Devolve um objeto WebSocket acabado de criar.

Constantes

Constante Valor
WebSocket.CONNECTING 0
WebSocket.OPEN 1
WebSocket.CLOSING 2
WebSocket.CLOSED 3

Propriedades

WebSocket.binaryType (en-US)
O tipo de dados binarios usado pela conexão.
WebSocket.bufferedAmount (en-US) Read only
O numero de bytes de dados em fila.
WebSocket.extensions (en-US) Read only
As extensões selecionadas pelo servidor.
WebSocket.onclose (en-US)
Um event listener para ser chamado quando a ligação terminar.
WebSocket.onerror (en-US)
Um event listener para ser chamado quando um erro ocorre.
WebSocket.onmessage (en-US)
Um event listener para ser chamado quando uma mensagem é recebida do servidor.
WebSocket.onopen (en-US)
Um event listener para ser chamado quando a ligação é iniciada.
WebSocket.protocol (en-US) Read only
O sub-protocolo selecionado pelo servidor.
WebSocket.readyState (en-US) Read only
O estado atual da conexão.
WebSocket.url (en-US) Read only
O URL absoluto da WebSocket.

Métodos

WebSocket.close([code[, reason]]) (en-US)
Termina a conexão.
WebSocket.send(data) (en-US)
Adiciona dados à fila para ser transmitida.

Eventos

Observe estes eventos usando addEventListener() ou atribuindo um agente de escuta de eventos à propriedade oneventname desta interface.

close (en-US)
Lançado quando uma ligação com um WebSocket é fechada.
Também disponível através da propriedade onclose (en-US).
error (en-US)
Lançado quando uma ligação com um WebSocket foi fechada devido a um erro, como quando alguns dados não puderam ser enviados.
Também disponível através da propriedade onerror (en-US).
message (en-US)
Lançado quando os dados são recebidos através de um WebSocket.
Também disponível através da propriedade onmessage (en-US).
open (en-US)
Lançado quando uma ligação com um WebSocket é aberta.
Também disponível através da propriedade onopen (en-US).

Exemplos

// Criar ligação WebSocket.
const socket = new WebSocket('ws://localhost:8080');

// Ligação conectada
socket.addEventListener('open', function (event) {
    socket.send('Hello Server!');
});

// Ficar a ouvir por mensagens
socket.addEventListener('message', function (event) {
    console.log('Message from server ', event.data);
});

Especificações

Especificação Estado
HTML Living Standard
The definition of 'WebSocket' in that specification.
Living Standard

Compatibilidade

BCD tables only load in the browser

Ver também