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

Объект DgramSocket

dgram.Socket Объект представляет собой пакет, который инкапсулирует функцию пакета данных. EventEmitter.

Экземпляр DgramSocket создается dgram.createSocket() Созданный. Создайтеdgram.Socket Экземпляру не нужно использовать ключевое слово new.

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

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

мероприятие

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

закрыть мероприятие

closeСобытия будут использоваться close()для закрытия socketтриггера после. Событие После socketзапуска новое messageсобытие не запускается .

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

Когда возникает какая-либо ошибка, errorсобытие запускается.

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

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

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

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

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

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

#lineWidth: 1.5 #font: Helvetica,sans-Serif #fontSize: 10 #leading: 1.6 #.this: fill=lightgray #.class: fill=white [<class>object|toString();toJSON()] [<class>EventEmitter|new EventEmitter()|EventEmitter|defaultMaxListeners|on();addListener();prependListener();once();prependOnceListener();off();removeListener();removeAllListeners();setMaxListeners();getMaxListeners();listeners();listenerCount();eventNames();emit()] [<this>DgramSocket|bind();send();address();close();getRecvBufferSize();getSendBufferSize();setRecvBufferSize();setSendBufferSize();setBroadcast();ref();unref()] [object] <:- [EventEmitter] [EventEmitter] <:- [DgramSocket] EventEmitter new EventEmitter() EventEmitter defaultMaxListeners on() addListener() prependListener() once() prependOnceListener() off() removeListener() removeAllListeners() setMaxListeners() getMaxListeners() listeners() listenerCount() eventNames() emit() object toString() toJSON() DgramSocket bind() send() address() close() getRecvBufferSize() getSendBufferSize() setRecvBufferSize() setSendBufferSize() setBroadcast() ref() unref()

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

defaultMaxListeners

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

1
static Integer DgramSocket.defaultMaxListeners;

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

bind

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

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

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

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

Этот метод сделает dgram.SocketВ optsуказанном portи addressслушайте информацию о пакете. При привязке запускается полное 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: String укажите название события
  • func: Функция, укажите функцию обработки событий

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

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

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

1
Object DgramSocket.on(Object map);

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

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

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

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

addListener

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

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

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

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

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

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

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

1
Object DgramSocket.addListener(Object map);

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

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

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

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

prependListener

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

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

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

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

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

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

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

1
Object DgramSocket.prependListener(Object map);

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

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

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

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

once

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

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

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

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

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

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

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

1
Object DgramSocket.once(Object map);

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

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

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

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

prependOnceListener

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

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

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

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

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

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

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

1
Object DgramSocket.prependOnceListener(Object map);

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

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

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

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

off

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

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

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

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

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

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

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

1
Object DgramSocket.off(String ev);

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

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

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

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

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

1
Object DgramSocket.off(Object map);

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

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

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

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

removeListener

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

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

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

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

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

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

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

1
Object DgramSocket.removeListener(String ev);

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

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

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

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

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

1
Object DgramSocket.removeListener(Object map);

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

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

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

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

removeAllListeners

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

1
Object DgramSocket.removeAllListeners(String ev);

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

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

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

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

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

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

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

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

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

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

setMaxListeners

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

1
DgramSocket.setMaxListeners(Integer n);

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

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

getMaxListeners

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

1
Integer DgramSocket.getMaxListeners();

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

  • Integer, Вернуться к предельному числу по умолчанию

listeners

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

1
Array DgramSocket.listeners(String ev);

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

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

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

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

listenerCount

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

1
Integer DgramSocket.listenerCount(String ev);

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

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

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

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

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

1 2
Integer DgramSocket.listenerCount(Value o, String ev);

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

  • o: Значение, укажите объект запроса
  • ev: String укажите название события

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

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

eventNames

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

1
Array DgramSocket.eventNames();

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

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

emit

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

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

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

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

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

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

toString

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

1
String DgramSocket.toString();

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

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

toJSON

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

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

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

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

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

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