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

Объект WebSocket

Процессор преобразования протокола WebSocket

Используется для преобразования протокола Http в сообщение протокола пакета WebSocket. Создано:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
var ws = require('ws'); var http = require('http'); var serv = new http.Server(8811, ws.upgrade((conn) => { conn.onmessage = msg => { conn.send(new Date()); }; })); serv.run(r => 0); var sock = new ws.Socket('ws://127.0.0.1:8811'); sock.on('open', () => { setInterval(() => { sock.send('get date'); }, 1000); }); sock.onmessage = evt => { console.log(evt.data); }

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

конструктор

WebSocket

Конструктор WebSocket

1 2 3
new WebSocket(String url, String protocol = "", String origin = "");

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

  • url : String, укажите сервер для подключения
  • protocol : String, указывает протокол рукопожатия, по умолчанию ""
  • origin : String, указывает origin симуляции во время рукопожатия, по умолчанию ""

Конструктор WebSocket

1 2
new WebSocket(String url, Object opts = {});

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

  • url : String, укажите сервер для подключения
  • opts : Object, опция соединения, по умолчанию {}, поддерживаемые поля: «protocol», «origin», «headers», «httpClient».

Статическое свойство

defaultMaxListeners

Integer, глобальное максимальное число слушателей по умолчанию

1
static Integer WebSocket.defaultMaxListeners;

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

url

String, запросить сервер, подключенный к текущему объекту

1
readonly String WebSocket.url;

protocol

String, запросить протокол, когда текущий объект подключен

1
readonly String WebSocket.protocol;

origin

Строка, запрос источника текущего соединения объекта

1
readonly String WebSocket.origin;

readyState

Целое число, запросить состояние соединения текущего объекта, см. ws

1
readonly Integer WebSocket.readyState;

onopen

Функция, запрос и событие привязки соединения успешно, эквивалентно on ("open", func);

1
Function WebSocket.onopen;

onmessage

Функция, запрос и связывание события, полученного сообщением другой стороны, эквивалентно on («message», func);

1
Function WebSocket.onmessage;

onclose

Функция, запрос и связывание события закрытия соединения, эквивалентного on («close», func);

1
Function WebSocket.onclose;

onerror

Функция, запрашивает и связывает событие возникновения ошибки, эквивалентно on («error», func);

1
Function WebSocket.onerror;

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

close

Закройте текущее соединение. Эта операция отправит пакет CLOSE другой стороне и будет ждать ответа другой стороны.

1 2
WebSocket.close(Integer code = 1000, String reason = "");

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

  • code : Integer, указывает код для закрытия, допустимое значение 3000-4999 или 1000, по умолчанию 1000
  • reason : строка, указывает причину закрытия, по умолчанию ""

send

Отправить текст другой стороне

1
WebSocket.send(String data);

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

  • data : String, укажите текст для отправки

Отправить часть двоичных данных другой стороне

1
WebSocket.send(Buffer data);

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

  • data : Buffer , укажите двоичные данные для отправки

ref

Не допускайте выхода процесса fibjs и не допускайте выхода процесса fibjs во время привязки объекта

1
WebSocket WebSocket.ref();

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

  • WebSocket , возвращает текущий объект

unref

Разрешить выход из процесса fibjs, разрешить выход из процесса fibjs во время привязки объекта

1
WebSocket WebSocket.unref();

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

  • WebSocket , возвращает текущий объект

on

Привязать обработчик событий к объекту

1 2
Object WebSocket.on(String ev, Function func);

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

  • ev : String, имя указанного события
  • func : Функция, указать функцию обработчика события

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

  • Object , возвращает количество успешных привязок или 0, если функция связана

Привязать обработчик событий к объекту

1
Object WebSocket.on(Object map);

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

  • map : Object, указывает отношение отображения события, имя свойства объекта будет использоваться в качестве имени события, а значение свойства будет использоваться в качестве обработчика события

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

  • Object , возвращает сам объект события, что удобно для цепных вызовов

addListener

Привязать обработчик событий к объекту

1 2
Object WebSocket.addListener(String ev, Function func);

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

  • ev : String, имя указанного события
  • func : Функция, указать функцию обработчика события

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

  • Object , возвращает сам объект события, что удобно для цепных вызовов

Привязать обработчик событий к объекту

1
Object WebSocket.addListener(Object map);

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

  • map : Object, указывает отношение отображения события, имя свойства объекта будет использоваться в качестве имени события, а значение свойства будет использоваться в качестве обработчика события

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

  • Object , возвращает сам объект события, что удобно для цепных вызовов

prependListener

Привязать обработчик событий к началу объекта

1 2
Object WebSocket.prependListener(String ev, Function func);

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

  • ev : String, имя указанного события
  • func : Функция, указать функцию обработчика события

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

  • Object , возвращает количество успешных привязок или 0, если функция связана

Привязать обработчик событий к началу объекта

1
Object WebSocket.prependListener(Object map);

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

  • map : Object, указывает отношение отображения события, имя свойства объекта будет использоваться в качестве имени события, а значение свойства будет использоваться в качестве обработчика события

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

  • Object , возвращает количество успешных привязок или 0, если функция связана

once

Привязать одноразовый обработчик событий к объекту. Одноразовый обработчик будет срабатывать только один раз.

1 2
Object WebSocket.once(String ev, Function func);

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

  • ev : String, имя указанного события
  • func : Функция, указать функцию обработчика события

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

  • Object , возвращает сам объект события, что удобно для цепных вызовов

Привязать одноразовый обработчик событий к объекту. Одноразовый обработчик будет срабатывать только один раз.

1
Object WebSocket.once(Object map);

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

  • map : Object, указывает отношение отображения события, имя свойства объекта будет использоваться в качестве имени события, а значение свойства будет использоваться в качестве обработчика события

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

  • Object , возвращает сам объект события, что удобно для цепных вызовов

prependOnceListener

Привязать обработчик событий к началу объекта

1 2
Object WebSocket.prependOnceListener(String ev, Function func);

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

  • ev : String, имя указанного события
  • func : Функция, указать функцию обработчика события

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

  • Object , возвращает количество успешных привязок или 0, если функция связана

Привязать обработчик событий к началу объекта

1
Object WebSocket.prependOnceListener(Object map);

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

  • map : Object, указывает отношение отображения события, имя свойства объекта будет использоваться в качестве имени события, а значение свойства будет использоваться в качестве обработчика события

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

  • Object , возвращает количество успешных привязок или 0, если функция связана

off

Неуказанная функция из очереди обработки объекта

1 2
Object WebSocket.off(String ev, Function func);

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

  • ev : String, имя указанного события
  • func : Функция, указать функцию обработчика события

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

  • Object , возвращает сам объект события, что удобно для цепных вызовов

Отмена всех функций в очереди обработки объекта

1
Object WebSocket.off(String ev);

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

  • ev : String, имя указанного события

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

  • Object , возвращает сам объект события, что удобно для цепных вызовов

Неуказанная функция из очереди обработки объекта

1
Object WebSocket.off(Object map);

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

  • map : Object, определяет отношение отображения событий, имя свойства объекта используется в качестве имени события, а значение свойства используется в качестве функции обработки события

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

  • Object , возвращает сам объект события, что удобно для цепных вызовов

removeListener

Неуказанная функция из очереди обработки объекта

1 2
Object WebSocket.removeListener(String ev, Function func);

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

  • ev : String, имя указанного события
  • func : Функция, указать функцию обработчика события

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

  • Object , возвращает сам объект события, что удобно для цепных вызовов

Отмена всех функций в очереди обработки объекта

1
Object WebSocket.removeListener(String ev);

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

  • ev : String, имя указанного события

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

  • Object , возвращает сам объект события, что удобно для цепных вызовов

Неуказанная функция из очереди обработки объекта

1
Object WebSocket.removeListener(Object map);

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

  • map : Object, определяет отношение отображения событий, имя свойства объекта используется в качестве имени события, а значение свойства используется в качестве функции обработки события

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

  • Object , возвращает сам объект события, что удобно для цепных вызовов

removeAllListeners

Отмените все прослушиватели для всех событий из очереди обработки объекта. Если событие указано, удалите все прослушиватели для указанного события.

1
Object WebSocket.removeAllListeners(Array evs = []);

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

  • evs : Array, укажите название события

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

  • Object , возвращает сам объект события, что удобно для цепных вызовов

setMaxListeners

Количество слушателей по умолчанию, только для совместимости

1
WebSocket.setMaxListeners(Integer n);

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

  • n : целое число, количество указанных событий

getMaxListeners

Получить предельное количество слушателей по умолчанию, только для совместимости

1
Integer WebSocket.getMaxListeners();

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

  • Integer , возвращает номер лимита по умолчанию

listeners

Массив слушателя для указанного события объекта запроса

1
Array WebSocket.listeners(String ev);

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

  • ev : String, имя указанного события

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

  • Array , возвращает массив слушателей для указанного события

listenerCount

Запрос количества слушателей для указанного события

1
Integer WebSocket.listenerCount(String ev);

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

  • ev : String, имя указанного события

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

  • Integer , возвращает количество слушателей для указанного события

eventNames

Запрос имени слушателя события

1
Array WebSocket.eventNames();

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

  • Array , возвращает массив имен событий

emit

Активно вызвать событие

1 2
Boolean WebSocket.emit(String ev, ...args);

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

  • ev : Строка, название события
  • args : ..., параметры события будут переданы в обработчик события

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

  • Boolean , вернуть статус триггера события, вернуть true, если есть событие ответа, в противном случае вернуть false

toString

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

1
String WebSocket.toString();

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

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

toJSON

Возвращает JSON-представление объекта, обычно возвращая коллекцию читаемых свойств, определенных объектом

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

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

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

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

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