Oggetto oggetto incorporato

Oggetto WebSocketMessage

oggetto messaggio websocket

Crea metodo:

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

rapporto di eredità

#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()

Costruttore

WebSocketMessage

Costruttore di oggetti messaggio per la gestione dei 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, l'impostazione predefinita è websocket.BINARY
  • masked: Booleano, maschera messaggio websocket, l'impostazione predefinita è true
  • compress: Booleano, indica se il messaggio è compresso, l'impostazione predefinita è false
  • 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

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

1
const WebSocketMessage.BINARY = 2;

Proprietà dei membri

masked

Booleano, interroga e leggi il flag della maschera websocket, l'impostazione predefinita è true

1
Boolean WebSocketMessage.masked;

compress

Booleano, interroga e leggi lo stato di compressione del websocket, l'impostazione predefinita è false

1
Boolean WebSocketMessage.compress;

maxSize

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

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

Intero, tipo di messaggio

1
Integer WebSocketMessage.type;

data

Valore, interroga i dati del messaggio, questa proprietà restituirà dati diversi in base al tipo di contenuto, quando è testo, restituirà il testo, che èjsontornare quandojson, altrimenti restituisce binario

1
readonly Value WebSocketMessage.data;

body

SeekableStream, un oggetto flusso contenente la parte di dati del messaggio

1
SeekableStream WebSocketMessage.body;

length

Long, la lunghezza della parte dei dati del messaggio

1
readonly Long WebSocketMessage.length;

stream

Stream, l'oggetto stream durante la query del messaggio readFrom

1
readonly Stream WebSocketMessage.stream;

lastError

String, l'ultimo errore per la query e l'elaborazione dei messaggi impostati

1
String WebSocketMessage.lastError;

funzione membro

read

Leggi i dati della dimensione specificata dal flusso, questo metodo è un alias del metodo del corpo corrispondente

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

Parametri di chiamata:

  • bytes: Intero, specifica la quantità di dati da leggere, l'impostazione predefinita è leggere un blocco di dati di dimensioni casuali, la dimensione dei dati letti dipende dal dispositivo

Risultato di ritorno:

  • Buffer, restituisce i dati letti dal flusso o null se non ci sono dati da leggere o la connessione è interrotta

readAll

Leggi tutti i dati rimanenti dal flusso, questo metodo è l'alias del metodo di body corrispondente

1
Buffer WebSocketMessage.readAll() async;

Risultato di ritorno:

  • Buffer, restituisce i dati letti dal flusso o null se non ci sono dati da leggere o la connessione è interrotta

write

Scrive i dati forniti, questo metodo è un alias del metodo body corrispondente

1
WebSocketMessage.write(Buffer data) async;

Parametri di chiamata:

  • data:Buffer, dati i dati da scrivere

json

Scrive 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 restituirà dati

Analizza i dati nel messaggio nella codifica JSON

1
Value WebSocketMessage.json();

Risultato di ritorno:

  • Value, restituisce il risultato analizzato

pack

dimsgpackCodificare per scrivere i dati forniti

1
Value WebSocketMessage.pack(Value data);

Parametri di chiamata:

  • data: Valore, dati i dati da scrivere

Risultato di ritorno:

  • Value, questo metodo non restituirà dati

dimsgpackCodifica e analisi dei dati nel messaggio

1
Value WebSocketMessage.pack();

Risultato di ritorno:

  • Value, restituisce il risultato analizzato

end

Imposta la fine dell'elaborazione del messaggio corrente,ChainIl processore non continua con le transazioni successive

1
WebSocketMessage.end();

isEnded

Domanda se il messaggio corrente è finito

1
Boolean WebSocketMessage.isEnded();

Risultato di ritorno:

  • Boolean, ritorna vero al termine

clear

Cancella il contenuto del messaggio

1
WebSocketMessage.clear();

sendTo

Invia un messaggio formattato all'oggetto flusso specificato

1
WebSocketMessage.sendTo(Stream stm) async;

Parametri di chiamata:

  • stm:Stream, specificando l'oggetto flusso per ricevere i messaggi formattati

readFrom

Legge i messaggi formattati dall'oggetto flusso cache specificato e analizza l'oggetto riempimento

1
WebSocketMessage.readFrom(Stream stm) async;

Parametri di chiamata:

  • stm:Stream, specifica l'oggetto flusso da cui leggere i messaggi formattati

toString

Restituisce la rappresentazione in stringa dell'oggetto, generalmente restituisce "[Native Object]", l'oggetto può essere reimplementato secondo le proprie caratteristiche

1
String WebSocketMessage.toString();

Risultato di ritorno:

  • String, restituisce la rappresentazione di stringa dell'oggetto

toJSON

Restituisce la rappresentazione in formato JSON dell'oggetto, generalmente restituisce l'insieme di proprietà leggibili definite dall'oggetto

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

Parametri di chiamata:

  • key: Stringa, non utilizzata

Risultato di ritorno:

  • Value, restituisce un valore contenente JSON serializzabile