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
- O tipo de dados binarios usado pela conexão.
WebSocket.bufferedAmount
Read only- O numero de bytes de dados em fila.
WebSocket.extensions
Read only- As extensões selecionadas pelo servidor.
WebSocket.onclose
- Um event listener para ser chamado quando a ligação terminar.
WebSocket.onerror
- Um event listener para ser chamado quando um erro ocorre.
WebSocket.onmessage
- Um event listener para ser chamado quando uma mensagem é recebida do servidor.
WebSocket.onopen
- Um event listener para ser chamado quando a ligação é iniciada.
WebSocket.protocol
Read only- O sub-protocolo selecionado pelo servidor.
WebSocket.readyState
Read only- O estado atual da conexão.
WebSocket.url
Read only- O URL absoluto da WebSocket.
Métodos
WebSocket.close([code[, reason]])
- Termina a conexão.
WebSocket.send(data)
- 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
- Lançado quando uma ligação com um
WebSocket
é fechada.
Também disponível através da propriedadeonclose
. error
- 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 propriedadeonerror
. message
- Lançado quando os dados são recebidos através de um
WebSocket
.
Também disponível através da propriedadeonmessage
. open
- Lançado quando uma ligação com um
WebSocket
é aberta.
Também disponível através da propriedadeonopen
.
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
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.