mirror/lwip
1
0
Fork 0
mirror of https://github.com/lwip-tcpip/lwip.git synced 2024-12-25 09:16:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improved/fixed comments about timeout.

Browse Source
This commit is contained in:
goldsimon 2013-01-24 09:02:19 +01:00
parent ff3bf6d7f5
commit 666e84eef2
1 changed files with 1 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/include/lwip/sys.h
View File

@ -184,7 +184,7 @@ err_t sys_mbox_trypost(sys_mbox_t *mbox, void *msg);
/** Wait for a new message to arrive in the mbox /** Wait for a new message to arrive in the mbox
* @param mbox mbox to get a message from * @param mbox mbox to get a message from
* @param msg pointer where the message is stored * @param msg pointer where the message is stored
* @param timeout maximum time (in milliseconds) to wait for a message * @param timeout maximum time (in milliseconds) to wait for a message (0 = wait forever)
* @return time (in milliseconds) waited for a message, may be 0 if not waited * @return time (in milliseconds) waited for a message, may be 0 if not waited
or SYS_ARCH_TIMEOUT on timeout or SYS_ARCH_TIMEOUT on timeout
* The returned time has to be accurate to prevent timer jitter! */ * The returned time has to be accurate to prevent timer jitter! */
@ -194,7 +194,6 @@ u32_t sys_arch_mbox_fetch(sys_mbox_t *mbox, void **msg, u32_t timeout);
/** Wait for a new message to arrive in the mbox /** Wait for a new message to arrive in the mbox
* @param mbox mbox to get a message from * @param mbox mbox to get a message from
* @param msg pointer where the message is stored * @param msg pointer where the message is stored
* @param timeout maximum time (in milliseconds) to wait for a message
* @return 0 (milliseconds) if a message has been received * @return 0 (milliseconds) if a message has been received
* or SYS_MBOX_EMPTY if the mailbox is empty */ * or SYS_MBOX_EMPTY if the mailbox is empty */
u32_t sys_arch_mbox_tryfetch(sys_mbox_t *mbox, void **msg); u32_t sys_arch_mbox_tryfetch(sys_mbox_t *mbox, void **msg);