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

Объект 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

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

Считывает данные указанного размера из потока. Этот метод является псевдонимом для соответствующего метода body.

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

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

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

Возвращает результат:

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

readAll

Считайте все оставшиеся данные из потока. Этот метод является псевдонимом для соответствующего метода body.

1
Buffer WebSocketMessage.readAll() async;

Возвращает результат:

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

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 , возвращает истину в конце

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