UDP Forward#
This module includes functions for UDP forward feature.
The functions in this module are available when udp-forward feature (OPENTHREAD_CONFIG_UDP_FORWARD_ENABLE) is enabled.
Typedefs#
Pointer delivers the UDP packet to host and host should send the packet through its own network stack.
Functions#
Set UDP forward callback to deliver UDP packets to host.
Handle a UDP packet received from host.
Determines if the given UDP port is exclusively opened by OpenThread API.
Typedef Documentation#
otUdpForwarder#
typedef void(* otUdpForwarder) (otMessage *aMessage, uint16_t aPeerPort, otIp6Address *aPeerAddr, uint16_t aSockPort, void *aContext) )(otMessage *aMessage, uint16_t aPeerPort, otIp6Address *aPeerAddr, uint16_t aSockPort, void *aContext)
Pointer delivers the UDP packet to host and host should send the packet through its own network stack.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| [in] | aMessage | A pointer to the UDP Message. | |
| [in] | aPeerPort | The destination UDP port. | |
| [in] | aPeerAddr | A pointer to the destination IPv6 address. | |
| [in] | aSockPort | The source UDP port. | |
| [in] | aContext | A pointer to application-specific context. |
Function Documentation#
otUdpForwardSetForwarder#
void otUdpForwardSetForwarder (otInstance * aInstance, otUdpForwarder aForwarder, void * aContext)
Set UDP forward callback to deliver UDP packets to host.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| otInstance * | [in] | aInstance | A pointer to an OpenThread instance. |
| otUdpForwarder | [in] | aForwarder | A pointer to a function called to forward UDP packet to host. |
| void * | [in] | aContext | A pointer to application-specific context. |
otUdpForwardReceive#
void otUdpForwardReceive (otInstance * aInstance, otMessage * aMessage, uint16_t aPeerPort, const otIp6Address * aPeerAddr, uint16_t aSockPort)
Handle a UDP packet received from host.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| otInstance * | [in] | aInstance | A pointer to an OpenThread instance. |
| otMessage * | [in] | aMessage | A pointer to the UDP Message. |
| uint16_t | [in] | aPeerPort | The source UDP port. |
| const otIp6Address * | [in] | aPeerAddr | A pointer to the source address. |
| uint16_t | [in] | aSockPort | The destination UDP port. |
Warnings
No matter the call success or fail, the message is freed.
otUdpIsPortInUse#
bool otUdpIsPortInUse (otInstance * aInstance, uint16_t port)
Determines if the given UDP port is exclusively opened by OpenThread API.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| otInstance * | [in] | aInstance | A pointer to an OpenThread instance. |
| uint16_t | [in] | port | UDP port number to verify. |