Objet objet intégré
  1. Accueil
  2. Objets intégrés
  3. Objet WebSocket

Objet WebSocket

Processeur de conversion de protocole de paquet WebSocket

Utilisé pour convertir le protocole Http en message de protocole de paquet WebSocket. Comment créer: 

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

%0 object object toString() toJSON() EventEmitter EventEmitter new EventEmitter() defaultMaxListeners on() addListener() prependListener() once() prependOnceListener() off() removeListener() removeAllListeners() setMaxListeners() getMaxListeners() listeners() listenerCount() eventNames() emit() object->EventEmitter WebSocket WebSocket new WebSocket() url protocol origin readyState onopen onmessage onclose onerror close() send() ref() unref() EventEmitter->WebSocket

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 la source de simulation pendant 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, 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é statique

defaultMaxListeners

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

1
static Integer WebSocket.defaultMaxListeners;

Attribut de membre

url

Chaîne, interrogez le serveur auquel l'objet actuel est connecté 

1
readonly String WebSocket.url;

protocol

Chaîne, interrogez le protocole lorsque l'objet actuel est connecté 

1
readonly String WebSocket.protocol;

origin

String, interroge la source de la connexion d'objet actuelle 

1
readonly String WebSocket.origin;

readyState

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

1
readonly Integer WebSocket.readyState;

onopen

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

1
Function WebSocket.onopen;

onmessage

Evénements de fonction, de requête et de liaison reçus au message de l'autre partie, équivalent à on ("message", func); 

1
Function WebSocket.onmessage;

onclose

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

1
Function WebSocket.onclose;

onerror

Fonction, requête et événement d'occurrence d'erreur de liaison, équivalent à on ("error", func); 

1
Function WebSocket.onerror;

Fonction membre

close

Fermez la connexion actuelle, 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 : String, 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 à envoyer

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 à envoyer

ref

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

1
WebSocket WebSocket.ref();

Résultat de retour:

  • WebSocket , retourne l'objet actuel

unref

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

1
WebSocket WebSocket.unref();

Résultat de retour:

  • WebSocket , retourne l'objet actuel

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 : Function, spécifiez la fonction de traitement des événements

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, ce qui est pratique pour les appels chaînés

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

1
Object WebSocket.on(Object map);

Paramètres d'appel:

  • map : Object, spécifie la relation de mappage d'événements, le nom d'attribut d'objet sera utilisé comme nom d'événement et la valeur d'attribut sera utilisée comme gestionnaire d'événements

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, ce qui est pratique pour les appels chaînés

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 : Function, spécifiez la fonction de traitement des événements

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, ce qui est pratique pour les appels chaînés

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

1
Object WebSocket.addListener(Object map);

Paramètres d'appel:

  • map : Object, spécifie la relation de mappage d'événements, le nom d'attribut d'objet sera utilisé comme nom d'événement et la valeur d'attribut sera utilisée comme gestionnaire d'événements

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, ce qui est pratique pour les appels chaînés

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 : Function, spécifiez la fonction de traitement des événements

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, ce qui est pratique pour les appels chaînés

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

1
Object WebSocket.prependListener(Object map);

Paramètres d'appel:

  • map : Object, spécifie la relation de mappage d'événements, le nom d'attribut d'objet sera utilisé comme nom d'événement et la valeur d'attribut sera utilisée comme gestionnaire d'événements

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, ce qui est pratique pour les appels chaînés

once

Lier un gestionnaire d'événements ponctuel à l'objet, le gestionnaire ponctuel ne se déclenchera 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 : Function, spécifiez la fonction de traitement des événements

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, ce qui est pratique pour les appels chaînés

Lier un gestionnaire d'événements ponctuel à l'objet, le gestionnaire ponctuel ne se déclenchera qu'une seule fois 

1
Object WebSocket.once(Object map);

Paramètres d'appel:

  • map : Object, spécifie la relation de mappage d'événements, le nom d'attribut d'objet sera utilisé comme nom d'événement et la valeur d'attribut sera utilisée comme gestionnaire d'événements

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, ce qui est pratique pour les appels chaînés

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 : Function, spécifiez la fonction de traitement des événements

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, ce qui est pratique pour les appels chaînés

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

1
Object WebSocket.prependOnceListener(Object map);

Paramètres d'appel:

  • map : Object, spécifie la relation de mappage d'événements, le nom d'attribut d'objet sera utilisé comme nom d'événement et la valeur d'attribut sera utilisée comme gestionnaire d'événements

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, ce qui est pratique pour les appels chaînés

off

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

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

Paramètres d'appel:

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

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, ce qui est pratique pour les appels chaînés

Annuler toutes les fonctions de la file d'attente de traitement d'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, ce qui est pratique pour les appels chaînés

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

1
Object WebSocket.off(Object map);

Paramètres d'appel:

  • map : Object, spécifie la relation de mappage d'événements, le nom d'attribut d'objet est utilisé comme nom d'événement et la valeur d'attribut est utilisée comme fonction de traitement d'événement

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, ce qui est pratique pour les appels chaînés

removeListener

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

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

Paramètres d'appel:

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

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, ce qui est pratique pour les appels chaînés

Annuler toutes les fonctions de la file d'attente de traitement d'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, ce qui est pratique pour les appels chaînés

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

1
Object WebSocket.removeListener(Object map);

Paramètres d'appel:

  • map : Object, spécifie la relation de mappage d'événements, le nom d'attribut d'objet est utilisé comme nom d'événement et la valeur d'attribut est utilisée comme fonction de traitement d'événement

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, ce qui est pratique pour les appels chaînés

removeAllListeners

Annulez tous les écouteurs de tous les événements de la file d'attente de traitement d'objets et, si des événements spécifiés, supprimez tous les écouteurs des événements spécifiés. 

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, ce qui est pratique pour les appels chaînés

setMaxListeners

Le nombre limite d'auditeurs par défaut, uniquement pour des raisons de compatibilité 

1
WebSocket.setMaxListeners(Integer n);

Paramètres d'appel:

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

getMaxListeners

Obtenez le nombre d'écouteurs par défaut, 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 , retourne 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 , renvoie un tableau de noms d'événements

emit

Déclencher activement un événement 

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

Paramètres d'appel:

  • ev : chaîne, nom de l'événement
  • args : ..., les paramètres d'événement seront transmis à la fonction de gestionnaire d'événement

Résultat de retour:

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

toString

Renvoie une 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 une 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, inutilisée

Résultat de retour:

  • Value , retourne une valeur contenant JSON sérialisable
© Copyright 2014-2019 fibjs.org | Soutenez-nous