Oggetto oggetto incorporato

Oggetto WebSocketMessage

oggetto messaggio websocket

Metodo di creazione:

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

Eredità

Costruttore

WebSocketMessage

Costruttore dell'oggetto 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 : numero intero, tipo di messaggio websocket, il valore predefinito è websocket.BINARY
  • masked : booleano, maschera messaggio websocket, il valore predefinito è true
  • compress : booleano, contrassegna se il messaggio è compresso, il valore predefinito è false
  • maxSize : Integer, 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;

Attributi dei membri

masked

Booleano, interroga e legge il contrassegno maschera websocket, il valore predefinito è true

1
Boolean WebSocketMessage.masked;

compress

Booleano, query e lettura dello stato di compressione websocket, il valore predefinito è 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

Value, interroga i dati del messaggio

1
readonly Value WebSocketMessage.data;

body

SeekableStream , un oggetto flusso contenente la parte 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

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 è un alias del metodo di body corrispondente

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

Parametri di chiamata:

  • bytes : numero intero, specifica la quantità di dati da leggere, l'impostazione predefinita è 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, se non ci sono dati da leggere, o la connessione viene interrotta, restituisce null

readAll

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

1
Buffer WebSocketMessage.readAll() async;

Risultato di ritorno:

  • Buffer , restituisce i dati letti dallo stream, se non ci sono dati da leggere, o la connessione viene interrotta, restituisce null

write

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

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

end

Imposta la fine dell'elaborazione del messaggio corrente e il Chain Processor non continuerà le transazioni successive

1
WebSocketMessage.end();

isEnded

Verifica se il messaggio corrente è terminato

1
Boolean WebSocketMessage.isEnded();

Risultato di ritorno:

  • Boolean , restituisce vero alla fine

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 , specifica l'oggetto stream che riceve i messaggi formattati

readFrom

Leggere il messaggio formattato dall'oggetto flusso di cache specificato e analizzare 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 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 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 JSON serializzabile