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

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 : Integer, 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 : Boolean, marque si le message est compressé, la valeur par défaut est false
  • maxSize : Integer, la taille maximale du paquet, en Mo, la valeur par défaut est 67108864 (64 Mo)

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

Boolean, interroger et lire l'état de la compression Websocket, la valeur par défaut est false

1
Boolean WebSocketMessage.compress;

maxSize

Entier, interrogez et définissez la taille maximale des paquets, en octets, la valeur par défaut est 67108864 (64 Mo)

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

Valeur, interrogez les données du message

1
readonly Value WebSocketMessage.data;

body

SeekableStream , un objet de flux contenant 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 , l'objet de flux lors de l'interrogation du message readFrom

1
readonly Stream WebSocketMessage.stream;

lastError

Chaîne, interroge et définit la dernière erreur de traitement des messages

1
String WebSocketMessage.lastError;

Fonction membre

read

Lire les données de la taille spécifiée dans le flux, cette méthode est un 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 des blocs de données de taille aléatoire, la taille des données lues dépend de l'appareil

Résultat de retour:

  • Buffer , retourne les données lues dans le flux, s'il n'y a pas de données à lire, ou si la connexion est interrompue, elle retourne 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 , retourne les données lues dans le flux, s'il n'y a pas de données à lire, ou si la connexion est interrompue, elle retourne null

write

Écrivez 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 , compte tenu des données à écrire

json

Ecrire les données données dans l'encodage JSON

1
Value WebSocketMessage.json(Value data);

Paramètres d'appel:

  • data : Valeur, compte tenu des données à écrire

Résultat de retour:

  • Value , cette méthode ne retournera pas de données

Analyser les données du message en encodage JSON

1
Value WebSocketMessage.json();

Résultat de retour:

  • Value , renvoie le résultat analysé

end

Définissez la fin du traitement des messages en cours et le processeur de Chain ne poursuivra plus les transactions suivantes

1
WebSocketMessage.end();

isEnded

Demander si le message actuel est terminé

1
Boolean WebSocketMessage.isEnded();

Résultat de retour:

  • Boolean , renvoie true à 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écifie l'objet de flux qui reçoit 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écifie l'objet de flux pour la lecture des messages formatés

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 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ée

Résultat de retour:

  • Value , renvoie une valeur contenant JSON sérialisable