Oggetto oggetto incorporato

Messaggio oggetto

Oggetto messaggio di base

L'oggetto Messaggio è compatibile con mq Ogni modulo può essere utilizzato per costruire un sistema di elaborazione dei messaggi personalizzato, creando metodi:

1 2
var mq = require("mq"); var m = new mq.Message();

Eredità

#lineWidth: 1.5 #font: Helvetica,sans-Serif #fontSize: 10 #leading: 1.6 #.this: fill=lightgray #.class: fill=white [<class>object|toString();toJSON()] [<this>Message|new Message()|TEXT;BINARY|value;params;type;data;body;length;stream;lastError|read();readAll();write();json();pack();end();isEnded();clear();sendTo();readFrom()] [<class>HttpMessage] [<class>HttpRequest] [<class>HttpResponse] [<class>WebSocketMessage] [object] <:- [Message] [Message] <:- [HttpMessage] [HttpMessage] <:- [HttpRequest] [HttpMessage] <:- [HttpResponse] [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() object toString() toJSON() HttpMessage HttpRequest HttpResponse WebSocketMessage

Costruttore

Message

Costruttore di oggetti messaggio

1
new Message();

costante

TEXT

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

1
const Message.TEXT = 1;

BINARY

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

1
const Message.BINARY = 2;

Attributi dei membri

value

String, il contenuto base del messaggio

1
String Message.value;

params

NArray, i parametri base del messaggio

1
readonly NArray Message.params;

type

Intero, tipo di messaggio

1
Integer Message.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 Message.data;

body

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

1
SeekableStream Message.body;

length

Long, la lunghezza della parte dati del messaggio

1
readonly Long Message.length;

stream

Stream, Interroga l'oggetto stream quando il messaggio readFrom

1
readonly Stream Message.stream;

lastError

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

1
String Message.lastError;

Funzione membro

read

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

1
Buffer Message.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

readAll

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

1
Buffer Message.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

write

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

1
Message.write(Buffer data) async;

Parametri di chiamata:

  • data: Buffer, Dati i dati da scrivere

json

Scrivi i dati forniti nella codifica JSON

1
Value Message.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 Message.json();

Risultato di ritorno:

  • Value, Restituisce il risultato analizzato

pack

di msgpack Codifica per scrivere i dati forniti

1
Value Message.pack(Value data);

Parametri di chiamata:

  • data: Valore, dati i dati da scrivere

Risultato di ritorno:

  • Value, Questo metodo non restituirà dati

di msgpack Codifica e analisi dei dati nel messaggio

1
Value Message.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
Message.end();

isEnded

Interroga se il messaggio corrente è finito

1
Boolean Message.isEnded();

Risultato di ritorno:

  • Boolean, restituisce true alla fine

clear

Cancella il contenuto del messaggio

1
Message.clear();

sendTo

Invia un messaggio formattato all'oggetto stream specificato

1
Message.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
Message.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 Message.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 Message.toJSON(String key = "");

Parametri di chiamata:

  • key: Stringa, inutilizzata

Risultato di ritorno:

  • Value, Restituisce un valore contenente JSON serializzabile