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

[docs] add otUdpSend() usage (#3220)

Browse Source
This commit is contained in:
Yakun Xu
2018-11-02 11:28:07 -07:00
committed by Jonathan Hui
parent e2abb405c2
commit e914c6ab6a
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/openthread/udp.h
+7
View File
@@ -183,6 +183,13 @@ otError otUdpConnect(otUdpSocket *aSocket, otSockAddr *aSockName);
* @param[in] aMessage A pointer to a message buffer.
* @param[in] aMessageInfo A pointer to a message info structure.
*
* If the return value is OT_ERROR_NONE, OpenThread takes ownership of @p aMessage, and the caller should no longer
* reference @p aMessage. If the return value is not OT_ERROR_NONE, the caller retains ownership of @p aMessage,
* including freeing @p aMessage if the message buffer is no longer needed.
*
* @retval OT_ERROR_NONE The message is successfully scheduled for sending.
* @retval OT_ERROR_INVALID_ARGS Invalid arguments are given.
*
* @sa otUdpNewMessage
* @sa otUdpOpen
* @sa otUdpClose