Zen API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Friends Macros Modules Pages

kStatus kMsgQueue_Remove | ( | kMsgQueue | queue,
|  | void * | item,
|  | k64u | timeout
| ) |  |

Removes an item from the queue.

The timeout provided to this function can be used to efficiently wait for an item to become available. A zero timeout can be used to return immediately, while a kINFINITE timeout can be used to wait indefinitely.

This method is thread-safe.

Parameters

  queue | Queue object.
  item | Optionally receives removed item (if kNULL, item is not returned).
  timeout | Timeout (microseconds).

Returns
  Operation status.