arduino/esp8266
1
0
Fork 0
mirror of https://github.com/esp8266/Arduino.git synced 2025-06-13 13:01:55 +03:00
Code Activity

Add virtual beginMulticast(...) stub to UDP class (#8969)

Browse Source 
* - Same UDP API of ESP32 core

* - PR review
This commit is contained in:
Luciano Martorella
2023-08-15 18:25:58 +02:00
committed by GitHub
parent f2da54d3a2
commit 1a4663fbe8
4 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/esp8266wifi/udp-class.rst
View File

@ -26,11 +26,11 @@ Multicast UDP
.. code:: cpp
uint8_t beginMulticast (IPAddress interfaceAddr, IPAddress multicast, uint16_t port)
uint8_t beginMulticast (IPAddress multicast, uint16_t port)
virtual int beginPacketMulticast (IPAddress multicastAddress, uint16_t port, IPAddress interfaceAddress, int ttl=1)
IPAddress destinationIP ()
uint16_t localPort ()
The ``WiFiUDP`` class supports sending and receiving multicast packets on STA interface. When sending a multicast packet, replace ``udp.beginPacket(addr, port)`` with ``udp.beginPacketMulticast(addr, port, WiFi.localIP())``. When listening to multicast packets, replace ``udp.begin(port)`` with ``udp.beginMulticast(WiFi.localIP(), multicast_ip_addr, port)``. You can use ``udp.destinationIP()`` to tell whether the packet received was sent to the multicast or unicast address.
The ``WiFiUDP`` class supports sending and receiving multicast packets on STA interface. When sending a multicast packet, replace ``udp.beginPacket(addr, port)`` with ``udp.beginPacketMulticast(addr, port, WiFi.localIP())``. When listening to multicast packets, replace ``udp.begin(port)`` with ``udp.beginMulticast(multicast_ip_addr, port)``. You can use ``udp.destinationIP()`` to tell whether the packet received was sent to the multicast or unicast address.
For code samples please refer to separate section with `examples <udp-examples.rst>`__ dedicated specifically to the UDP Class.