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
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 propriedade onclose.
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 propriedade onerror.
message
Lançado quando os dados são recebidos através de um WebSocket.
Também disponível através da propriedade onmessage.
open
Lançado quando uma ligação com um WebSocket é aberta.
Também disponível através da propriedade onopen.

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

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
WebSocketChrome Full support 4Edge Full support 12Firefox Full support 11
Full support 11
No support 7 — 11
Prefixed Notes
Prefixed Implemented with the vendor prefix: Moz
Notes Message size limited to 16 MB (see bug 711205).
No support 4 — 6
Notes
Notes Message size limited to 16 MB (see bug 711205).
IE Full support 10Opera Full support 12.1Safari Full support 5WebView Android Full support ≤37Chrome Android Full support 18Firefox Android Full support 14
Notes
Full support 14
Notes
Notes See bug 695635.
No support 7 — 14
Prefixed Notes
Prefixed Implemented with the vendor prefix: Moz
Notes Message size limited to 16 MB (see bug 711205).
No support 4 — 6
Notes
Notes Message size limited to 16 MB (see bug 711205).
Opera Android Full support 12.1Safari iOS Full support 4.2Samsung Internet Android Full support 1.0
WebSocket() constructorChrome Full support YesEdge Full support ≤79Firefox Full support 7
Full support 7
No support 4 — 7
Notes
Notes Parameter protocols not supported.
IE ? Opera Full support YesSafari ? WebView Android Full support YesChrome Android Full support YesFirefox Android Full support 7Opera Android ? Safari iOS ? Samsung Internet Android Full support Yes
binaryTypeChrome Full support YesEdge Full support 12Firefox Full support YesIE ? Opera Full support YesSafari Full support YesWebView Android Full support YesChrome Android Full support YesFirefox Android Full support YesOpera Android Full support YesSafari iOS Full support YesSamsung Internet Android Full support Yes
bufferedAmountChrome Full support YesEdge Full support 12Firefox Full support YesIE ? Opera Full support YesSafari Full support YesWebView Android Full support YesChrome Android Full support YesFirefox Android Full support YesOpera Android Full support YesSafari iOS Full support YesSamsung Internet Android Full support Yes
closeChrome Full support 4Edge Full support 12Firefox Full support 8
Full support 8
No support 4 — 8
Notes
Notes Parameters not supported, see bug 674716.
IE Full support 10Opera Full support 12.1Safari Full support 5WebView Android Full support ≤37Chrome Android Full support 18Firefox Android Full support 8
Full support 8
No support 4 — 8
Notes
Notes Parameters not supported, see bug 674716.
Opera Android Full support 12.1Safari iOS Full support 4.2Samsung Internet Android Full support 1.0
close eventChrome Full support YesEdge Full support 12Firefox Full support YesIE ? Opera Full support YesSafari ? WebView Android Full support YesChrome Android Full support YesFirefox Android Full support YesOpera Android ? Safari iOS ? Samsung Internet Android Full support Yes
error eventChrome Full support YesEdge Full support 12Firefox Full support YesIE ? Opera Full support YesSafari ? WebView Android Full support YesChrome Android Full support YesFirefox Android Full support YesOpera Android ? Safari iOS ? Samsung Internet Android Full support Yes
extensionsChrome Full support YesEdge Full support 12Firefox Full support 8IE ? Opera Full support YesSafari Full support YesWebView Android Full support YesChrome Android Full support YesFirefox Android Full support 8Opera Android Full support YesSafari iOS Full support YesSamsung Internet Android Full support Yes
message eventChrome Full support YesEdge Full support 12Firefox Full support YesIE ? Opera Full support YesSafari ? WebView Android Full support YesChrome Android Full support YesFirefox Android Full support YesOpera Android ? Safari iOS ? Samsung Internet Android Full support Yes
oncloseChrome Full support YesEdge Full support 12Firefox Full support YesIE ? Opera Full support YesSafari Full support YesWebView Android Full support YesChrome Android Full support YesFirefox Android Full support YesOpera Android Full support YesSafari iOS Full support YesSamsung Internet Android Full support Yes
onerrorChrome Full support YesEdge Full support 12Firefox Full support YesIE ? Opera Full support YesSafari Full support YesWebView Android Full support YesChrome Android Full support YesFirefox Android Full support YesOpera Android Full support YesSafari iOS Full support YesSamsung Internet Android Full support Yes
onmessageChrome Full support YesEdge Full support 12Firefox Full support YesIE ? Opera Full support YesSafari Full support YesWebView Android Full support YesChrome Android Full support YesFirefox Android Full support YesOpera Android Full support YesSafari iOS Full support YesSamsung Internet Android Full support Yes
onopenChrome Full support YesEdge Full support 12Firefox Full support YesIE ? Opera Full support YesSafari Full support YesWebView Android Full support YesChrome Android Full support YesFirefox Android Full support YesOpera Android Full support YesSafari iOS Full support YesSamsung Internet Android Full support Yes
open eventChrome Full support YesEdge Full support 12Firefox Full support YesIE ? Opera Full support YesSafari ? WebView Android Full support YesChrome Android Full support YesFirefox Android Full support YesOpera Android ? Safari iOS ? Samsung Internet Android Full support Yes
protocolChrome Full support YesEdge Full support 12Firefox Full support YesIE ? Opera Full support YesSafari Full support YesWebView Android Full support YesChrome Android Full support YesFirefox Android Full support YesOpera Android Full support YesSafari iOS Full support YesSamsung Internet Android Full support Yes
Supports protocol as specified by RFC 6455Chrome Full support 16Edge Full support 12Firefox Full support 11IE Full support 10Opera Full support 15Safari Full support 6WebView Android Full support YesChrome Android Full support 18Firefox Android Full support 14Opera Android Full support 14Safari iOS Full support 6Samsung Internet Android Full support 1.0
readyStateChrome Full support 43Edge Full support 12Firefox Full support 19IE Full support 10Opera Full support 30Safari Full support 10WebView Android Full support 43Chrome Android Full support 43Firefox Android Full support 19Opera Android Full support 30Safari iOS Full support 10Samsung Internet Android Full support 4.0
sendChrome Full support 4Edge Full support 12Firefox Full support 18
Notes
Full support 18
Notes
Notes See bug 775368.
No support 11 — 18
Notes
Notes Only parameter of type ArrayBuffer and String supported.
No support 8 — 11
Notes
Notes Only parameter of type String supported.
No support 4 — 8
Notes
Notes Only parameter of type String supported. Returns boolean.
IE Full support 10Opera Full support 12.1Safari Full support 5WebView Android Full support ≤37Chrome Android Full support 18Firefox Android Full support 18
Notes
Full support 18
Notes
Notes See bug 775368.
No support 14 — 18
Notes
Notes Only parameter of type ArrayBuffer and String supported.
No support 8 — 14
Notes
Notes Only parameter of type String supported.
No support 4 — 8
Notes
Notes Only parameter of type String supported. Returns boolean.
Opera Android Full support 12.1Safari iOS Full support 4.2Samsung Internet Android Full support 1.0
urlChrome Full support YesEdge Full support 12Firefox Full support YesIE ? Opera Full support YesSafari Full support YesWebView Android Full support YesChrome Android Full support YesFirefox Android Full support YesOpera Android Full support YesSafari iOS Full support YesSamsung Internet Android Full support Yes
Available in workersChrome Full support YesEdge Full support ≤18Firefox Full support 37IE ? Opera ? Safari ? WebView Android Full support YesChrome Android Full support YesFirefox Android Full support 37Opera Android ? Safari iOS ? Samsung Internet Android Full support Yes

Legend

Full support  
Full support
Compatibility unknown  
Compatibility unknown
See implementation notes.
See implementation notes.
Requires a vendor prefix or different name for use.
Requires a vendor prefix or different name for use.

Ver também