Класс для отправки и приема данных по протоколу UDP.
WiFiUDP
Создает экземпляр класса, для работы с протоколом UDP
Синтаксис
WiFiUDP WiFiUDP;Параметры
Нет
Возвращаемые значения
Нет
begin;
Инициализирует WiFi UDP библиотеку и настройки сети. Запускает WiFiUDP сокет, слушает указанный в параметре порт.
Синтаксис
WiFiUDP.begin(port);Параметры
port: локальный порт который нужно слушать
Возвращаемые значения
- 1: если успешно
- 0: если нет сокетов для использования
available
Получает количество байт (символов) доступных для чтения из буфера. Это данные которые уже получены. Эта функция может вызываться только после WiFiUDP.parsePacket()
Синтаксис
WiFiUDP.available();Параметры
Нет
Возвращаемые значения
Количество байт доступных в текущем пакете или 0.
beginPacket
Открывает соединение для отправки данных.
Синтаксис
WiFiUDP.beginPacket(hostName, port);;Параметры
hostName: адрес удаленного сервера. может быть строкой или IP адресом в виде массива из 4 байт
port: порт удаленного сервера с которым будет соединение
Возвращаемые значения
1: если успешно
0: если возникли проблемы
endPacket
Вызывается после записи пакетов для отправки на удаленный сервер. Завершает пакет и отправляет его.
Синтаксис
WiFiUDP.endPacket();Параметры
Нет
Возвращаемые значения
1: если успешно
0: если возникли проблемы
write
Записывает данные в UDP пакет. Должна быть вызвана между beginPacket() и endPacket(), которые инициализируют пакет данных и завершают пакет и отправляют его.
Синтаксис
WiFiUDP.write(byte);
WiFiUDP.write(buffer, size);Параметры
byte: байт на отправку
buffer: сообщение на отправку
size: размер сообщения
Возвращаемые значения
- 1 байт в пакет
- количество байт буфера
parsePacket
Начинает обработку следующего доступного пакета, проверяет наличие пакета и возвращает его размер. Эта функция должна быть вызвана до WiFiUDP.read();
Синтаксис
WiFiUDP.parsePacket();Параметры
Нет
Возвращаемые значения
- размер пакета в байтах
- 0: если нет доступных пакетов
peek
Считывает байт из пакета без продвижения к следующему.
Синтаксис
WiFiUDP.peek();Параметры
Нет
Возвращаемые значения
- b: следующий байт или символ
- -1: если данных нет
read
Читает данные UDP из буфера. При вызове без аргументов вернет следующий символ из буфера.
Синтаксис
WiFiUDP.read(buffer, len);Параметры
buffer: Не обязательный параметр. Буфер хранящий поступающие пакеты.
len: Не обязательный параметр. Максимальный размер буфера.
Возвращаемые значения
- b: символы в буфере
- size: размер буфера
- -1: если буфер не доступен
flush
Отменяет все байты которые были записаны, но еще не прочитаны
Синтаксис
WiFiUDP.flush();Параметры
Нет
Возвращаемые значения
Нет
stop
Отключается от сервера. Освобождает все ресурсы, использовавшиеся во время UDP сессии
Синтаксис
WiFiUDP.stop();Параметры
Нет
Возвращаемые значения
Нет
remoteIP
Получает IP адрес удаленного соединения. Эта функция должна вызываться только после WiFiUDP.parsePacket().
Синтаксис
WiFiUDP.remoteIP();Параметры
Нет
Возвращаемые значения
4 байта : IP адрес сервера который отправил текущий входящий пакет
remotePort
Получает порт удаленного соединения. Эта функция должна вызываться только после WiFiUDP.parsePacket().
Синтаксис
WiFiUDP.remotePort();Параметры
Нет
Возвращаемые значения
Порт сервера который отправил текущий входящий пакет.