espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-08-08 19:57:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

[cli] update default bind interface (#11187)

Browse Source 
This commit updates the default CLI bind interface to be consistent with
the description. The default behavior should apply to all Thread nodes,
not just devices that define UDP platform layer. For Thread nodes that
only use the Open Thread Stack, netif type OT_NETIF_THREAD_HOST has no
meaning.

Support for OT_NETIF_THREAD_HOST has been kept using the -h option.

Updated the CLI bind command readme to make it clear when the netif
options are valid and what is the default behavior.

Signed-off-by: Marius Preda <[email protected]>
This commit is contained in:
Marius Preda
2025-01-27 20:02:57 -08:00
committed by GitHub
parent 0f094dd266
commit c25120edc0
2 changed files with 21 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/cli/README_UDP.md
+6 -1
View File
@@ -68,12 +68,15 @@ Done
Assigns a name (i.e. IPv6 address and port) to the example socket.
- netif: the network interface to bind to.
- not specified: Thread network interface.
- not specified: Thread stack network interface.
- `-u`: unspecified network interface.
- `-b`: Backbone network interface.
- `-h`: Host Thread network interface.
- ip: the unicast IPv6 address or the unspecified IPv6 address (`::`).
- port: the UDP port
> Note: the netif parameter values (-u, -b, -h) are only valid if OPENTHREAD_CONFIG_PLATFORM_UDP_ENABLE is set.
```bash
> udp bind :: 1234
Done
@@ -81,6 +84,8 @@ Done
Done
> udp bind -b :: 1234
Done
> udp bind -h :: 1234
Done
```
> Note: to receive datagrams sent to a multicast IPv6 address, the unspecified IPv6 address must be used. Using a multicast address for the \<ip\> argument is not supported. Also, the node must subscribe to the multicast group using `ipmaddr add` before it can receive UDP multicast.
src/cli/cli_udp.cpp
+15 -5
View File
@@ -64,12 +64,17 @@ UdpExample::UdpExample(otInstance *aInstance, OutputImplementer &aOutputImplemen
* udp bind -b :: 1234
* Done
* @endcode
* @code
* udp bind -h :: 1234
* Done
* @endcode
* @cparam udp bind [@ca{netif}] @ca{ip} @ca{port}
* - `netif`: The binding network interface, which is determined as follows:
* - No value (leaving out this parameter from the command): Thread network interface is used.
* - `-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.
* - No value (leaving out this parameter from the command): Thread stack network interface is used.
* - `-u`: Unspecified network interface, which means that the Host UDP/IPv6 stack determines which
* network interface to bind the socket to. Valid if OPENTHREAD_CONFIG_PLATFORM_UDP_ENABLE is set.
* - `-b`: Backbone network interface is used. Valid if OPENTHREAD_CONFIG_PLATFORM_UDP_ENABLE is set.
* - `-h`: Host Thread network interface is used. Valid if OPENTHREAD_CONFIG_PLATFORM_UDP_ENABLE is set.
* - `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.
@@ -83,7 +88,7 @@ template <> otError UdpExample::Process<Cmd("bind")>(Arg aArgs[])
{
otError error;
otSockAddr sockaddr;
otNetifIdentifier netif = OT_NETIF_THREAD_HOST;
otNetifIdentifier netif = OT_NETIF_THREAD_INTERNAL;
if (aArgs[0] == "-u")
{
@@ -95,6 +100,11 @@ template <> otError UdpExample::Process<Cmd("bind")>(Arg aArgs[])
netif = OT_NETIF_BACKBONE;
aArgs++;
}
else if (aArgs[0] == "-h")
{
netif = OT_NETIF_THREAD_HOST;
aArgs++;
}
SuccessOrExit(error = aArgs[0].ParseAsIp6Address(sockaddr.mAddress));
SuccessOrExit(error = aArgs[1].ParseAsUint16(sockaddr.mPort));