Objet intégré objet

Objet WebSocket

Processeur de conversion de protocole de paquets WebSocket

Il est utilisé pour convertir le protocole Http en message de protocole de paquet WebSocket. Méthode de création:

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

Héritage

Constructeur

WebSocket

Constructeur WebSocket

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

Paramètres d'appel:

  • url : String, spécifiez le serveur connecté
  • protocol : String, spécifie le protocole de prise de contact, la valeur par défaut est ""
  • origin : String, spécifie l' origin simuler lors de la prise de contact, la valeur par défaut est ""

Constructeur WebSocket

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

Paramètres d'appel:

  • url : String, spécifiez le serveur connecté
  • opts : Objet, options de connexion, la valeur par défaut est {}

opts contient des options supplémentaires demandées et le contenu pris en charge est le suivant:

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

Propriétés statiques

defaultMaxListeners

Entier, le nombre maximum global d'écouteurs par défaut

1
static Integer WebSocket.defaultMaxListeners;

Attributs des membres

url

String, interroge le serveur connecté à l'objet courant

1
readonly String WebSocket.url;

protocol

String, interroge le protocole lorsque l'objet courant est connecté

1
readonly String WebSocket.protocol;

origin

Chaîne, interroge la source de la connexion d'objet actuelle

1
readonly String WebSocket.origin;

readyState

Entier, interrogez l'état de connexion de l'objet actuel, voir ws

1
readonly Integer WebSocket.readyState;

onopen

Evénement de réussite de connexion de fonction, de requête et de liaison, équivalent à on ("open", func);

1
Function WebSocket.onopen;

onmessage

Fonction, interroger et lier l'événement de réception du message de l'autre partie, équivalent à on ("message", func);

1
Function WebSocket.onmessage;

onclose

Fonction, interroger et lier l'événement de connexion fermée, équivalent à on ("close", func);

1
Function WebSocket.onclose;

onerror

Fonction, interroger et lier l'événement d'erreur, équivalent à on ("error", func);

1
Function WebSocket.onerror;

Fonction membre

close

Fermez la connexion en cours, cette opération enverra un paquet CLOSE à l'autre partie et attendra que l'autre partie réponde

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

Paramètres d'appel:

  • code : Entier, spécifiez le code à fermer, la valeur autorisée est 3000-4999 ou 1000, la valeur par défaut est 1000
  • reason : chaîne, spécifiez la raison de la fermeture, la valeur par défaut est ""

send

Envoyer un SMS à l'autre partie

1
WebSocket.send(String data);

Paramètres d'appel:

  • data : String, spécifiez le texte envoyé

Envoyer un morceau de données binaires à l'autre partie

1
WebSocket.send(Buffer data);

Paramètres d'appel:

  • data : Buffer , spécifiez les données binaires envoyées

ref

Empêchez le processus fibjs de se terminer et empêchez le processus fibjs de se terminer pendant la liaison d'objet

1
WebSocket WebSocket.ref();

Résultat de retour:

  • WebSocket , retourne l'objet courant

unref

Autoriser le processus fibjs à se terminer, autoriser le processus fibjs à se terminer pendant la liaison d'objet

1
WebSocket WebSocket.unref();

Résultat de retour:

  • WebSocket , retourne l'objet courant

on

Lier un gestionnaire d'événements à l'objet

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

Paramètres d'appel:

  • ev : String, spécifiez le nom de l'événement
  • func : Fonction, spécifiez la fonction de traitement des événements

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, appel facile à enchaîner

Lier un gestionnaire d'événements à l'objet

1
Object WebSocket.on(Object map);

Paramètres d'appel:

  • map : Objet, spécifiez la relation de mappage d'événement, le nom de propriété de l'objet sera utilisé comme nom d'événement et la valeur de propriété sera utilisée comme fonction de traitement d'événement

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, appel facile à enchaîner

addListener

Lier un gestionnaire d'événements à l'objet

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

Paramètres d'appel:

  • ev : String, spécifiez le nom de l'événement
  • func : Fonction, spécifiez la fonction de traitement des événements

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, appel facile à enchaîner

Lier un gestionnaire d'événements à l'objet

1
Object WebSocket.addListener(Object map);

Paramètres d'appel:

  • map : Objet, spécifiez la relation de mappage d'événement, le nom de propriété de l'objet sera utilisé comme nom d'événement et la valeur de propriété sera utilisée comme fonction de traitement d'événement

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, appel facile à enchaîner

prependListener

Lier un gestionnaire d'événements au début de l'objet

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

Paramètres d'appel:

  • ev : String, spécifiez le nom de l'événement
  • func : Fonction, spécifiez la fonction de traitement des événements

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, appel facile à enchaîner

Lier un gestionnaire d'événements au début de l'objet

1
Object WebSocket.prependListener(Object map);

Paramètres d'appel:

  • map : Objet, spécifiez la relation de mappage d'événement, le nom de propriété de l'objet sera utilisé comme nom d'événement et la valeur de propriété sera utilisée comme fonction de traitement d'événement

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, appel facile à enchaîner

once

Liez une fonction de traitement d'événement unique à l'objet, la fonction de traitement unique ne sera déclenchée qu'une seule fois

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

Paramètres d'appel:

  • ev : String, spécifiez le nom de l'événement
  • func : Fonction, spécifiez la fonction de traitement des événements

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, appel facile à enchaîner

Liez une fonction de traitement d'événement unique à l'objet, la fonction de traitement unique ne sera déclenchée qu'une seule fois

1
Object WebSocket.once(Object map);

Paramètres d'appel:

  • map : Objet, spécifiez la relation de mappage d'événement, le nom de propriété de l'objet sera utilisé comme nom d'événement et la valeur de propriété sera utilisée comme fonction de traitement d'événement

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, appel facile à enchaîner

prependOnceListener

Lier un gestionnaire d'événements au début de l'objet

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

Paramètres d'appel:

  • ev : String, spécifiez le nom de l'événement
  • func : Fonction, spécifiez la fonction de traitement des événements

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, appel facile à enchaîner

Lier un gestionnaire d'événements au début de l'objet

1
Object WebSocket.prependOnceListener(Object map);

Paramètres d'appel:

  • map : Objet, spécifiez la relation de mappage d'événement, le nom de propriété de l'objet sera utilisé comme nom d'événement et la valeur de propriété sera utilisée comme fonction de traitement d'événement

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, appel facile à enchaîner

off

Annuler la fonction spécifiée de la file d'attente de traitement des objets

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

Paramètres d'appel:

  • ev : String, spécifiez le nom de l'événement
  • func : Fonction, spécifiez la fonction de traitement des événements

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, appel facile à enchaîner

Annuler toutes les fonctions de la file d'attente de traitement des objets

1
Object WebSocket.off(String ev);

Paramètres d'appel:

  • ev : String, spécifiez le nom de l'événement

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, appel facile à enchaîner

Annuler la fonction spécifiée de la file d'attente de traitement des objets

1
Object WebSocket.off(Object map);

Paramètres d'appel:

  • map : objet, spécifiez la relation de mappage d'événement, le nom de propriété de l'objet est utilisé comme nom d'événement et la valeur de propriété est utilisée comme fonction de traitement d'événement

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, appel facile à enchaîner

removeListener

Annuler la fonction spécifiée de la file d'attente de traitement des objets

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

Paramètres d'appel:

  • ev : String, spécifiez le nom de l'événement
  • func : Fonction, spécifiez la fonction de traitement des événements

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, appel facile à enchaîner

Annuler toutes les fonctions de la file d'attente de traitement des objets

1
Object WebSocket.removeListener(String ev);

Paramètres d'appel:

  • ev : String, spécifiez le nom de l'événement

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, appel facile à enchaîner

Annuler la fonction spécifiée de la file d'attente de traitement des objets

1
Object WebSocket.removeListener(Object map);

Paramètres d'appel:

  • map : objet, spécifiez la relation de mappage d'événement, le nom de propriété de l'objet est utilisé comme nom d'événement et la valeur de propriété est utilisée comme fonction de traitement d'événement

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, appel facile à enchaîner

removeAllListeners

Annulez tous les écouteurs de tous les événements de la file d'attente de traitement des objets. Si un événement est spécifié, supprimez tous les écouteurs de l'événement spécifié.

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

Paramètres d'appel:

  • evs : Array, spécifiez le nom de l'événement

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, appel facile à enchaîner

setMaxListeners

La limite par défaut du nombre d'écouteurs, uniquement pour la compatibilité

1
WebSocket.setMaxListeners(Integer n);

Paramètres d'appel:

  • n : Entier, spécifiez le nombre d'événements

getMaxListeners

Obtenez la limite par défaut du nombre d'écouteurs, uniquement pour des raisons de compatibilité

1
Integer WebSocket.getMaxListeners();

Résultat de retour:

  • Integer , renvoie le nombre limite par défaut

listeners

Tableau d'écouteurs pour l'événement spécifié de l'objet de requête

1
Array WebSocket.listeners(String ev);

Paramètres d'appel:

  • ev : String, spécifiez le nom de l'événement

Résultat de retour:

  • Array , renvoie un tableau d'écouteurs pour l'événement spécifié

listenerCount

Le nombre d'écouteurs pour l'événement spécifié de l'objet de requête

1
Integer WebSocket.listenerCount(String ev);

Paramètres d'appel:

  • ev : String, spécifiez le nom de l'événement

Résultat de retour:

  • Integer , renvoie le nombre d'écouteurs pour l'événement spécifié

eventNames

Nom de l'événement de l'écouteur de requête

1
Array WebSocket.eventNames();

Résultat de retour:

  • Array , retourne un tableau de noms d'événements

emit

Déclencher un événement activement

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

Paramètres d'appel:

  • ev : chaîne, nom de l'événement
  • args : ..., paramètres d'événement, qui seront transmis au gestionnaire d'événements

Résultat de retour:

  • Boolean , renvoie l'état du déclencheur d'événement, renvoie true s'il y a un événement de réponse, sinon retourne false

toString

Renvoie la représentation sous forme de chaîne de l'objet, renvoie généralement "[Native Object]", l'objet peut être réimplémenté selon ses propres caractéristiques

1
String WebSocket.toString();

Résultat de retour:

  • String , renvoie la représentation sous forme de chaîne de l'objet

toJSON

Renvoie la représentation au format JSON de l'objet, renvoie généralement une collection d'attributs lisibles définis par l'objet

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

Paramètres d'appel:

  • key : chaîne, non utilisée

Résultat de retour:

  • Value , renvoie une valeur contenant JSON sérialisable