Объект встроенный объект

Объект WebSocketMessage

объект сообщения websocket

Способ создания:

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

Наследование

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

Конструктор

WebSocketMessage

Конструктор объекта сообщения обработки пакета

1 2 3 4
new WebSocketMessage(Integer type = ws.BINARY, Boolean masked = true, Boolean compress = false, Integer maxSize = 67108864);

Параметры звонка:

  • type: Целое число, тип сообщения websocket, по умолчанию - websocket.BINARY.
  • masked: Логическое значение, маска сообщения веб-сокета, по умолчанию - истина
  • compress: Boolean, отметьте, сжато ли сообщение, по умолчанию false
  • maxSize: Целое число, максимальный размер пакета в МБ, значение по умолчанию - 67108864 (64 МБ).

постоянный

TEXT

Укажите тип сообщения 1, который представляет тип текста

1
const WebSocketMessage.TEXT = 1;

BINARY

Укажите тип сообщения 2, который представляет двоичный тип

1
const WebSocketMessage.BINARY = 2;

Атрибуты члена

masked

Логическое значение, запрос и чтение метки маски веб-сокета, значение по умолчанию - истина

1
Boolean WebSocketMessage.masked;

compress

Логическое значение, запрос и чтение состояния сжатия веб-сокета, по умолчанию - false

1
Boolean WebSocketMessage.compress;

maxSize

Целое число, запрос и установка максимального размера пакета в байтах, по умолчанию 67108864 (64M).

1
Integer WebSocketMessage.maxSize;

value

Строка, основное содержание сообщения

1
String WebSocketMessage.value;

params

NArray, основные параметры сообщения

1
readonly NArray WebSocketMessage.params;

type

Целое число, тип сообщения

1
Integer WebSocketMessage.type;

data

Значение, запрашивать данные сообщения, этот атрибут будет возвращать разные данные в соответствии с типом содержимого, когда это текст, он возвращает текст, который json При возвращении json, В других случаях вернуться к двоичному

1
readonly Value WebSocketMessage.data;

body

SeekableStream, Объект потока, который содержит часть сообщения с данными.

1
SeekableStream WebSocketMessage.body;

length

Long, длина информационной части сообщения.

1
readonly Long WebSocketMessage.length;

stream

Stream, Запрашивать объект потока при чтении сообщения

1
readonly Stream WebSocketMessage.stream;

lastError

Строка, запрос и установка последней ошибки обработки сообщения

1
String WebSocketMessage.lastError;

Функция члена

read

Считать данные указанного размера из потока, этот метод является псевдонимом соответствующего метода тела

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

Параметры звонка:

  • bytes: Целое число, укажите объем данных для чтения, по умолчанию следует читать блок данных произвольного размера, размер считываемых данных зависит от устройства.

Результат возврата:

  • Buffer, Верните данные, прочитанные из потока, если нет данных для чтения или соединение прервано, то верните ноль

readAll

Прочитать все оставшиеся данные из потока, этот метод является псевдонимом соответствующего метода тела

1
Buffer WebSocketMessage.readAll() async;

Результат возврата:

  • Buffer, Верните данные, прочитанные из потока, если нет данных для чтения или соединение прервано, то верните ноль

write

Запишите заданные данные, этот метод является псевдонимом соответствующего метода тела

1
WebSocketMessage.write(Buffer data) async;

Параметры звонка:

  • data: Buffer, Учитывая данные для записи

json

Запишите данные в кодировке JSON

1
Value WebSocketMessage.json(Value data);

Параметры звонка:

  • data: Значение, учитывая данные для записи

Результат возврата:

  • Value, Этот метод не вернет данные

Анализируйте данные в сообщении в кодировке JSON

1
Value WebSocketMessage.json();

Результат возврата:

  • Value, Вернуть проанализированный результат

pack

к msgpack Кодировать для записи заданных данных

1
Value WebSocketMessage.pack(Value data);

Параметры звонка:

  • data: Значение, учитывая данные для записи

Результат возврата:

  • Value, Этот метод не вернет данные

к msgpack Кодирование и анализ данных в сообщении

1
Value WebSocketMessage.pack();

Результат возврата:

  • Value, Вернуть проанализированный результат

end

Установить конец обработки текущего сообщения,Chain Процессор не продолжает последующие транзакции

1
WebSocketMessage.end();

isEnded

Запросить, закончилось ли текущее сообщение

1
Boolean WebSocketMessage.isEnded();

Результат возврата:

  • Boolean, Верните истину в конце

clear

Очистить содержание сообщения

1
WebSocketMessage.clear();

sendTo

Отправить отформатированное сообщение заданному объекту потока

1
WebSocketMessage.sendTo(Stream stm) async;

Параметры звонка:

  • stm: Stream, Укажите объект потока для получения форматированных сообщений

readFrom

Прочтите отформатированное сообщение из данного объекта потока кэша и проанализируйте объект заполнения

1
WebSocketMessage.readFrom(Stream stm) async;

Параметры звонка:

  • stm: Stream, Укажите объект потока для чтения форматированных сообщений

toString

Возвращает строковое представление объекта, обычно возвращает «[Native Object]», объект может быть повторно реализован в соответствии с его собственными характеристиками.

1
String WebSocketMessage.toString();

Результат возврата:

  • String, Возвращает строковое представление объекта

toJSON

Возвращает представление объекта в формате JSON, обычно возвращает набор читаемых атрибутов, определенных объектом.

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

Параметры звонка:

  • key: Строка, не используется

Результат возврата:

  • Value, Возвращает значение, содержащее сериализуемый JSON