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

Объект WebSocketMessage

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

Как создать:

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

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

Конструктор

WebSocketMessage

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

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

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

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

постоянная

TEXT

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

1
const WebSocketMessage.TEXT = 1;

BINARY

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

1
const WebSocketMessage.BINARY = 2;

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

masked

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

1
Boolean WebSocketMessage.masked;

compress

Boolean, запрашивать и читать состояние сжатия websocket, по умолчанию 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

Значение, запросить данные сообщения

1
readonly Value WebSocketMessage.data;

body

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

1
SeekableStream WebSocketMessage.body;

length

Long, длина части данных сообщения

1
readonly Long WebSocketMessage.length;

stream

Stream , объект потока при запросе сообщения readFrom

1
readonly Stream WebSocketMessage.stream;

lastError

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

1
String WebSocketMessage.lastError;

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

read

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

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

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

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

Вернуть результат:

  • 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 , вернуть проанализированный результат

end

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

1
WebSocketMessage.end();

isEnded

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

1
Boolean WebSocketMessage.isEnded();

Вернуть результат:

  • Boolean , вернуть true в конце

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