Objeto objeto incorporado

Objeto WebSocket

Procesador de conversión de protocolo de paquetes WebSocket

Se utiliza para convertir el protocolo Http en un mensaje de protocolo de paquete WebSocket. Creado por:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
var ws = require('ws'); var http = require('http'); var serv = new http.Server(8811, ws.upgrade((conn) => { conn.onmessage = msg => { conn.send(new Date()); }; })); serv.run(r => 0); var sock = new ws.Socket('ws://127.0.0.1:8811'); sock.on('open', () => { setInterval(() => { sock.send('get date'); }, 1000); }); sock.onmessage = evt => { console.log(evt.data); }

Herencia

Constructor

WebSocket

Constructor WebSocket

1 2 3
new WebSocket(String url, String protocol = "", String origin = "");

Parámetros de llamada:

  • url : String, especifique el servidor al que conectarse
  • protocol : String, especifica el protocolo de protocolo de enlace, el valor predeterminado es ""
  • origin : String, especifique el origin de la simulación durante el protocolo de enlace, el valor predeterminado es ""

Constructor WebSocket

1 2
new WebSocket(String url, Object opts = {});

Parámetros de llamada:

  • url : String, especifique el servidor al que conectarse
  • opts : Objeto, opción de conexión, el valor predeterminado es {}, los campos admitidos son "protocolo", "origen", "encabezados", "httpClient".

Propiedad estática

defaultMaxListeners

Entero, el número máximo global predeterminado de oyentes

1
static Integer WebSocket.defaultMaxListeners;

Atributos del miembro

url

Cadena, consulta el servidor conectado al objeto actual

1
readonly String WebSocket.url;

protocol

Cadena, consulta el protocolo cuando el objeto actual está conectado

1
readonly String WebSocket.protocol;

origin

Cadena, consulta el origen de la conexión del objeto actual

1
readonly String WebSocket.origin;

readyState

Entero, consulte el estado de la conexión del objeto actual, vea ws

1
readonly Integer WebSocket.readyState;

onopen

Evento de éxito de conexión de función, consulta y enlace, equivalente a on ("abierto", func);

1
Function WebSocket.onopen;

onmessage

Función, consulta y enlace del evento recibido por la otra parte, equivalente a on ("mensaje", func);

1
Function WebSocket.onmessage;

onclose

Evento de cierre de conexión de función, consulta y enlace, equivalente a on ("close", func);

1
Function WebSocket.onclose;

onerror

Función, consulta y enlace del evento del error, equivalente a on ("error", func);

1
Function WebSocket.onerror;

Función miembro

close

Cierre la conexión actual. Esta operación enviará un paquete CERRAR a la otra parte y esperará a que la otra parte responda.

1 2
WebSocket.close(Integer code = 1000, String reason = "");

Parámetros de llamada:

  • code : entero, especifique el código para cerrar
  • reason : String, especifique el motivo del cierre, el valor predeterminado es ""

send

Enviar un mensaje de texto a la otra parte

1
WebSocket.send(String data);

Parámetros de llamada:

  • data : String, especifica el texto a enviar

Enviar un dato binario a la otra parte

1
WebSocket.send(Buffer data);

Parámetros de llamada:

  • data : Buffer , especifique los datos binarios para enviar

ref

Evite que el proceso fibjs salga y evite que el proceso fibjs salga durante la unión del objeto

1
WebSocket WebSocket.ref();

Devuelve el resultado:

  • WebSocket , devuelve el objeto actual

unref

Permita que el proceso fibjs salga, permita que el proceso fibjs salga durante el enlace del objeto

1
WebSocket WebSocket.unref();

Devuelve el resultado:

  • WebSocket , devuelve el objeto actual

on

Vincula un controlador de eventos a un objeto

1 2
Object WebSocket.on(String ev, Function func);

Parámetros de llamada:

  • ev : String, el nombre del evento especificado
  • func : Function, especifica la función del controlador de eventos

Devuelve el resultado:

  • Object , devuelve el número de enlaces exitosos, o 0 si la función está enlazada

Vincula un controlador de eventos a un objeto

1
Object WebSocket.on(Object map);

Parámetros de llamada:

  • map : Object, especifica la relación de mapeo de eventos, el nombre de la propiedad del objeto se usará como el nombre del evento y el valor de la propiedad se usará como el controlador de eventos

Devuelve el resultado:

  • Object , devuelve el objeto de evento en sí, lo cual es conveniente para llamadas encadenadas

addListener

Vincula un controlador de eventos a un objeto

1 2
Object WebSocket.addListener(String ev, Function func);

Parámetros de llamada:

  • ev : String, el nombre del evento especificado
  • func : Function, especifica la función del controlador de eventos

Devuelve el resultado:

  • Object , devuelve el objeto de evento en sí, lo cual es conveniente para llamadas encadenadas

Vincula un controlador de eventos a un objeto

1
Object WebSocket.addListener(Object map);

Parámetros de llamada:

  • map : Object, especifica la relación de mapeo de eventos, el nombre de la propiedad del objeto se usará como el nombre del evento y el valor de la propiedad se usará como el controlador de eventos

Devuelve el resultado:

  • Object , devuelve el objeto de evento en sí, lo cual es conveniente para llamadas encadenadas

prependListener

Vincula un controlador de eventos al inicio del objeto

1 2
Object WebSocket.prependListener(String ev, Function func);

Parámetros de llamada:

  • ev : String, el nombre del evento especificado
  • func : Function, especifica la función del controlador de eventos

Devuelve el resultado:

  • Object , devuelve el número de enlaces exitosos, o 0 si la función está enlazada

Vincula un controlador de eventos al inicio del objeto

1
Object WebSocket.prependListener(Object map);

Parámetros de llamada:

  • map : Object, especifica la relación de mapeo de eventos, el nombre de la propiedad del objeto se usará como el nombre del evento y el valor de la propiedad se usará como el controlador de eventos

Devuelve el resultado:

  • Object , devuelve el número de enlaces exitosos, o 0 si la función está enlazada

once

Enlace un controlador de eventos de una sola vez al objeto. El controlador de una sola vez solo se disparará una vez.

1 2
Object WebSocket.once(String ev, Function func);

Parámetros de llamada:

  • ev : String, el nombre del evento especificado
  • func : Function, especifica la función del controlador de eventos

Devuelve el resultado:

  • Object , devuelve el objeto de evento en sí, lo cual es conveniente para llamadas encadenadas

Enlace un controlador de eventos de una sola vez al objeto. El controlador de una sola vez solo se disparará una vez.

1
Object WebSocket.once(Object map);

Parámetros de llamada:

  • map : Object, especifica la relación de mapeo de eventos, el nombre de la propiedad del objeto se usará como el nombre del evento y el valor de la propiedad se usará como el controlador de eventos

Devuelve el resultado:

  • Object , devuelve el objeto de evento en sí, lo cual es conveniente para llamadas encadenadas

prependOnceListener

Vincula un controlador de eventos al inicio del objeto

1 2
Object WebSocket.prependOnceListener(String ev, Function func);

Parámetros de llamada:

  • ev : String, el nombre del evento especificado
  • func : Function, especifica la función del controlador de eventos

Devuelve el resultado:

  • Object , devuelve el número de enlaces exitosos, o 0 si la función está enlazada

Vincula un controlador de eventos al inicio del objeto

1
Object WebSocket.prependOnceListener(Object map);

Parámetros de llamada:

  • map : Object, especifica la relación de mapeo de eventos, el nombre de la propiedad del objeto se usará como el nombre del evento y el valor de la propiedad se usará como el controlador de eventos

Devuelve el resultado:

  • Object , devuelve el número de enlaces exitosos, o 0 si la función está enlazada

off

Función no especificada de la cola de procesamiento de objetos

1 2
Object WebSocket.off(String ev, Function func);

Parámetros de llamada:

  • ev : String, el nombre del evento especificado
  • func : Function, especifica la función del controlador de eventos

Devuelve el resultado:

  • Object , devuelve el objeto de evento en sí, lo cual es conveniente para llamadas encadenadas

Cancelar todas las funciones en la cola de procesamiento de objetos

1
Object WebSocket.off(String ev);

Parámetros de llamada:

  • ev : String, el nombre del evento especificado

Devuelve el resultado:

  • Object , devuelve el objeto de evento en sí, lo cual es conveniente para llamadas encadenadas

Función no especificada de la cola de procesamiento de objetos

1
Object WebSocket.off(Object map);

Parámetros de llamada:

  • map : Object, especifica la relación de mapeo de eventos, el nombre de la propiedad del objeto se usa como el nombre del evento y el valor de la propiedad se usa como la función de procesamiento de eventos

Devuelve el resultado:

  • Object , devuelve el objeto de evento en sí, lo cual es conveniente para llamadas encadenadas

removeListener

Función no especificada de la cola de procesamiento de objetos

1 2
Object WebSocket.removeListener(String ev, Function func);

Parámetros de llamada:

  • ev : String, el nombre del evento especificado
  • func : Function, especifica la función del controlador de eventos

Devuelve el resultado:

  • Object , devuelve el objeto de evento en sí, lo cual es conveniente para llamadas encadenadas

Cancelar todas las funciones en la cola de procesamiento de objetos

1
Object WebSocket.removeListener(String ev);

Parámetros de llamada:

  • ev : String, el nombre del evento especificado

Devuelve el resultado:

  • Object , devuelve el objeto de evento en sí, lo cual es conveniente para llamadas encadenadas

Función no especificada de la cola de procesamiento de objetos

1
Object WebSocket.removeListener(Object map);

Parámetros de llamada:

  • map : Object, especifica la relación de mapeo de eventos, el nombre de la propiedad del objeto se usa como el nombre del evento y el valor de la propiedad se usa como la función de procesamiento de eventos

Devuelve el resultado:

  • Object , devuelve el objeto de evento en sí, lo cual es conveniente para llamadas encadenadas

removeAllListeners

Cancele todos los escuchas para todos los eventos de la cola de procesamiento de objetos. Si se especifica un evento, elimine todas las escuchas para el evento especificado.

1
Object WebSocket.removeAllListeners(Array evs = []);

Parámetros de llamada:

  • evs : matriz, especifique el nombre del evento

Devuelve el resultado:

  • Object , devuelve el objeto de evento en sí, lo cual es conveniente para llamadas encadenadas

setMaxListeners

El número límite predeterminado de oyentes, solo por compatibilidad

1
WebSocket.setMaxListeners(Integer n);

Parámetros de llamada:

  • n : entero, el número de eventos especificados

getMaxListeners

Obtenga el número límite predeterminado de oyentes, solo por compatibilidad

1
Integer WebSocket.getMaxListeners();

Devuelve el resultado:

  • Integer , devuelve el número límite predeterminado

listeners

La matriz de escucha para el evento especificado del objeto de consulta

1
Array WebSocket.listeners(String ev);

Parámetros de llamada:

  • ev : String, el nombre del evento especificado

Devuelve el resultado:

  • Array , devuelve una matriz de oyentes para el evento especificado

listenerCount

Consulta el número de oyentes para el evento especificado

1
Integer WebSocket.listenerCount(String ev);

Parámetros de llamada:

  • ev : String, el nombre del evento especificado

Devuelve el resultado:

  • Integer , devuelve el número de oyentes para el evento especificado

eventNames

Nombre del evento del oyente de consultas

1
Array WebSocket.eventNames();

Devuelve el resultado:

  • Array , devuelve una matriz de nombres de eventos

emit

Activar activamente un evento

1 2
Boolean WebSocket.emit(String ev, ...args);

Parámetros de llamada:

  • ev : String, nombre del evento
  • args : ..., los parámetros del evento se pasarán al controlador de eventos

Devuelve el resultado:

  • Boolean , devuelve el estado de activación del evento, devuelve verdadero si hay un evento de respuesta, de lo contrario devuelve falso

toString

Devuelve una representación de cadena del objeto, generalmente "[Objeto nativo]". Los objetos se pueden volver a implementar de acuerdo con sus propias características

1
String WebSocket.toString();

Devuelve el resultado:

  • String , devuelve una representación de cadena del objeto

toJSON

Devuelve una representación JSON del objeto, que generalmente devuelve una colección de propiedades legibles definidas por el objeto

1
Value WebSocket.toJSON(String key = "");

Parámetros de llamada:

  • key : cadena, sin usar

Devuelve el resultado:

  • Value , devuelve un valor que contiene un JSON serializable