UDP#

otNetifIdentifier#

otNetifIdentifier

Defines the OpenThread network interface identifiers.

otUdpHandler#

typedef bool(* otUdpHandler) (void *aContext, const otMessage *aMessage, const otMessageInfo *aMessageInfo) )(void *aContext, const otMessage *aMessage, const otMessageInfo *aMessageInfo)

This callback allows OpenThread to provide specific handlers for certain UDP messages.

otUdpReceiver#

typedef struct otUdpReceiver otUdpReceiver

Represents a UDP receiver.

otUdpReceive#

typedef void(* otUdpReceive) (void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo) )(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo)

This callback allows OpenThread to inform the application of a received UDP message.

otUdpSocket#

typedef struct otUdpSocket otUdpSocket

Represents a UDP socket.

otNetifIdentifier#

typedef enum otNetifIdentifier otNetifIdentifier

Defines the OpenThread network interface identifiers.

otUdpAddReceiver#

otError otUdpAddReceiver (otInstance *aInstance, otUdpReceiver *aUdpReceiver)

Adds a UDP receiver.

otUdpRemoveReceiver#

otError otUdpRemoveReceiver (otInstance *aInstance, otUdpReceiver *aUdpReceiver)

Removes a UDP receiver.

otUdpSendDatagram#

otError otUdpSendDatagram (otInstance *aInstance, otMessage *aMessage, otMessageInfo *aMessageInfo)

Sends a UDP message without socket.

otUdpNewMessage#

otMessage * otUdpNewMessage (otInstance *aInstance, const otMessageSettings *aSettings)

Allocate a new message buffer for sending a UDP message.

Note

• If aSettings is 'NULL', the link layer security is enabled and the message priority is set to OT_MESSAGE_PRIORITY_NORMAL by default.

Returns

• A pointer to the message buffer or NULL if no message buffers are available or parameters are invalid.

See Also

• otMessageFree

otUdpOpen#

otError otUdpOpen (otInstance *aInstance, otUdpSocket *aSocket, otUdpReceive aCallback, void *aContext)

Open a UDP/IPv6 socket.

otUdpIsOpen#

bool otUdpIsOpen (otInstance *aInstance, const otUdpSocket *aSocket)

Check if a UDP socket is open.

Returns

• Whether the UDP socket is open.

otUdpClose#

otError otUdpClose (otInstance *aInstance, otUdpSocket *aSocket)

Close a UDP/IPv6 socket.

otUdpBind#

otError otUdpBind (otInstance *aInstance, otUdpSocket *aSocket, const otSockAddr *aSockName, otNetifIdentifier aNetif)

Bind a UDP/IPv6 socket.

otUdpConnect#

otError otUdpConnect (otInstance *aInstance, otUdpSocket *aSocket, const otSockAddr *aSockName)

Connect a UDP/IPv6 socket.

otUdpSend#

otError otUdpSend (otInstance *aInstance, otUdpSocket *aSocket, otMessage *aMessage, const otMessageInfo *aMessageInfo)

Send a UDP/IPv6 message.

If the return value is OT_ERROR_NONE, OpenThread takes ownership of aMessage, and the caller should no longer reference aMessage. If the return value is not OT_ERROR_NONE, the caller retains ownership of aMessage, including freeing aMessage if the message buffer is no longer needed.

otUdpGetSockets#

otUdpSocket * otUdpGetSockets (otInstance *aInstance)

Gets the head of linked list of UDP Sockets.

Returns

• A pointer to the head of UDP Socket linked list.