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. Método de creación:

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 conectado
  • protocol : String, especifica el protocolo de protocolo de enlace, el valor predeterminado es ""
  • origin : String, especifica el origin se simulará 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 conectado
  • opts : Objeto, opciones de conexión, el valor predeterminado es {}

opts contiene opciones adicionales solicitadas, y el contenido compatible es el siguiente:

1 2 3 4 5 6 7 8
{ "protocol": "", // 指定握手协议,缺省为空 "origin": "", // 指定握手时模拟的源,缺省为空 "perMessageDeflate": true, // 指定是否支持压缩,缺省支持 "maxPayload": 67108864, // 指定最大数据包尺寸,缺省为 67108864 "httpClient": hc, // 自定义 httpClient 对象,缺省使用全局 httpClient "headers": // 指定 http(s) 连接时携带的 header,缺省为 {}, }

Propiedades estáticas

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

Funciona, consulta y vincula el evento de recibir el mensaje de la otra parte, equivalente a on ("mensaje", func);

1
Function WebSocket.onmessage;

onclose

Funciona, consulta y enlaza el evento de conexión cerrada, equivalente a on ("close", func);

1
Function WebSocket.onclose;

onerror

Función, consulta y enlace del evento de 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 CLOSE 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, el valor permitido es 3000-4999 o 1000, el valor predeterminado es 1000
  • 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, especifique el texto enviado

Enviar un dato binario a la otra parte

1
WebSocket.send(Buffer data);

Parámetros de llamada:

  • data : Buffer , especifique los datos binarios enviados

ref

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

1
WebSocket WebSocket.ref();

Resultado devuelto:

  • WebSocket , devuelve el objeto actual

unref

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

1
WebSocket WebSocket.unref();

Resultado devuelto:

  • WebSocket , devuelve el objeto actual

on

Vincula un controlador de eventos al objeto

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

Parámetros de llamada:

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

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

Vincula un controlador de eventos al objeto

1
Object WebSocket.on(Object map);

Parámetros de llamada:

  • map : Object, especifique la relación de mapeo de eventos, el nombre de la propiedad del objeto será el nombre del evento y el valor de la propiedad será la función de procesamiento del evento

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

addListener

Vincula un controlador de eventos al objeto

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

Parámetros de llamada:

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

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

Vincula un controlador de eventos al objeto

1
Object WebSocket.addListener(Object map);

Parámetros de llamada:

  • map : Object, especifique la relación de mapeo de eventos, el nombre de la propiedad del objeto será el nombre del evento y el valor de la propiedad será la función de procesamiento del evento

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

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, especifique el nombre del evento
  • func : Function, especifica la función de procesamiento de eventos

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

Vincula un controlador de eventos al inicio del objeto

1
Object WebSocket.prependListener(Object map);

Parámetros de llamada:

  • map : Object, especifique la relación de mapeo de eventos, el nombre de la propiedad del objeto será el nombre del evento y el valor de la propiedad será la función de procesamiento del evento

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

once

Vincula una función de procesamiento de eventos de una sola vez al objeto, la función de procesamiento de una sola vez solo se activará una vez

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

Parámetros de llamada:

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

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

Vincula una función de procesamiento de eventos de una sola vez al objeto, la función de procesamiento de una sola vez solo se activará una vez

1
Object WebSocket.once(Object map);

Parámetros de llamada:

  • map : Object, especifique la relación de mapeo de eventos, el nombre de la propiedad del objeto será el nombre del evento y el valor de la propiedad será la función de procesamiento del evento

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

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, especifique el nombre del evento
  • func : Function, especifica la función de procesamiento de eventos

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

Vincula un controlador de eventos al inicio del objeto

1
Object WebSocket.prependOnceListener(Object map);

Parámetros de llamada:

  • map : Object, especifique la relación de mapeo de eventos, el nombre de la propiedad del objeto será el nombre del evento y el valor de la propiedad será la función de procesamiento del evento

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

off

Cancelar la función especificada de la cola de procesamiento de objetos

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

Parámetros de llamada:

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

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

Cancelar todas las funciones en la cola de procesamiento de objetos

1
Object WebSocket.off(String ev);

Parámetros de llamada:

  • ev : String, especifique el nombre del evento

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

Cancelar la función especificada de la cola de procesamiento de objetos

1
Object WebSocket.off(Object map);

Parámetros de llamada:

  • map : Object, especifique 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

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

removeListener

Cancelar la función especificada de la cola de procesamiento de objetos

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

Parámetros de llamada:

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

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

Cancelar todas las funciones en la cola de procesamiento de objetos

1
Object WebSocket.removeListener(String ev);

Parámetros de llamada:

  • ev : String, especifique el nombre del evento

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

Cancelar la función especificada de la cola de procesamiento de objetos

1
Object WebSocket.removeListener(Object map);

Parámetros de llamada:

  • map : Object, especifique 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

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

removeAllListeners

Cancele todos los oyentes de todos los eventos de la cola de procesamiento de objetos. Si se especifica un evento, elimine todos los oyentes del evento especificado.

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

Parámetros de llamada:

  • evs : matriz, especifique el nombre del evento

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

setMaxListeners

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

1
WebSocket.setMaxListeners(Integer n);

Parámetros de llamada:

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

getMaxListeners

Obtenga el límite predeterminado de la cantidad de oyentes, solo por compatibilidad

1
Integer WebSocket.getMaxListeners();

Resultado devuelto:

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

listeners

Matriz de oyentes para el evento especificado del objeto de consulta

1
Array WebSocket.listeners(String ev);

Parámetros de llamada:

  • ev : String, especifique el nombre del evento

Resultado devuelto:

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

listenerCount

El número de oyentes para el evento especificado del objeto de consulta

1
Integer WebSocket.listenerCount(String ev);

Parámetros de llamada:

  • ev : String, especifique el nombre del evento

Resultado devuelto:

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

eventNames

Nombre del evento del oyente de consultas

1
Array WebSocket.eventNames();

Resultado devuelto:

  • 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 : ..., parámetros de evento, que se pasarán al controlador de eventos

Resultado devuelto:

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

toString

Devuelve la representación de cadena del objeto, generalmente devuelve "[Objeto nativo]", el objeto se puede volver a implementar de acuerdo con sus propias características

1
String WebSocket.toString();

Resultado devuelto:

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

toJSON

Devuelve la representación en formato JSON del objeto, generalmente devuelve una colección de atributos legibles definidos por el objeto

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

Parámetros de llamada:

  • key : cadena, sin usar

Resultado devuelto:

  • Value , devuelve un valor que contiene JSON serializable