Obxecto incorporado

WebSocket de obxectos

Procesador de conversión de protocolos de paquetes WebSocket

Úsase para converter o protocolo Http en mensaxe de protocolo de paquetes 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); }

Herdanza

#lineWidth: 1.5 #font: Helvetica,sans-Serif #fontSize: 10 #leading: 1.6 #.this: fill=lightgray #.class: fill=white [<class>object|toString();toJSON()] [<class>EventEmitter|new EventEmitter()|EventEmitter|defaultMaxListeners|on();addListener();prependListener();once();prependOnceListener();off();removeListener();removeAllListeners();setMaxListeners();getMaxListeners();listeners();listenerCount();eventNames();emit()] [<this>WebSocket|new WebSocket()|url;protocol;origin;readyState;onopen;onmessage;onclose;onerror|close();send();ref();unref()] [object] <:- [EventEmitter] [EventEmitter] <:- [WebSocket] EventEmitter new EventEmitter() EventEmitter defaultMaxListeners on() addListener() prependListener() once() prependOnceListener() off() removeListener() removeAllListeners() setMaxListeners() getMaxListeners() listeners() listenerCount() eventNames() emit() WebSocket new WebSocket() url protocol origin readyState onopen onmessage onclose onerror close() send() ref() unref() object toString() toJSON()

Construtor

WebSocket

Construtor de WebSocket

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

Parámetros de chamada:

  • url: Cadea, especifica o servidor conectado
  • protocol: Cadea, especifica o protocolo de aperto de mans, o predeterminado é ""
  • origin: Cadea, especifique a fonte que se vai simular durante o aperto de mans, o predeterminado é ""

Construtor de WebSocket

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

Parámetros de chamada:

  • url: Cadea, especifica o servidor conectado
  • opts: Obxecto, opción de conexión, o predeterminado é {}

opts contén opcións adicionais solicitadas e o contido soportado é o seguinte:

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, o número máximo predeterminado global de oíntes

1
static Integer WebSocket.defaultMaxListeners;

Atributos dos membros

url

Cadea, consulta o servidor conectado ao obxecto actual

1
readonly String WebSocket.url;

protocol

Cadea, consulta o protocolo cando o obxecto actual está conectado

1
readonly String WebSocket.protocol;

origin

Cadea, consulta a fonte da conexión do obxecto actual

1
readonly String WebSocket.origin;

readyState

Entero, consulta o estado de conexión do obxecto actual, ver ws

1
readonly Integer WebSocket.readyState;

onopen

Función, consulta e evento de éxito de conexión de enlace, equivalente a activado ("aberto", func);

1
Function WebSocket.onopen;

onmessage

Funciona, consulta e vincula o evento de recibir unha mensaxe da outra parte, equivalente a on ("mensaxe", func);

1
Function WebSocket.onmessage;

onclose

Funciona, consulta e vincula o evento de peche da conexión, equivalente a on ("pechar", func);

1
Function WebSocket.onclose;

onerror

Función, consulta e sucesos de erro de vinculación, equivalentes a on ("erro", func);

1
Function WebSocket.onerror;

Función de membro

close

Peche a conexión actual, esta operación enviará un paquete PECHAR á outra parte e esperará a que a outra parte responda

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

Parámetros de chamada:

  • code: Enteiro, especifique o código para pechar, o valor permitido é 3000-4999 ou 1000, o valor predeterminado é 1000
  • reason: Cadea, especifique o motivo do peche, o predeterminado é ""

send

Envía un texto á outra parte

1
WebSocket.send(String data);

Parámetros de chamada:

  • data: Cadea, especifica o texto enviado

Envíe un anaco de datos binarios á outra parte

1
WebSocket.send(Buffer data);

Parámetros de chamada:

  • data: Buffer, Especifique os datos binarios que se van enviar

ref

Evite que o proceso fibjs saia e evite que o proceso fibjs saia durante a unión de obxectos

1
WebSocket WebSocket.ref();

Resultado de volta:

  • WebSocket, Devolve o obxecto actual

unref

Permitir a saída do proceso fibjs e permitir a saída do proceso fibjs durante a unión de obxectos

1
WebSocket WebSocket.unref();

Resultado de volta:

  • WebSocket, Devolve o obxecto actual

on

Vincula un controlador de eventos ao obxecto

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

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento
  • func: Función, especifica a función de procesamento de eventos

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Vincula un controlador de eventos ao obxecto

1
Object WebSocket.on(Object map);

Parámetros de chamada:

  • map: Obxecto, especifique a relación de asignación de eventos, o nome da propiedade do obxecto usarase como nome do evento e o valor da propiedade usarase como función de procesamento de eventos.

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

addListener

Vincula un controlador de eventos ao obxecto

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

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento
  • func: Función, especifica a función de procesamento de eventos

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Vincula un controlador de eventos ao obxecto

1
Object WebSocket.addListener(Object map);

Parámetros de chamada:

  • map: Obxecto, especifique a relación de asignación de eventos, o nome da propiedade do obxecto usarase como nome do evento e o valor da propiedade usarase como función de procesamento de eventos.

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

prependListener

Vincula un controlador de eventos ao comezo do obxecto

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

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento
  • func: Función, especifica a función de procesamento de eventos

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Vincula un controlador de eventos ao comezo do obxecto

1
Object WebSocket.prependListener(Object map);

Parámetros de chamada:

  • map: Obxecto, especifique a relación de asignación de eventos, o nome da propiedade do obxecto usarase como nome do evento e o valor da propiedade usarase como función de procesamento de eventos.

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

once

Vincula unha función de procesamento de eventos dunha soa vez ao obxecto, a función de procesamento única só se activará unha vez

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

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento
  • func: Función, especifica a función de procesamento de eventos

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Vincula unha función de procesamento de eventos dunha soa vez ao obxecto, a función de procesamento única só se activará unha vez

1
Object WebSocket.once(Object map);

Parámetros de chamada:

  • map: Obxecto, especifique a relación de asignación de eventos, o nome da propiedade do obxecto usarase como nome do evento e o valor da propiedade usarase como función de procesamento de eventos.

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

prependOnceListener

Vincula un controlador de eventos ao comezo do obxecto

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

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento
  • func: Función, especifica a función de procesamento de eventos

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Vincula un controlador de eventos ao comezo do obxecto

1
Object WebSocket.prependOnceListener(Object map);

Parámetros de chamada:

  • map: Obxecto, especifique a relación de asignación de eventos, o nome da propiedade do obxecto usarase como nome do evento e o valor da propiedade usarase como función de procesamento de eventos.

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

off

Cancelar a función especificada da cola de procesamento de obxectos

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

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento
  • func: Función, especifica a función de procesamento de eventos

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Cancelar todas as funcións na cola de procesamento de obxectos

1
Object WebSocket.off(String ev);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Cancelar a función especificada da cola de procesamento de obxectos

1
Object WebSocket.off(Object map);

Parámetros de chamada:

  • map: Obxecto, especifique a relación de asignación de eventos, o nome da propiedade do obxecto úsase como nome de evento e o valor da propiedade úsase como función de procesamento de eventos.

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

removeListener

Cancelar a función especificada da cola de procesamento de obxectos

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

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento
  • func: Función, especifica a función de procesamento de eventos

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Cancelar todas as funcións na cola de procesamento de obxectos

1
Object WebSocket.removeListener(String ev);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Cancelar a función especificada da cola de procesamento de obxectos

1
Object WebSocket.removeListener(Object map);

Parámetros de chamada:

  • map: Obxecto, especifique a relación de asignación de eventos, o nome da propiedade do obxecto úsase como nome de evento e o valor da propiedade úsase como función de procesamento de eventos.

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

removeAllListeners

Cancelar todos os oíntes de todos os eventos da cola de procesamento de obxectos. Se se especifica un evento, elimine todos os oíntes do evento especificado.

1
Object WebSocket.removeAllListeners(String ev);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Cancelar todos os oíntes de todos os eventos da cola de procesamento de obxectos. Se se especifica un evento, elimine todos os oíntes do evento especificado.

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

Parámetros de chamada:

  • evs: Array, especifique o nome do evento

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

setMaxListeners

O límite predeterminado do número de oíntes, só por compatibilidade

1
WebSocket.setMaxListeners(Integer n);

Parámetros de chamada:

  • n: Enteiro, especifique o número de eventos

getMaxListeners

Obtén o límite predeterminado do número de oíntes, só por compatibilidade

1
Integer WebSocket.getMaxListeners();

Resultado de volta:

  • Integer, Volver ao número límite predeterminado

listeners

Matriz de oíntes para o evento especificado do obxecto de consulta

1
Array WebSocket.listeners(String ev);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento

Resultado de volta:

  • Array, Devolve unha matriz de oíntes para o evento especificado

listenerCount

O número de oíntes para o evento especificado do obxecto de consulta

1
Integer WebSocket.listenerCount(String ev);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento

Resultado de volta:

  • Integer, Devolve o número de oíntes para o evento especificado

eventNames

Consulta o nome do evento do oínte

1
Array WebSocket.eventNames();

Resultado de volta:

  • Array, Devolve unha matriz de nomes de eventos

emit

Desencadea un evento activamente

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

Parámetros de chamada:

  • ev: Cadea, nome do evento
  • args: ..., parámetros do evento, que se pasarán ao controlador de eventos

Resultado de volta:

  • Boolean, Volver ao estado de activación do evento, devolver verdadeiro se hai un evento de resposta, en caso contrario devolver falso

toString

Devolve a representación de cadea do obxecto, xeralmente devolve "[Obxecto nativo]", o obxecto pode reimplementarse segundo as súas propias características

1
String WebSocket.toString();

Resultado de volta:

  • String, Devolve a representación de cadea do obxecto

toJSON

Devolve a representación en formato JSON do obxecto, xeralmente devolve unha colección de atributos lexibles definidos polo obxecto

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

Parámetros de chamada:

  • key: Cadea, sen usar

Resultado de volta:

  • Value, Devolve un valor que contén JSON serializable