Object Message

Basic message object

The Message object is compatible with all modules of mq and can be used to build a custom message processing system. The creation method:

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

Inheritance

Constructor

Message

Message object constructor

1
new Message();

constant

TEXT

Specify message type 1, which represents a text type

1
const Message.TEXT = 1;

BINARY

Specify message type 2, which represents a binary type

1
const Message.BINARY = 2;

Member attributes

value

String, the basic content of the message

1
String Message.value;

params

NArray, the basic parameters of the message

1
readonly NArray Message.params;

type

Integer, message type

1
Integer Message.type;

data

Value, query the data of the message

1
readonly Value Message.data;

body

SeekableStream , a stream object containing the data part of the message

1
SeekableStream Message.body;

length

Long, the length of the message data part

1
readonly Long Message.length;

stream

Stream , the stream object when querying the message readFrom

1
readonly Stream Message.stream;

lastError

String, query and set the last error of message processing

1
String Message.lastError;

Member function

read

Read data of the specified size from the stream, this method is an alias of the corresponding method of body

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

Call parameters:

• bytes : Integer, specify the amount of data to be read, the default is to read data blocks of random size, the size of the data read depends on the device

Return result:

• Buffer , returns the data read from the stream, if there is no data to read, or the connection is interrupted, it returns null

readAll

Read all remaining data from the stream, this method is an alias of the corresponding method of body

1
Buffer Message.readAll() async;

Return result:

• Buffer , returns the data read from the stream, if there is no data to read, or the connection is interrupted, it returns null

write

Write the given data, this method is the alias of the corresponding method of body

1
Message.write(Buffer data) async;

Call parameters:

• data : Buffer , given the data to be written

json

Write the given data in JSON encoding

1
Value Message.json(Value data);

Call parameters:

• data : Value, given the data to be written

Return result:

• Value , this method will not return data

Parse the data in the message in JSON encoding

1
Value Message.json();

Return result:

• Value , returns the parsed result

end

Set the current message processing to end, and the Chain processor will not continue subsequent transactions

1
Message.end();

isEnded

Query whether the current message is over

1
Boolean Message.isEnded();

Return result:

• Boolean , return true at the end

clear

Clear the content of the message

1
Message.clear();

sendTo

Send a formatted message to the given stream object

1
Message.sendTo(Stream stm) async;

Call parameters:

• stm : Stream , specifies the stream object that receives formatted messages

readFrom

Read the formatted message from the given cache stream object, and parse the filling object

1
Message.readFrom(Stream stm) async;

Call parameters:

• stm : Stream , specifies the stream object for reading formatted messages

toString

Returns the string representation of the object, generally returns "[Native Object]", the object can be re-implemented according to its own characteristics

1
String Message.toString();

Return result:

• String , returns the string representation of the object

toJSON

Returns the JSON format representation of the object, generally returns a collection of readable attributes defined by the object

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

Call parameters:

• key : String, unused

Return result:

• Value , returns a value containing JSON serializable