WebSocket

Baseline Widely available *

This feature is well established and works across many devices and browser versions. It’s been available across browsers since ⁨julio de 2015⁩.

* Some parts of this feature may have varying levels of support.

Experimental:Esta es unatecnología experimental
Comprueba laTabla de compabilidad de navegadores cuidadosamente antes de usarla en producción.

El objeto WebSocket provee la API para la creación y administración de una conexiónWebSocketa un servidor, así como también para enviar y recibir datos en la conexión.El constructor de WebSocket acepta un parámetro requerido y otro opcional.

WebSocket WebSocket(  in DOMString url,  in optional DOMString protocols);WebSocket WebSocket(  in DOMString url,  in optional DOMString[] protocols);

url: La URL a la cual se conecta, debe ser la URL con la cual el servidor WebSocket debe responder.
protocolsOpcional: Permite cualquier caso, desde un simple protocolo o un arreglo de cadenas de texto. Estas cadenas de texto son usadas para indicar subprotocolos, en los cuales un único servidor puede implementar múltiples subprotocolos para el WebSocket (por ejemplo, tu podrías esperar que un servido gestione diferentes tipos de interacciones dependiendo de un tipo específico de protocolo). Si no especificas un subprotocolo, se asume una cadena de texto vacía.

El constructor puede levantar excepciones:

SECURITY_ERR: El puerto en el cual la conexión se realiza se encuentra bloqueado.

Revisión de Métodos

`void close(in optional unsigned long code, in optional DOMString reason);`
`void send(in DOMString data);`

Atributos

Atributo	Tipo	Descricción
`binaryType`	`DOMString`	Una cadena de texto indicando el tipo de dato binario que es transmitido por la conexión. Debe ser de cualquier manera "blob" si es se unas objetos DOM`Blob` o bien "arraybuffer"`ArrayBuffer` si se usan otro tipo de objetos
`bufferedAmount`	`unsigned long`	La cantidad de bytes de data que pueden ser almacenadas en cola utilizando llamadas asend pero que aún no se han transmitido a la red. Este valor se reestablece a cero una vez que toda la información ha sido enviada. Este valor no vuelve a cero cuando la conexión es cerrada; si mantientes llamandosend, continuará acumulandose.Solo de lectura.
`extensions`	`DOMString`	Las extensiones seleccionadas por el servidor. Esto solamente puede ser un string vacío o bien una lista de extensiones que es negociada por la conexión.
`onclose`	`EventListener`	Un monitor de eventos que atiende una llamada cuando la conexión del WebSocket cambia a un estado CERRADO (CLOSED). El monitor recibe un`CloseEvent` llamado "cerrado".
`onerror`	`EventListener`	Un monitor de eventos que es llamado cuando un error ocurre. Esto es un evento simple llamado "error"
`onmessage`	`EventListener`	Un monitor de eventos que es llamado cuando un mensaje es recibido desde un servidor. El monitor recibe un objeto`MessageEvent`llamado "mensaje".
`onopen`	`EventListener`	Un monitor de eventos que es llamado cuando el estado`readyState` de la conexión`Websocket` cambia a`OPEN`. Esto indica que la conexión está lista para enviar y recibir datos. El evento es uno simple con el nombre "open".
`protocol`	`DOMString`	Una cadena indicando el nombre del sub-protocolo que el servidor ha seleccionado. Este puede ser una de las cadenas especificadas en el parámetro`protocols` cuando se ha creado el objeto Websocket.
`readyState`	`unsigned short`	El estado actual de la conexión. Este es uno deReady state constants.Solo lectura.
`url`	`DOMString`	La URL como la resuelve el constructor. Esto siempre es una URL absoluta.Solo lectura.

Constantes

Ready state constants

Estas constantes son usadas por el atributoreadyState para describir el estado de la conexiónWebSocket.

Constante	Valor	Descripción
`CONNECTING`	`0`	La conexión no está aún abierta.
`OPEN`	`1`	La conexión está abierta y lista para comunicar.
`CLOSING`	`2`	La conexión está siendo cerrada.
`CLOSED`	`3`	La conexión está cerrada o no puede ser abierta.

Métodos

close()

Cierra la conexión o intento de conexión del WebSocket si lo hay. Si la conexión ya está cerrada, no hace nada.

void close(  in optional unsigned short code,  in optional DOMString reason);

Parámetros

codeOpcional: Un valor numérico indicando el código de estado que explica porqué la conexión está siendo cerrada. Si no se especifica este parámetro, se asume un valor por defecto de 1000 (que indica un cierre normal por "transacción completa") . Vercódigos de estado en la página deCloseEvent para la lista de valores permitidos.
reasonOpcional: Una cadena legible explicando porqué la conexión está siendo cerrada. Esta cadena no puede ser mayor que 123 bytes de texto UTF-8 (no caracteres)

Exceptions thrown

INVALID_ACCESS_ERR: Se ha especificado un código erróneo.
SYNTAX_ERR: Lareason cadena es demasiado larga o continene caracteres no validos.

Nota:En Gecko, este método no soporta ningun parámetro antes de Gecko 8.0 (Firefox 8.0 / Thunderbird 8.0 / SeaMonkey 2.5).

send()

Transmite datos al servidor sobre la conexión WebSocket.

void send(  in DOMString data);void send(  in ArrayBuffer data);void send(  in Blob data);

Parametros

data: Una cadena de texto que enviar al servidor.

Excepciones

INVALID_STATE_ERR: La conexión no está abierta en este momento.
SYNTAX_ERR: La data tiene caracteres no válidos que no se pueden decodificar.

Nota:La implementación del métodosend() en el motor de renderizado Gecko puede cambiar de la especificación en Gecko 6.0; Gecko devuelve unboolean indicando si la conexión esta todavía abierta (y, por extensión, que los datos son encolados o trasmitidos satisfactoriamente). Esto ha sido corregido en Gecko 8.0.

A partir de Gecko 11.0, implementaArrayBuffer pero no tipos de datosBlob.

Ejemplo

// Crea una nueva conexión.const socket = new WebSocket("ws://localhost:8080");// Abre la conexiónsocket.addEventListener("open", function (event) {  socket.send("Hello Server!");});// Escucha por mensajessocket.addEventListener("message", function (event) {  console.log("Message from server", event.data);});