ot::Cli::UdpExample class

Implements a CLI-based UDP example.

Syntax

Show:

Summary

Declaration

from cli_udp.hpp:49

class UdpExample : private Utils { public: UdpExample(otInstance *aInstance, OutputImplementer &aOutputImplementer); otError Process(Arg aArgs[]); private: using Command = CommandEntry<UdpExample>; template <CommandId kCommandId> otError Process(Arg aArgs[]); static otError PrepareAutoGeneratedPayload(otMessage &aMessage, uint16_t aPayloadLength); static otError PrepareHexStringPayload(otMessage &aMessage, const char *aHexString); static void HandleUdpReceive(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo); void HandleUdpReceive(otMessage *aMessage, const otMessageInfo *aMessageInfo); bool mLinkSecurityEnabled; otUdpSocket mSocket; };

Fields

Field

Declared as

ot::Cli::UdpExample::mLinkSecurityEnabled

bool

ot::Cli::UdpExample::mSocket

otUdpSocket

Methods

Process()

@cli udp send

 udp send hello
 Done
 

 udp send -t hello
 Done
 

 udp send -x 68656c6c6f
 Done
 

 udp send -s 800
 Done
 

 udp send fdde:ad00:beef:0:bb1:ebd6:ad10:f33 1234 hello
 Done
 

 udp send 172.17.0.1 1234 hello
 Sending to synthesized IPv6 address: fdde:ad00:beef:2:0:0:ac11:1
 Done
 

 udp send fdde:ad00:beef:0:bb1:ebd6:ad10:f33 1234 -t hello
 Done
 

 udp send fdde:ad00:beef:0:bb1:ebd6:ad10:f33 1234 -x 68656c6c6f
 Done
 

 udp send fdde:ad00:beef:0:bb1:ebd6:ad10:f33 1234 -s 800
 Done
 

@cparam udp send [@ca{ip} @ca{port}] [@ca{type}] @ca{value} The `ip` and `port` are optional as a pair, but if you specify one you must specify the other. If `ip` and `port` are not specified, the socket peer address is used from `udp connect`. - `ip`: Destination address. This address can be either an IPv4 or IPv6 address, An IPv4 address gets synthesized to an IPv6 address with the preferred NAT64 prefix from the network data. (If the preferred NAT64 prefix is unavailable, the command returns `InvalidState`). - `port`: UDP destination port. - `type`/`value` combinations: - `-t`: The payload in the `value` parameter is treated as text. If no `type` value is entered, the payload in the `value` parameter is also treated as text. - `-s`: Auto-generated payload with the specified length given in the `value` parameter. - `-x`: Binary data in hexadecimal representation given in the `value` parameter. @par Sends a UDP message using the socket. @moreinfo{@udp}. @csa{udp open} @csa{udp bind} @csa{udp connect} @sa otUdpSend.

ot::Cli::UdpExample class

Syntax

Fields

Methods

Process()

PrepareAutoGeneratedPayload()

PrepareHexStringPayload()

HandleUdpReceive()

HandleUdpReceive()

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle