WebSocket d'objectes
Processador de conversió de protocols de paquets WebSocket
S'utilitza per convertir el protocol Http en missatge de protocol de paquets WebSocket. Mètode de creació:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21var 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);
}
Herència
Constructor
WebSocket
Constructor de WebSocket
1
2
3new WebSocket(String url,
String protocol = "",
String origin = "");
Paràmetres de trucada:
- url: Cadena, especifiqueu el servidor connectat
- protocol: Cadena, especifiqueu el protocol d'aproximació de mans, el valor per defecte és ""
- origin: Cadena, especifiqueu la font que s'ha de simular durant l'aplicació de mans, el valor per defecte és ""
Constructor de WebSocket
1
2new WebSocket(String url,
Object opts);
Paràmetres de trucada:
- url: Cadena, especifiqueu el servidor connectat
- opts: Objecte, opció de connexió, per defecte és {}
opts conté opcions addicionals sol·licitades i el contingut admès és el següent:
1
2
3
4
5
6
7
8{
"protocol": "", // 指定握手协议,缺省为空
"origin": "", // 指定握手时模拟的源,缺省为空
"perMessageDeflate": false, // 指定是否支持压缩,缺省不支持
"maxPayload": 67108864, // 指定最大数据包尺寸,缺省为 67108864
"httpClient": hc, // 自定义 httpClient 对象,缺省使用全局 httpClient
"headers": // 指定 http(s) 连接时携带的 header,缺省为 {},
}
Propietats estàtiques
defaultMaxListeners
Enter, el nombre màxim d'oients global predeterminat
1static Integer WebSocket.defaultMaxListeners;
Atributs de membre
url
Cadena, consulta el servidor connectat a l'objecte actual
1readonly String WebSocket.url;
protocol
Cadena, consulta el protocol quan es connecta l’objecte actual
1readonly String WebSocket.protocol;
origin
Cadena, consulta l'origen de la connexió d'objecte actual
1readonly String WebSocket.origin;
readyState
Enter, consulteu l'estat de connexió de l'objecte actual, vegeu ws
1readonly Integer WebSocket.readyState;
onopen
Funció, consulta i esdeveniment d'èxit de connexió bind, equivalent a on ("obert", func);
1Function WebSocket.onopen;
onmessage
Funciona, consulta i vincula l'esdeveniment de rebre el missatge de l'altra part, equivalent a on ("missatge", func);
1Function WebSocket.onmessage;
onclose
Funciona, consulta i vincula l'esdeveniment de tancament de la connexió, equivalent a on ("tancar", func);
1Function WebSocket.onclose;
onerror
Funció, consulta i esdeveniments d'error d'enllaç, equivalents a on ("error", func);
1Function WebSocket.onerror;
Funció de membre
close
Tanqueu la connexió actual, aquesta operació enviarà un paquet TANCAR a l'altra part i esperarà que l'altra part respongui
1
2WebSocket.close(Integer code = 1000,
String reason = "");
Paràmetres de trucada:
- code: Enter, especifiqueu el codi a tancar, el valor permès és 3000-4999 o 1000, el valor per defecte és 1000
- reason: Cadena, especifiqueu el motiu del tancament, el valor per defecte és ""
send
Envieu un text a l'altra part
1WebSocket.send(String data);
Paràmetres de trucada:
- data: Cadena, especifiqueu el text enviat
Envieu un tros de dades binàries a l’altra part
1WebSocket.send(Buffer data);
Paràmetres de trucada:
- data: Buffer, Especifiqueu les dades binàries que s’enviaran
ref
Eviteu que el procés fibjs surti i eviteu que el procés fibjs surti durant l'enllaç d'objectes
1WebSocket WebSocket.ref();
Resultat de retorn:
- WebSocket, Retorna l'objecte actual
unref
Permet que el procés fibjs surti i permeti que el procés fibjs surti durant la vinculació d'objectes
1WebSocket WebSocket.unref();
Resultat de retorn:
- WebSocket, Retorna l'objecte actual
on
Enllaça un gestor d'esdeveniments a l'objecte
1
2Object WebSocket.on(String ev,
Function func);
Paràmetres de trucada:
- ev: Cadena, especifiqueu el nom de l'esdeveniment
- func: Funció, especifiqueu la funció de processament d'esdeveniments
Resultat de retorn:
- Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena
Enllaça un gestor d'esdeveniments a l'objecte
1Object WebSocket.on(Object map);
Paràmetres de trucada:
- map: Objecte, especifiqueu la relació de mapatge d'esdeveniments, s'utilitzarà el nom de la propietat de l'objecte com a nom de l'esdeveniment i el valor de la propietat s'utilitzarà com a funció de processament d'esdeveniments
Resultat de retorn:
- Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena
addListener
Enllaça un gestor d'esdeveniments a l'objecte
1
2Object WebSocket.addListener(String ev,
Function func);
Paràmetres de trucada:
- ev: Cadena, especifiqueu el nom de l'esdeveniment
- func: Funció, especifiqueu la funció de processament d'esdeveniments
Resultat de retorn:
- Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena
Enllaça un gestor d'esdeveniments a l'objecte
1Object WebSocket.addListener(Object map);
Paràmetres de trucada:
- map: Objecte, especifiqueu la relació de mapatge d'esdeveniments, s'utilitzarà el nom de la propietat de l'objecte com a nom de l'esdeveniment i el valor de la propietat s'utilitzarà com a funció de processament d'esdeveniments
Resultat de retorn:
- Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena
prependListener
Enllaça un gestor d'esdeveniments a l'inici de l'objecte
1
2Object WebSocket.prependListener(String ev,
Function func);
Paràmetres de trucada:
- ev: Cadena, especifiqueu el nom de l'esdeveniment
- func: Funció, especifiqueu la funció de processament d'esdeveniments
Resultat de retorn:
- Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena
Enllaça un gestor d'esdeveniments a l'inici de l'objecte
1Object WebSocket.prependListener(Object map);
Paràmetres de trucada:
- map: Objecte, especifiqueu la relació de mapatge d'esdeveniments, s'utilitzarà el nom de la propietat de l'objecte com a nom de l'esdeveniment i el valor de la propietat s'utilitzarà com a funció de processament d'esdeveniments
Resultat de retorn:
- Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena
once
Enllaceu una funció de processament d'esdeveniments puntuals a l'objecte, la funció de processament puntual només s'activarà una vegada
1
2Object WebSocket.once(String ev,
Function func);
Paràmetres de trucada:
- ev: Cadena, especifiqueu el nom de l'esdeveniment
- func: Funció, especifiqueu la funció de processament d'esdeveniments
Resultat de retorn:
- Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena
Enllaceu una funció de processament d'esdeveniments puntuals a l'objecte, la funció de processament puntual només s'activarà una vegada
1Object WebSocket.once(Object map);
Paràmetres de trucada:
- map: Objecte, especifiqueu la relació de mapatge d'esdeveniments, s'utilitzarà el nom de la propietat de l'objecte com a nom de l'esdeveniment i el valor de la propietat s'utilitzarà com a funció de processament d'esdeveniments
Resultat de retorn:
- Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena
prependOnceListener
Enllaça un gestor d'esdeveniments a l'inici de l'objecte
1
2Object WebSocket.prependOnceListener(String ev,
Function func);
Paràmetres de trucada:
- ev: Cadena, especifiqueu el nom de l'esdeveniment
- func: Funció, especifiqueu la funció de processament d'esdeveniments
Resultat de retorn:
- Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena
Enllaça un gestor d'esdeveniments a l'inici de l'objecte
1Object WebSocket.prependOnceListener(Object map);
Paràmetres de trucada:
- map: Objecte, especifiqueu la relació de mapatge d'esdeveniments, s'utilitzarà el nom de la propietat de l'objecte com a nom de l'esdeveniment i el valor de la propietat s'utilitzarà com a funció de processament d'esdeveniments
Resultat de retorn:
- Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena
off
Cancel·leu la funció especificada a la cua de processament d'objectes
1
2Object WebSocket.off(String ev,
Function func);
Paràmetres de trucada:
- ev: Cadena, especifiqueu el nom de l'esdeveniment
- func: Funció, especifiqueu la funció de processament d'esdeveniments
Resultat de retorn:
- Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena
Cancel·leu totes les funcions de la cua de processament d'objectes
1Object WebSocket.off(String ev);
Paràmetres de trucada:
- ev: Cadena, especifiqueu el nom de l'esdeveniment
Resultat de retorn:
- Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena
Cancel·leu la funció especificada a la cua de processament d'objectes
1Object WebSocket.off(Object map);
Paràmetres de trucada:
- map: Objecte, especifiqueu la relació de mapatge d'esdeveniments, el nom de la propietat de l'objecte s'utilitza com a nom d'esdeveniment i el valor de la propietat s'utilitza com a funció de processament d'esdeveniments
Resultat de retorn:
- Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena
removeListener
Cancel·leu la funció especificada a la cua de processament d'objectes
1
2Object WebSocket.removeListener(String ev,
Function func);
Paràmetres de trucada:
- ev: Cadena, especifiqueu el nom de l'esdeveniment
- func: Funció, especifiqueu la funció de processament d'esdeveniments
Resultat de retorn:
- Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena
Cancel·leu totes les funcions de la cua de processament d'objectes
1Object WebSocket.removeListener(String ev);
Paràmetres de trucada:
- ev: Cadena, especifiqueu el nom de l'esdeveniment
Resultat de retorn:
- Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena
Cancel·leu la funció especificada a la cua de processament d'objectes
1Object WebSocket.removeListener(Object map);
Paràmetres de trucada:
- map: Objecte, especifiqueu la relació de mapatge d'esdeveniments, el nom de la propietat de l'objecte s'utilitza com a nom d'esdeveniment i el valor de la propietat s'utilitza com a funció de processament d'esdeveniments
Resultat de retorn:
- Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena
removeAllListeners
Cancel·leu tots els oients de tots els esdeveniments de la cua de processament d'objectes. Si s'especifica un esdeveniment, traieu tots els oients de l'esdeveniment especificat.
1Object WebSocket.removeAllListeners(String ev);
Paràmetres de trucada:
- ev: Cadena, especifiqueu el nom de l'esdeveniment
Resultat de retorn:
- Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena
Cancel·leu tots els oients de tots els esdeveniments de la cua de processament d'objectes. Si s'especifica un esdeveniment, traieu tots els oients de l'esdeveniment especificat.
1Object WebSocket.removeAllListeners(Array evs = []);
Paràmetres de trucada:
- evs: Matriu, especifiqueu el nom de l'esdeveniment
Resultat de retorn:
- Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena
setMaxListeners
El límit predeterminat del nombre d’oients, només per compatibilitat
1WebSocket.setMaxListeners(Integer n);
Paràmetres de trucada:
- n: Enter, especifiqueu el nombre d'esdeveniments
getMaxListeners
Obteniu el límit predeterminat del nombre d'oients, només per compatibilitat
1Integer WebSocket.getMaxListeners();
Resultat de retorn:
- Integer, Torneu al número límit per defecte
listeners
Matriu d'oients per a l'esdeveniment especificat de l'objecte de consulta
1Array WebSocket.listeners(String ev);
Paràmetres de trucada:
- ev: Cadena, especifiqueu el nom de l'esdeveniment
Resultat de retorn:
- Array, Retorna una matriu d'oients per a l'esdeveniment especificat
listenerCount
El nombre d'oients de l'esdeveniment especificat de l'objecte de consulta
1Integer WebSocket.listenerCount(String ev);
Paràmetres de trucada:
- ev: Cadena, especifiqueu el nom de l'esdeveniment
Resultat de retorn:
- Integer, Retorna el nombre d'oients de l'esdeveniment especificat
El nombre d'oients de l'esdeveniment especificat de l'objecte de consulta
1
2Integer WebSocket.listenerCount(Value o,
String ev);
Paràmetres de trucada:
- o: Valor, especifiqueu l'objecte de la consulta
- ev: Cadena, especifiqueu el nom de l'esdeveniment
Resultat de retorn:
- Integer, Retorna el nombre d'oients de l'esdeveniment especificat
eventNames
Consulteu el nom de l'esdeveniment de l'oient
1Array WebSocket.eventNames();
Resultat de retorn:
- Array, Retorna una matriu de noms d'esdeveniments
emit
Activar un esdeveniment activament
1
2Boolean WebSocket.emit(String ev,
...args);
Paràmetres de trucada:
- ev: Cadena, nom de l'esdeveniment
- args: ..., paràmetres d'esdeveniments, que es passaran al gestor d'esdeveniments
Resultat de retorn:
- Boolean, Torneu a l'estat d'activació de l'esdeveniment, torneu cert si hi ha un esdeveniment de resposta, en cas contrari torneu a fals
toString
Retorna la representació de cadena de l'objecte, generalment retorna "[Objecte natiu]", l'objecte es pot tornar a implementar segons les seves pròpies característiques
1String WebSocket.toString();
Resultat de retorn:
- String, Retorna la representació de cadena de l'objecte
toJSON
Retorna la representació en format JSON de l'objecte, generalment retorna una col·lecció d'atributs llegibles definits per l'objecte
1Value WebSocket.toJSON(String key = "");
Paràmetres de trucada:
- key: Cadena, sense utilitzar
Resultat de retorn:
- Value, Retorna un valor que conté JSON serialitzable