espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-08-11 13:17:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

[cli] udp bind doc update to clarify that multicast address cannot be used as argument (#10370)

Browse Source
This commit is contained in:
Esko Dijk
2024-06-18 09:17:11 -07:00
committed by GitHub
parent fad66e272a
commit a46786b0e8
2 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/cli/cli_udp.cpp
+3 -3
View File
@@ -70,9 +70,9 @@ UdpExample::UdpExample(otInstance *aInstance, OutputImplementer &aOutputImplemen
* - `-u`: Unspecified network interface, which means that the UDP/IPv6 stack determines which
* network interface to bind the socket to.
* - `-b`: Backbone network interface is used.
* - `ip`: IPv6 address to bind to. If you wish to have the UDP/IPv6 stack assign the binding
* IPv6 address, then you can use the following value to use the unspecified
* IPv6 address: `::`. Each example uses the unspecified IPv6 address.
* - `ip`: Unicast IPv6 address to bind to. If you wish to have the UDP/IPv6 stack assign the binding
* IPv6 address, or if you wish to bind to multicast IPv6 addresses, then you can use the following
* value to use the unspecified IPv6 address: `::`. Each example uses the unspecified IPv6 address.
* - `port`: UDP port number to bind to. Each of the examples is using port number 1234.
* @par
* Assigns an IPv6 address and a port to an open socket, which binds the socket for communication.