Oggetto oggetto incorporato

Oggetto WebSocketMessage

oggetto messaggio websocket

Come creare:

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

Eredità

Costruttore

WebSocketMessage

Costruttore di oggetti messaggio di elaborazione pacchetti

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

Parametri di chiamata:

  • type : intero, tipo di messaggio websocket, il valore predefinito è websocket.BINARY
  • masked : booleano, maschera messaggio websocket, il valore predefinito è true
  • compress : booleano, segna se il messaggio è compresso, il valore predefinito è falso
  • maxSize : intero, la dimensione massima del pacchetto, in MB, il valore predefinito è 67108864 (64M)

costante

TEXT

Specificare il tipo di messaggio 1, che rappresenta un tipo di testo

1
const WebSocketMessage.TEXT = 1;

BINARY

Specificare il tipo di messaggio 2, che rappresenta un tipo binario

1
const WebSocketMessage.BINARY = 2;

Attributo membro

masked

Booleano, query e lettura tag maschera WebSocket, l'impostazione predefinita è vera

1
Boolean WebSocketMessage.masked;

compress

Booleano, interroga e leggi lo stato di compressione del websocket, il valore predefinito è false

1
Boolean WebSocketMessage.compress;

maxSize

Numero intero, interroga e imposta la dimensione massima del pacchetto, in byte, il valore predefinito è 67108864 (64 M)

1
Integer WebSocketMessage.maxSize;

value

String, il contenuto di base del messaggio

1
String WebSocketMessage.value;

params

NArray, i parametri di base del messaggio

1
readonly NArray WebSocketMessage.params;

type

Numero intero, tipo di messaggio

1
Integer WebSocketMessage.type;

data

Valore, query dei dati dei messaggi

1
readonly Value WebSocketMessage.data;

body

SeekableStream , un oggetto stream contenente la parte dati del messaggio

1
SeekableStream WebSocketMessage.body;

length

Lungo, la lunghezza della parte di dati del messaggio

1
readonly Long WebSocketMessage.length;

stream

Stream , l'oggetto stream durante l'interrogazione del messaggio readFrom

1
readonly Stream WebSocketMessage.stream;

lastError

String, l'ultimo errore di interrogazione e impostazione dell'elaborazione dei messaggi

1
String WebSocketMessage.lastError;

Funzione membro

read

Leggi i dati della dimensione specificata dallo stream, questo metodo è un alias per il metodo body corrispondente

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

Parametri di chiamata:

  • bytes : numero intero, specifica la quantità di dati da leggere, il valore predefinito è leggere blocchi di dati di dimensioni casuali, la dimensione dei dati letti dipende dal dispositivo

Risultato di ritorno:

  • Buffer , restituisce i dati letti dallo stream o null se non è possibile leggere dati o la connessione viene interrotta

readAll

Leggi tutti i dati rimanenti dallo stream, questo metodo è un alias per il corrispondente metodo di body

1
Buffer WebSocketMessage.readAll() async;

Risultato di ritorno:

  • Buffer , restituisce i dati letti dallo stream o null se non è possibile leggere dati o la connessione viene interrotta

write

Scrivi i dati forniti, questo metodo è un alias per il corrispondente metodo di body

1
WebSocketMessage.write(Buffer data) async;

Parametri di chiamata:

  • data : Buffer , dati dati da scrivere

json

Scrivi i dati forniti nella codifica JSON

1
Value WebSocketMessage.json(Value data);

Parametri di chiamata:

  • data : valore, dati i dati da scrivere

Risultato di ritorno:

  • Value , questo metodo non restituisce dati

Analizzare i dati nel messaggio nella codifica JSON

1
Value WebSocketMessage.json();

Risultato di ritorno:

  • Value , restituisce il risultato analizzato

end

Impostare l'elaborazione del messaggio corrente su end, Processor Chain non continuerà la transazione successiva

1
WebSocketMessage.end();

isEnded

Verifica se il messaggio corrente è finito

1
Boolean WebSocketMessage.isEnded();

Risultato di ritorno:

  • Boolean , torna vero alla fine

clear

Cancella il contenuto del messaggio

1
WebSocketMessage.clear();

sendTo

Invia messaggi formattati all'oggetto stream specificato

1
WebSocketMessage.sendTo(Stream stm) async;

Parametri di chiamata:

  • stm : Stream , specifica l'oggetto stream per ricevere messaggi formattati

readFrom

Leggi il messaggio formattato dall'oggetto flusso di cache specificato e analizza l'oggetto di riempimento

1
WebSocketMessage.readFrom(Stream stm) async;

Parametri di chiamata:

  • stm : Stream , specifica un oggetto stream per leggere i messaggi formattati

toString

Restituisce la rappresentazione in forma di stringa dell'oggetto, in genere restituisce "[Native Object]", l'oggetto può essere reimplementato in base alle proprie caratteristiche

1
String WebSocketMessage.toString();

Risultato di ritorno:

  • String , restituisce una rappresentazione in formato stringa dell'oggetto

toJSON

Restituisce la rappresentazione in formato JSON dell'oggetto, in genere restituisce una raccolta di attributi leggibili definiti dall'oggetto

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

Parametri di chiamata:

  • key : stringa, non utilizzata

Risultato di ritorno:

  • Value , restituisce un valore contenente serializzabile JSON