Fifo
This module provides a uni-directional fifo queue for sending data pointers between threads. A typical example (no error checking):.
More...
Detailed Description
This module provides a uni-directional fifo queue for sending data pointers between threads. A typical example (no error checking):.
Typedef Documentation
Handle through which to reference a Fifo.
Function Documentation
Creates a fifo.
- Parameters:
-
[in] | attrs | Fifo_Attrs to use for creating the Fifo. |
- Return values:
-
| Handle | for use in subsequent operations (see Fifo_Handle). |
| NULL | for failure. |
Blocking call to receive a buffer pointer from a fifo.
- Parameters:
-
[in] | hFifo | Fifo_Handle from which to receive a buffer. |
[out] | ptrPtr | A pointer to the pointer to be set. |
- Return values:
-
| Dmai_EOK | if a buffer was successfully received. |
| Dmai_EFLUSH | if the fifo was flushed. |
| Negative value | for failure, see Dmai.h. |
Flushes a fifo. The other end will unblock and return the (non-negative) Dmai_EFLUSH error code.
- Parameters:
-
- Return values:
-
| Dmai_EOK | for success. |
| Negative value | for failure, see Dmai.h. |
Put a buffer pointer on the fifo.
- Parameters:
-
[in] | hFifo | Fifo_Handle to which to send a buffer. |
[in] | ptr | The pointer to put to the fifo. |
- Return values:
-
| Dmai_EOK | for success. |
| Negative value | for failure, see Dmai.h. |
Determine number of entries (pointers) currently in fifo.
- Parameters:
-
- Return values:
-
| Number | of entries in the fifo on success. |
| Negative value | for failure, see Dmai.h. |
Deletes a previously created fifo.
- Parameters:
-
- Return values:
-
| Dmai_EOK | for success. |
| Negative value | for failure, see Dmai.h. |
Variable Documentation
Default attributes for a Fifo.