Oggetto WebSocket

Processore di conversione del protocollo del pacchetto WebSocket

Viene utilizzato per convertire il protocollo Http in un messaggio di protocollo del pacchetto WebSocket. Metodo di creazione:

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 : stringa, specifica il protocollo di handshake, il valore predefinito è ""
origin : String, specifica l' origin simulata 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 ulteriori opzioni richieste e 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à statiche

defaultMaxListeners

Integer, il numero massimo globale predefinito di listener

1
static Integer WebSocket.defaultMaxListeners;

Attributi dei membri

url

Stringa, interroga il server connesso all'oggetto corrente

1
readonly String WebSocket.url;

protocol

Stringa, interroga il protocollo quando l'oggetto corrente è connesso

1
readonly String WebSocket.protocol;

origin

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

1
readonly String WebSocket.origin;

readyState

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

1readonly Integer WebSocket.readyState;

onopen

Funzione, query e bind evento di successo della connessione, equivalente a on ("open", func);

1
Function WebSocket.onopen;

onmessage

Funzione, interroga e collega l'evento di ricezione del messaggio dell'altra parte, equivalente a on ("message", func);

1
Function WebSocket.onmessage;

onclose

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

1
Function WebSocket.onclose;

onerror

Eventi di errore di funzioni, query e bind, equivalenti a on ("error", func);

1
Function WebSocket.onerror;

Funzione membro

close

Chiudere 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 : intero, specificare il codice da chiudere, il valore consentito è 3000-4999 o 1000, il valore predefinito è 1000
reason : stringa, specificare il motivo della chiusura, il valore predefinito è ""

send

Invia un messaggio all'altra parte

1
WebSocket.send(String data);

Parametri di chiamata:

data : String, specifica il testo inviato

Invia una parte di dati binari all'altra parte

1WebSocket.send(Buffer data);

Parametri di chiamata:

data : Buffer , specifica i dati binari inviati

ref

Evita che il processo fibjs esca e impedisce l'uscita del processo fibjs durante l'associazione di oggetti

1WebSocket WebSocket.ref();

Risultato di ritorno:

WebSocket , restituisce l'oggetto corrente

unref

Consentire al processo fibjs di uscire e consentire al processo fibjs di uscire durante l'associazione degli oggetti

1WebSocket WebSocket.unref();

Risultato di ritorno:

WebSocket , restituisce l'oggetto corrente

on

Associare un gestore di eventi all'oggetto

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

Parametri di chiamata:

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

Risultato di ritorno:

Object , restituisce l'oggetto evento stesso, facile da chiamare a catena

Associa un gestore di eventi all'oggetto

1
Object WebSocket.on(Object map);

Parametri di chiamata:

map : Object, specifica la relazione della mappatura degli eventi, il nome della proprietà dell'oggetto sarà il nome dell'evento e il valore della proprietà sarà la funzione di elaborazione dell'evento

Risultato di ritorno:

Object , restituisce l'oggetto evento stesso, facile da chiamare a catena

addListener

Associare un gestore di eventi all'oggetto

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

Parametri di chiamata:

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

Risultato di ritorno:

Object , restituisce l'oggetto evento stesso, facile da chiamare a catena

Associare un gestore di eventi all'oggetto

1
Object WebSocket.addListener(Object map);

Parametri di chiamata:

map : Object, specifica la relazione della mappatura degli eventi, il nome della proprietà dell'oggetto sarà il nome dell'evento e il valore della proprietà sarà la funzione di elaborazione dell'evento

Risultato di ritorno:

Object , restituisce l'oggetto evento stesso, facile da chiamare a catena

prependListener

Associa un gestore di 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 : funzione, specifica la funzione di elaborazione degli eventi

Risultato di ritorno:

Object , restituisce l'oggetto evento stesso, facile da chiamare a catena

Associa un gestore di eventi all'inizio dell'oggetto

1
Object WebSocket.prependListener(Object map);

Parametri di chiamata:

map : Object, specifica la relazione della mappatura degli eventi, il nome della proprietà dell'oggetto sarà il nome dell'evento e il valore della proprietà sarà la funzione di elaborazione dell'evento

Risultato di ritorno:

Object , restituisce l'oggetto evento stesso, facile da chiamare a catena

once

Associa una funzione di elaborazione di eventi una tantum all'oggetto, la funzione di elaborazione una tantum verrà attivata solo una volta

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

Parametri di chiamata:

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

Risultato di ritorno:

Object , restituisce l'oggetto evento stesso, facile da chiamare a catena

Associa una funzione di elaborazione di eventi una tantum all'oggetto, la funzione di elaborazione una tantum verrà attivata solo una volta

1
Object WebSocket.once(Object map);

Parametri di chiamata:

map : Object, specifica la relazione della mappatura degli eventi, il nome della proprietà dell'oggetto sarà il nome dell'evento e il valore della proprietà sarà la funzione di elaborazione dell'evento

Risultato di ritorno:

Object , restituisce l'oggetto evento stesso, facile da chiamare a catena

prependOnceListener

Associa un gestore di 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 : funzione, specifica la funzione di elaborazione degli eventi

Risultato di ritorno:

Object , restituisce l'oggetto evento stesso, facile da chiamare a catena

Associa un gestore di eventi all'inizio dell'oggetto

1
Object WebSocket.prependOnceListener(Object map);

Parametri di chiamata:

map : Object, specifica la relazione della mappatura degli eventi, il nome della proprietà dell'oggetto sarà il nome dell'evento e il valore della proprietà sarà la funzione di elaborazione dell'evento

Risultato di ritorno:

Object , restituisce l'oggetto evento stesso, facile da chiamare a catena

off

Annulla la funzione specificata dalla coda di elaborazione dell'oggetto

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

Parametri di chiamata:

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

Risultato di ritorno:

Object , restituisce l'oggetto evento stesso, facile da chiamare a catena

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, facile da chiamare a catena

Annulla la funzione specificata dalla coda di elaborazione dell'oggetto

1
Object WebSocket.off(Object map);

Parametri di chiamata:

map : Object, specifica la relazione di mappatura eventi, il nome della proprietà dell'oggetto viene utilizzato come nome dell'evento e il valore della proprietà viene utilizzato come funzione di elaborazione dell'evento

Risultato di ritorno:

Object , restituisce l'oggetto evento stesso, facile da chiamare a catena

removeListener

Annulla la funzione specificata dalla coda di elaborazione dell'oggetto

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

Parametri di chiamata:

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

Risultato di ritorno:

Object , restituisce l'oggetto evento stesso, facile da chiamare a catena

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, facile da chiamare a catena

Annulla la funzione specificata dalla coda di elaborazione dell'oggetto

1
Object WebSocket.removeListener(Object map);

Parametri di chiamata:

map : Object, specifica la relazione di mappatura degli eventi, il nome della proprietà dell'oggetto viene utilizzato come nome dell'evento e il valore della proprietà viene utilizzato come funzione di elaborazione dell'evento

Risultato di ritorno:

Object , restituisce l'oggetto evento stesso, facile da chiamare a catena

removeAllListeners

Annulla tutti i listener di tutti gli eventi dalla coda di elaborazione degli oggetti. Se viene specificato un evento, rimuovere tutti i listener dell'evento specificato.

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, facile da chiamare a catena

setMaxListeners

Il limite predefinito del numero di listener, solo per compatibilità

1WebSocket.setMaxListeners(Integer n);

Parametri di chiamata:

n : intero, specifica il numero di eventi

getMaxListeners

Ottieni il limite predefinito del numero di listener, solo per compatibilità

1Integer WebSocket.getMaxListeners();

Risultato di ritorno:

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

Il numero di listener per l'evento specificato dell'oggetto query

1
Integer WebSocket.listenerCount(String ev);

Parametri di chiamata:

ev : String, specifica il nome dell'evento

Risultato di ritorno:

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

eventNames

Nome dell'evento del listener di query

1
Array WebSocket.eventNames();

Risultato di ritorno:

Array , restituisce un array di nomi di eventi

emit

Attiva un evento attivamente

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

Parametri di chiamata:

ev : String, nome evento
args : ..., parametri dell'evento, che verranno passati al gestore dell'evento

Risultato di ritorno:

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

toString

Restituisce la rappresentazione in stringa dell'oggetto, generalmente restituisce "[Native Object]", l'oggetto può essere reimplementato secondo le proprie caratteristiche

1
String WebSocket.toString();

Risultato di ritorno:

String , restituisce la rappresentazione in formato stringa dell'oggetto

toJSON

Restituisce la rappresentazione in formato JSON dell'oggetto, generalmente 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 JSON serializzabile

Guida allo sviluppo

Modulo base

Oggetti incorporati

Modulo comunitario

Oggetto WebSocket

Eredità

Costruttore

WebSocket

Proprietà statiche

defaultMaxListeners

Attributi dei membri

url

protocol

origin

readyState

onopen

onmessage

onclose

onerror

Funzione membro

close

send

ref

unref

on

addListener

prependListener

once

prependOnceListener

off

removeListener

removeAllListeners

setMaxListeners

getMaxListeners

listeners

listenerCount

eventNames

emit

toString

toJSON