Oggetto oggetto incorporato

Oggetto WebSocketMessage

oggetto messaggio websocket

Metodo di creazione:

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

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 di elaborazione del pacchetto

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, l'impostazione predefinita è true
  • compress: booleano, segna se il messaggio è compresso, l'impostazione predefinita è false
  • maxSize: Intero, la dimensione massima del pacchetto, in MB, il valore predefinito è 67108864 (64M)

costante

TEXT

Specifica il tipo di messaggio 1, che rappresenta un tipo di testo text

1
const WebSocketMessage.TEXT = 1;

BINARY

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

1
const WebSocketMessage.BINARY = 2;

Attributi dei membri

masked

Booleano, interroga e leggi il contrassegno maschera websocket, il valore predefinito è vero

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 base del messaggio

1
String WebSocketMessage.value;

params

NArray, i parametri base del messaggio

1
readonly NArray WebSocketMessage.params;

type

Intero, tipo di messaggio

1
Integer WebSocketMessage.type;

data

Valore, interroga i dati del messaggio, questo attributo restituirà dati diversi a seconda del tipo di contenuto, quando è testo, restituisce il testo, che è json Al ritorno json, Altre volte torna al binario

1
readonly Value WebSocketMessage.data;

body

SeekableStream, L'oggetto stream che contiene la parte dati del messaggio

1
SeekableStream WebSocketMessage.body;

length

Long, la lunghezza della parte dati del messaggio

1
readonly Long WebSocketMessage.length;

stream

Stream, Interroga l'oggetto stream quando il messaggio readFrom

1
readonly Stream WebSocketMessage.stream;

lastError

Stringa, interroga e imposta l'ultimo errore di elaborazione del messaggio

1
String WebSocketMessage.lastError;

Funzione membro

read

Leggi i dati della dimensione specificata dal flusso, questo metodo è l'alias del metodo corrispondente di body

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

Parametri di chiamata:

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

Risultato di ritorno:

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

readAll

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

1
Buffer WebSocketMessage.readAll() async;

Risultato di ritorno:

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

write

Scrivi i dati forniti, questo metodo è l'alias del corrispondente metodo di body

1
WebSocketMessage.write(Buffer data) async;

Parametri di chiamata:

  • data: Buffer, Dati i 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 restituirà dati

Analizza i dati nel messaggio nella codifica JSON

1
Value WebSocketMessage.json();

Risultato di ritorno:

  • Value, Restituisce il risultato analizzato

pack

Per msgpack Codifica 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

Per msgpack Codifica 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,Chain Il processore non continua le transazioni successive

1
WebSocketMessage.end();

isEnded

Interroga se il messaggio corrente è finito

1
Boolean WebSocketMessage.isEnded();

Risultato di ritorno:

  • Boolean, restituisce true alla fine

clear

Cancella il contenuto del messaggio

1
WebSocketMessage.clear();

sendTo

Invia un messaggio formattato all'oggetto stream specificato

1
WebSocketMessage.sendTo(Stream stm) async;

Parametri di chiamata:

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

readFrom

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

1
WebSocketMessage.readFrom(Stream stm) async;

Parametri di chiamata:

  • stm: Stream, Specifica l'oggetto stream per leggere i messaggi formattati

toString

Restituisce la rappresentazione in stringa dell'oggetto, generalmente restituisce "[Native Object]", l'oggetto può essere re-implementato 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 una raccolta di attributi leggibili definiti dall'oggetto

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

Parametri di chiamata:

  • key: Stringa, inutilizzata

Risultato di ritorno:

  • Value, Restituisce un valore contenente JSON serializzabile