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

Объект DgramSocket

dgram.Socket объект является функцией инкапсуляции функциональности пакетов EventEmitter .

Экземпляр DgramSocket создается с помощью dgram.createSocket (). Новое ключевое слово не требуется для создания экземпляров dgram.Socket .

Как создать:

1 2
var dgram = require('dgram'); var sock = dgram.createSocket('udp4');

событие

DgramSocket наследует от EventEmitter , изменение состояния объекта, а также получение данных реализованы в виде событий.

закрыть событие

Событие close будет вызвано после использования close() закрытия socket . Как только это событие запущено, никакое новое событие message не будет запущено в этом socket .

событие ошибки

При возникновении любой ошибки, событие error будет запущено.

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

Когда socket начинает прослушивать информацию пакета, событие listening будет запущено. Это событие будет запущено сразу после создания UDP-сокета.

событие сообщения

Когда socket получает новый пакет, событие message будет запущено. msg и rinfo будут переданы в качестве параметров функции обработки событий.

  • msg : Buffer , сообщение
  • rinfo : Объект, информация об удаленных адресах
    • address : строка, адрес отправителя
    • family : строка, тип адреса («IPv4» или «IPv6»)
    • port : номер, порт отправителя
    • size : число, размер сообщения

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

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

defaultMaxListeners

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

1
static Integer DgramSocket.defaultMaxListeners;

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

bind

Этот метод заставит dgram.Socket прослушивать информацию о пакете на указанном port и addr . Когда привязка завершена, запускается событие listening .

1 2
DgramSocket.bind(Integer port = 0, String addr = "") async;

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

  • port : Integer, укажите порт привязки, если port не указан или 0, операционная система попытается привязать случайный порт
  • addr : String, указывает адрес привязки. Если адрес не указан, операционная система попытается прослушать все адреса.

Этот метод вызовет dgram.Socket для прослушивания информации о пакете на port и address указанном opts . Когда привязка завершена, запускается событие listening .

1
DgramSocket.bind(Object opts) async;

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

  • opts : Object, указать параметры привязки

send

Отправить пакет в сокет

1 2 3
Integer DgramSocket.send(Buffer msg, Integer port, String address = "") async;

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

  • msg : Buffer , указать отправленные данные
  • port : целое число, укажите порт назначения для отправки
  • address : String, укажите адрес получателя для отправки

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

  • Integer , размер возвращаемого сообщения

Отправить пакет в сокет

1 2 3 4 5
Integer DgramSocket.send(Buffer msg, Integer offset, Integer length, Integer port, String address = "") async;

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

  • msg : Buffer , указать отправленные данные
  • offset : целое число, начать отправку с указанного смещения
  • length : целое число, отправить указанную длину
  • port : целое число, укажите порт назначения для отправки
  • address : String, укажите адрес получателя для отправки

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

  • Integer , размер возвращаемого сообщения

address

Возвращает объект, содержащий информацию об адресе сокета. Для сокета UDP этот объект будет содержать атрибуты адреса, семейства и порта.

1
NObject DgramSocket.address();

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

  • NObject , возвращает адрес привязки объекта

close

Закрыть текущий сокет

1
DgramSocket.close();

Закрыть текущий сокет

1
DgramSocket.close(Function callback);

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

  • callback : функция, функция обратного вызова после завершения закрытия, это эквивалентно добавлению прослушивателя для события close

getRecvBufferSize

Запросите размер буфера приема сокета

1
Integer DgramSocket.getRecvBufferSize();

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

  • Integer , вернуть результат запроса

getSendBufferSize

Запрос размера буфера отправки сокета

1
Integer DgramSocket.getSendBufferSize();

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

  • Integer , вернуть результат запроса

setRecvBufferSize

Установите размер буфера приема сокета

1
DgramSocket.setRecvBufferSize(Integer size);

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

  • size : целое число, укажите размер, который будет установлен

setSendBufferSize

Установите размер буфера отправки сокета

1
DgramSocket.setSendBufferSize(Integer size);

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

  • size : целое число, укажите размер, который будет установлен

setBroadcast

Установите или очистите опцию сокета SO_BROADCAST

1
DgramSocket.setBroadcast(Boolean flag);

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

  • flag : Boolean, при значении true UDP-пакеты будут отправляться на широковещательный адрес локального интерфейса.

ref

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

1
DgramSocket DgramSocket.ref();

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

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

unref

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

1
DgramSocket DgramSocket.unref();

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

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

on

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

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

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

  • ev : Строка, укажите название события
  • func : Функция, укажите функцию обработки событий

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

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

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

1
Object DgramSocket.on(Object map);

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

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

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

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

addListener

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

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

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

  • ev : Строка, укажите название события
  • func : Функция, укажите функцию обработки событий

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

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

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

1
Object DgramSocket.addListener(Object map);

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

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

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

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

prependListener

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

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

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

  • ev : Строка, укажите название события
  • func : Функция, укажите функцию обработки событий

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

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

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

1
Object DgramSocket.prependListener(Object map);

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

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

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

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

once

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

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

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

  • ev : Строка, укажите название события
  • func : Функция, укажите функцию обработки событий

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

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

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

1
Object DgramSocket.once(Object map);

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

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

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

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

prependOnceListener

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

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

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

  • ev : Строка, укажите название события
  • func : Функция, укажите функцию обработки событий

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

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

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

1
Object DgramSocket.prependOnceListener(Object map);

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

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

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

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

off

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

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

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

  • ev : Строка, укажите название события
  • func : Функция, укажите функцию обработки событий

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

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

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

1
Object DgramSocket.off(String ev);

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

  • ev : Строка, укажите название события

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

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

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

1
Object DgramSocket.off(Object map);

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

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

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

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

removeListener

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

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

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

  • ev : Строка, укажите название события
  • func : Функция, укажите функцию обработки событий

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

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

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

1
Object DgramSocket.removeListener(String ev);

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

  • ev : Строка, укажите название события

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

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

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

1
Object DgramSocket.removeListener(Object map);

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

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

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

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

removeAllListeners

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

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

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

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

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

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

setMaxListeners

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

1
DgramSocket.setMaxListeners(Integer n);

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

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

getMaxListeners

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

1
Integer DgramSocket.getMaxListeners();

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

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

listeners

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

1
Array DgramSocket.listeners(String ev);

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

  • ev : Строка, укажите название события

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

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

listenerCount

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

1
Integer DgramSocket.listenerCount(String ev);

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

  • ev : Строка, укажите название события

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

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

eventNames

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

1
Array DgramSocket.eventNames();

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

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

emit

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

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

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

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

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

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

toString

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

1
String DgramSocket.toString();

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

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

toJSON

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

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

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

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

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

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