Objet objet intégré

Objet WebSocketMessage

objet de message Websocket

Méthode de création :

1 2 3
var ws = require("ws"); var msg = new ws.Message();

Héritage

#lineWidth: 1.5 #font: Helvetica,sans-Serif #fontSize: 10 #leading: 1.6 #.this: fill=lightgray #.class: fill=white [<class>object|toString();toJSON()] [<class>Message|new Message()|TEXT;BINARY|value;params;type;data;body;length;stream;lastError|read();readAll();write();json();pack();end();isEnded();clear();sendTo();readFrom()] [<this>WebSocketMessage|new WebSocketMessage()|masked;compress;maxSize] [object] <:- [Message] [Message] <:- [WebSocketMessage] Message new Message() TEXT BINARY value params type data body length stream lastError read() readAll() write() json() pack() end() isEnded() clear() sendTo() readFrom() WebSocketMessage new WebSocketMessage() masked compress maxSize object toString() toJSON()

Constructeur

WebSocketMessage

Constructeur d'objet de message de traitement de package

1 2 3 4
new WebSocketMessage(Integer type = ws.BINARY, Boolean masked = true, Boolean compress = false, Integer maxSize = 67108864);

Paramètres d'appel :

  • type: Entier, type de message websocket, la valeur par défaut est websocket.BINARY
  • masked: booléen, masque de message websocket, la valeur par défaut est true
  • compress: booléen, indique si le message est compressé, la valeur par défaut est false
  • maxSize: Entier, la taille maximale du package, en Mo, la valeur par défaut est 67108864 (64M)

constant

TEXT

Spécifiez le type de message 1, qui représente un type de texte

1
const WebSocketMessage.TEXT = 1;

BINARY

Spécifiez le type de message 2, qui représente un type binaire

1
const WebSocketMessage.BINARY = 2;

Attributs des membres

masked

Booléen, requête et lecture de la marque de masque Websocket, la valeur par défaut est true

1
Boolean WebSocketMessage.masked;

compress

Booléen, requête et lecture de l'état de compression du Websocket, la valeur par défaut est false

1
Boolean WebSocketMessage.compress;

maxSize

Entier, interrogez et définissez la taille maximale du paquet, en octets, la valeur par défaut est 67108864 (64M)

1
Integer WebSocketMessage.maxSize;

value

String, le contenu de base du message

1
String WebSocketMessage.value;

params

NArray, les paramètres de base du message

1
readonly NArray WebSocketMessage.params;

type

Entier, type de message

1
Integer WebSocketMessage.type;

data

Value, interroge les données du message, cet attribut renverra des données différentes selon le type de contenu, lorsqu'il s'agit de texte, il renvoie le texte, qui est json Au retour json, D'autres fois retournent au binaire

1
readonly Value WebSocketMessage.data;

body

SeekableStream, L'objet de flux qui contient la partie données du message

1
SeekableStream WebSocketMessage.body;

length

Long, la longueur de la partie données du message

1
readonly Long WebSocketMessage.length;

stream

Stream, Interrogez l'objet de flux lorsque le message readFrom

1
readonly Stream WebSocketMessage.stream;

lastError

Chaîne, requête et définition de la dernière erreur de traitement du message

1
String WebSocketMessage.lastError;

Fonction membre

read

Lire les données de la taille spécifiée à partir du flux, cette méthode est l'alias de la méthode correspondante du corps

1
Buffer WebSocketMessage.read(Integer bytes = -1) async;

Paramètres d'appel :

  • bytes: Entier, spécifiez la quantité de données à lire, la valeur par défaut est de lire un bloc de données de taille aléatoire, la taille des données lues dépend de l'appareil

Résultat de retour :

  • Buffer, Renvoie les données lues à partir du flux, s'il n'y a pas de données à lire ou si la connexion est interrompue, renvoie null

readAll

Lire toutes les données restantes du flux, cette méthode est un alias de la méthode correspondante du corps

1
Buffer WebSocketMessage.readAll() async;

Résultat de retour :

  • Buffer, Renvoie les données lues à partir du flux, s'il n'y a pas de données à lire ou si la connexion est interrompue, renvoie null

write

Ecrire les données données, cette méthode est l'alias de la méthode correspondante du corps

1
WebSocketMessage.write(Buffer data) async;

Paramètres d'appel :

  • data: Buffer, Étant donné les données à écrire

json

Écrire les données données en encodage JSON

1
Value WebSocketMessage.json(Value data);

Paramètres d'appel :

  • data: Valeur, étant donné les données à écrire

Résultat de retour :

  • Value, Cette méthode ne renverra pas de données

Analyser les données du message en codage JSON

1
Value WebSocketMessage.json();

Résultat de retour :

  • Value, Renvoie le résultat analysé

pack

par msgpack Encoder pour écrire les données données

1
Value WebSocketMessage.pack(Value data);

Paramètres d'appel :

  • data: Valeur, étant donné les données à écrire

Résultat de retour :

  • Value, Cette méthode ne renverra pas de données

par msgpack Encodage et analyse des données dans le message

1
Value WebSocketMessage.pack();

Résultat de retour :

  • Value, Renvoie le résultat analysé

end

Définir la fin du traitement du message en cours,Chain Le processeur ne poursuit pas les transactions suivantes

1
WebSocketMessage.end();

isEnded

Demander si le message actuel est terminé

1
Boolean WebSocketMessage.isEnded();

Résultat de retour :

  • Boolean, Renvoie vrai à la fin

clear

Effacer le contenu du message

1
WebSocketMessage.clear();

sendTo

Envoyer un message formaté à l'objet de flux donné

1
WebSocketMessage.sendTo(Stream stm) async;

Paramètres d'appel :

  • stm: Stream, Spécifiez l'objet de flux pour recevoir les messages formatés

readFrom

Lire le message formaté à partir de l'objet de flux de cache donné et analyser l'objet de remplissage

1
WebSocketMessage.readFrom(Stream stm) async;

Paramètres d'appel :

  • stm: Stream, Spécifiez l'objet de flux pour lire les messages formatés

toString

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

1
String WebSocketMessage.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 WebSocketMessage.toJSON(String key = "");

Paramètres d'appel :

  • key: chaîne, inutilisé

Résultat de retour :

  • Value, Renvoie une valeur contenant JSON sérialisable