OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity

net: Fix the documentation of net_release() 

Fixed the description of what happens if there is a timeout.

Change-Id: Id19a791193b527a8ee086f069e103f42d2d9b0f4
Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
This commit is contained in:
Jukka Rissanen 2015-08-03 10:40:08 +03:00 committed by Anas Nashif
parent c0f04fd599
commit 04dfda8927
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
include/net/net_socket.h
View File

@ -105,9 +105,9 @@ int net_send(struct net_buf *buf);
* @brief Receive data from network.
*
* @details Application uses this to get data from network
* connection. This function will not wait so if there is
* no data to return, then NULL is returned. Caller is
* responsible to release the returned net_buf.
* connection. Caller can specify a timeout, if there is no
* data to return after a timeout, a NULL will be returned.
* Caller is responsible to release the returned net_buf.
*
* @param context Network context.
* @param timeout Timeout to wait. The value is in ticks.
@ -116,7 +116,7 @@ int net_send(struct net_buf *buf);
* If > 0, wait amount of ticks.
* The timeout is only available if kernel is compiled
* with CONFIG_NANO_TIMEOUTS. If CONFIG_NANO_TIMEOUT is not
* defined, then value > 0 means to not wait.
* defined, then value > 0 means not to wait.
*
* @return Network buffer if successful, NULL otherwise.
*/