Oggetto oggetto incorporato

Oggetto WebSocket

Processore di conversione del protocollo del pacchetto WebSocket

Utilizzato per convertire il protocollo Http in messaggio del protocollo del pacchetto WebSocket. Come creare:

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); }

Eredità

Costruttore

WebSocket

Costruttore WebSocket

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

Parametri di chiamata:

  • url : String, specifica il server connesso
  • protocol : String, specifica il protocollo di handshake, il valore predefinito è ""
  • origin : String, specifica l'origine della simulazione durante l'handshake, il valore predefinito è ""

Costruttore WebSocket

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

Parametri di chiamata:

  • url : String, specifica il server connesso
  • opts : oggetto, opzioni di connessione, il valore predefinito è {}

opts contiene opzioni aggiuntive richieste, il contenuto supportato è il seguente:

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

Proprietà statica

defaultMaxListeners

Numero intero, numero massimo globale predefinito di listener

1
static Integer WebSocket.defaultMaxListeners;

Attributo membro

url

String, interroga il server a cui è collegato l'oggetto corrente

1
readonly String WebSocket.url;

protocol

String, interroga il protocollo quando l'oggetto corrente è collegato

1
readonly String WebSocket.protocol;

origin

String, interroga l'origine della connessione dell'oggetto corrente

1
readonly String WebSocket.origin;

readyState

Numero intero, interroga lo stato della connessione dell'oggetto corrente, vedi ws

1
readonly Integer WebSocket.readyState;

onopen

Evento di successo della connessione di funzione, query e collegamento, equivalente a on ("aperto", func);

1
Function WebSocket.onopen;

onmessage

Eventi di funzione, query e associazione che ricevono messaggi dall'altra parte, equivalenti a on ("messaggio", func);

1
Function WebSocket.onmessage;

onclose

Funzione, interroga e associa l'evento di connessione chiusa, equivalente a on ("close", func);

1
Function WebSocket.onclose;

onerror

Evento di occorrenza di errore di funzione, query e associazione, equivalente a on ("errore", func);

1
Function WebSocket.onerror;

Funzione membro

close

Chiudi la connessione corrente, questa operazione invierà un pacchetto CLOSE all'altra parte e attenderà che l'altra parte risponda

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

Parametri di chiamata:

  • code : numero intero, specifica il codice da chiudere
  • reason : String, specificare il motivo della chiusura, il valore predefinito è ""

send

Invia un SMS all'altra parte

1
WebSocket.send(String data);

Parametri di chiamata:

  • data : String, specifica il testo da inviare

Invia una parte di dati binari all'altra parte

1
WebSocket.send(Buffer data);

Parametri di chiamata:

  • data : Buffer , specificare i dati binari da inviare

ref

Impedisci al processo fibjs di uscire e impedisce al processo fibjs di uscire durante l'associazione degli oggetti

1
WebSocket WebSocket.ref();

Risultato di ritorno:

  • WebSocket , restituisce l'oggetto corrente

unref

Consentire l'uscita del processo fibjs e consentire l'uscita del processo fibjs durante l'associazione degli oggetti

1
WebSocket WebSocket.unref();

Risultato di ritorno:

  • WebSocket , restituisce l'oggetto corrente

on

Associare un gestore eventi all'oggetto

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

Parametri di chiamata:

  • ev : String, specifica il nome dell'evento
  • func : Function, specifica la funzione di elaborazione degli eventi

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

Associare un gestore eventi all'oggetto

1
Object WebSocket.on(Object map);

Parametri di chiamata:

  • map : Object, specifica la relazione di mapping degli eventi, il nome dell'attributo dell'oggetto verrà utilizzato come nome dell'evento e il valore dell'attributo verrà utilizzato come gestore dell'evento

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

addListener

Associare un gestore eventi all'oggetto

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

Parametri di chiamata:

  • ev : String, specifica il nome dell'evento
  • func : Function, specifica la funzione di elaborazione degli eventi

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

Associare un gestore eventi all'oggetto

1
Object WebSocket.addListener(Object map);

Parametri di chiamata:

  • map : Object, specifica la relazione di mapping degli eventi, il nome dell'attributo dell'oggetto verrà utilizzato come nome dell'evento e il valore dell'attributo verrà utilizzato come gestore dell'evento

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

prependListener

Associare un gestore eventi all'inizio dell'oggetto

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

Parametri di chiamata:

  • ev : String, specifica il nome dell'evento
  • func : Function, specifica la funzione di elaborazione degli eventi

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

Associare un gestore eventi all'inizio dell'oggetto

1
Object WebSocket.prependListener(Object map);

Parametri di chiamata:

  • map : Object, specifica la relazione di mapping degli eventi, il nome dell'attributo dell'oggetto verrà utilizzato come nome dell'evento e il valore dell'attributo verrà utilizzato come gestore dell'evento

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

once

Associa un gestore eventi singolo all'oggetto, il gestore singolo si attiverà una sola volta

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

Parametri di chiamata:

  • ev : String, specifica il nome dell'evento
  • func : Function, specifica la funzione di elaborazione degli eventi

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

Associa un gestore eventi singolo all'oggetto, il gestore singolo si attiverà una sola volta

1
Object WebSocket.once(Object map);

Parametri di chiamata:

  • map : Object, specifica la relazione di mapping degli eventi, il nome dell'attributo dell'oggetto verrà utilizzato come nome dell'evento e il valore dell'attributo verrà utilizzato come gestore dell'evento

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

prependOnceListener

Associare un gestore eventi all'inizio dell'oggetto

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

Parametri di chiamata:

  • ev : String, specifica il nome dell'evento
  • func : Function, specifica la funzione di elaborazione degli eventi

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

Associare un gestore eventi all'inizio dell'oggetto

1
Object WebSocket.prependOnceListener(Object map);

Parametri di chiamata:

  • map : Object, specifica la relazione di mapping degli eventi, il nome dell'attributo dell'oggetto verrà utilizzato come nome dell'evento e il valore dell'attributo verrà utilizzato come gestore dell'evento

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

off

Annulla la funzione specificata dalla coda di elaborazione degli oggetti

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

Parametri di chiamata:

  • ev : String, specifica il nome dell'evento
  • func : Function, specifica la funzione di elaborazione degli eventi

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

Annulla tutte le funzioni nella coda di elaborazione degli oggetti

1
Object WebSocket.off(String ev);

Parametri di chiamata:

  • ev : String, specifica il nome dell'evento

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

Annulla la funzione specificata dalla coda di elaborazione degli oggetti

1
Object WebSocket.off(Object map);

Parametri di chiamata:

  • map : Object, specifica la relazione di mapping degli eventi, il nome dell'attributo oggetto viene utilizzato come nome dell'evento e il valore dell'attributo viene utilizzato come funzione di elaborazione degli eventi

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

removeListener

Annulla la funzione specificata dalla coda di elaborazione degli oggetti

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

Parametri di chiamata:

  • ev : String, specifica il nome dell'evento
  • func : Function, specifica la funzione di elaborazione degli eventi

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

Annulla tutte le funzioni nella coda di elaborazione degli oggetti

1
Object WebSocket.removeListener(String ev);

Parametri di chiamata:

  • ev : String, specifica il nome dell'evento

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

Annulla la funzione specificata dalla coda di elaborazione degli oggetti

1
Object WebSocket.removeListener(Object map);

Parametri di chiamata:

  • map : Object, specifica la relazione di mapping degli eventi, il nome dell'attributo oggetto viene utilizzato come nome dell'evento e il valore dell'attributo viene utilizzato come funzione di elaborazione degli eventi

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

removeAllListeners

Annulla tutti i listener per tutti gli eventi dalla coda di elaborazione degli oggetti Se specificato, rimuove tutti i listener per gli eventi specificati.

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

Parametri di chiamata:

  • evs : Array, specifica il nome dell'evento

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

setMaxListeners

Il numero limite predefinito di ascoltatori, solo per compatibilità

1
WebSocket.setMaxListeners(Integer n);

Parametri di chiamata:

  • n : intero, specifica il numero di eventi

getMaxListeners

Ottieni il numero limite predefinito di ascoltatori, solo per compatibilità

1
Integer WebSocket.getMaxListeners();

Risultato di ritorno:

  • Numero Integer , restituisce il numero limite predefinito

listeners

Matrice di listener per l'evento specificato dell'oggetto query

1
Array WebSocket.listeners(String ev);

Parametri di chiamata:

  • ev : String, specifica il nome dell'evento

Risultato di ritorno:

  • Array , restituisce un array di listener per l'evento specificato

listenerCount

Interroga il numero di listener per l'evento specificato

1
Integer WebSocket.listenerCount(String ev);

Parametri di chiamata:

  • ev : String, specifica il nome dell'evento

Risultato di ritorno:

  • Numero Integer , restituisce il numero di listener per l'evento specificato

eventNames

Nome dell'evento listener query

1
Array WebSocket.eventNames();

Risultato di ritorno:

  • Array , restituisce un array di nomi di eventi

emit

Attiva attivamente un evento

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

Parametri di chiamata:

  • ev : String, nome dell'evento
  • args : ..., i parametri dell'evento, saranno passati alla funzione del gestore eventi

Risultato di ritorno:

  • Boolean , restituisce lo stato di attivazione dell'evento, restituisce vero se c'è un evento di risposta, altrimenti restituisce falso

toString

Restituisce la rappresentazione in forma di stringa dell'oggetto, in genere restituisce "[Native Object]", l'oggetto può essere reimplementato in base alle proprie caratteristiche

1
String WebSocket.toString();

Risultato di ritorno:

  • String , restituisce una rappresentazione in formato stringa dell'oggetto

toJSON

Restituisce la rappresentazione JSON dell'oggetto, in genere restituisce una raccolta di attributi leggibili definiti dall'oggetto

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

Parametri di chiamata:

  • key : stringa, non utilizzata

Risultato di ritorno:

  • Value , restituisce un valore contenente serializzabile JSON