#include <dsplink.h>
#include <ringiodefs.h>
Include dependency graph for dsp/inc/ringio.h:
Go to the source code of this file.
Defines | |
#define | RINGIO_H |
#define | RingIO_getAcquiredOffset(client) (((RingIO_Client *) client)->acqStart) |
Returns the current acquire offset for the client. | |
#define | RingIO_getAcquiredSize(client) (((RingIO_Client *) client)->acqSize) |
Returns the size of buffer currently acquired. | |
#define | RingIO_getWatermark(client) (((RingIO_Client *) client)->notifyWaterMark) |
Returns the current watermark level specified by the client. | |
Functions | |
Uint32 | RingIO_getValidSize (IN RingIO_Handle handle) |
Returns the current valid data size. | |
Uint32 | RingIO_getEmptySize (IN RingIO_Handle handle) |
Returns the current empty buffer size. | |
Uint32 | RingIO_getValidAttrSize (IN RingIO_Handle handle) |
Returns the current valid attribute size. | |
Uint32 | RingIO_getEmptyAttrSize (IN RingIO_Handle handle) |
Returns the current empty attribute buffer size. | |
Int | RingIO_create (IN Uint32 procId, IN Char *name, IN RingIO_Attrs *attrs) |
This function creates a RingIO instance in Shared memory using the creation params specified. | |
Int | RingIO_delete (IN Uint32 procId, IN Char *name) |
This function deletes a RingIO channel. | |
RingIO_Handle | RingIO_open (IN Char *name, IN RingIO_OpenMode openMode, IN Uint32 flags) |
This function opens a RingIO. This function is used to open an RingIO Channel either for reading or writing. Only one reader and one writer can be opened on a RingIO. | |
Int | RingIO_close (IN RingIO_Handle handle) |
This function closes a RingIO instance. | |
Int | RingIO_acquire (IN RingIO_Handle handle, OUT RingIO_BufPtr *pData, IN OUT Uint32 *pSize) |
This function acquire a data buffer from RingIO. This function is used to open an RingIO Channel either for reading or writing. Only one reader and one writer can be opened on a RingIO Channel. | |
Int | RingIO_release (IN RingIO_Handle handle, IN Uint32 size) |
This function releases a data buffer to RingIO. This function releases an acquired buffer or part of it. | |
Int | RingIO_cancel (IN RingIO_Handle handle) |
Cancel the previous acquire. | |
Int | RingIO_getvAttribute (IN RingIO_Handle handle, OUT Uint16 *type, OUT Uint32 *param, IN RingIO_BufPtr vptr, IN OUT Uint32 *pSize) |
This function gets an attribute with a variable-sized payload from the attribute buffer. If an attribute is present, the attribute type, the optional parameter, a pointer to the optional payload and the payload size are returned. | |
Int | RingIO_setvAttribute (IN RingIO_Handle handle, IN Uint32 offset, IN Uint16 type, IN Uint32 param, IN RingIO_BufPtr pdata, IN Uint32 size) |
This function sets an attribute with a variable sized payload at the offset provided in the acquired data buffer. If the offset is not in the range of the acquired data buffer, the attribute is not set, and an error is returned. One exception to this rule is when no data buffer has been acquired. In this case an attribute is set at the next data buffer offset that can be acquired. | |
static Int | RingIO_getAttribute (IN RingIO_Handle handle, OUT Uint16 *type, OUT Uint32 *param) |
This function gets a fixed-size attribute from the attribute buffer. If an attribute is present, the attribute type and a related parameter are returned. | |
static Int | RingIO_setAttribute (IN RingIO_Handle handle, IN Uint32 offset, IN Uint16 type, IN Uint32 param) |
This function sets a fixed-size attribute at the offset provided in the acquired data buffer. If the offset is not in the range of the acquired data buffer, the attribute is not set, and an error is returned. One exception to this rule is when no data buffer has been acquired. In this case an attribute is set at the next data buffer offset that can be acquired. | |
Int | RingIO_flush (IN RingIO_Handle handle, IN Bool hardFlush, OUT Uint16 *type, OUT Uint32 *param, OUT Uint32 *bytesFlushed) |
This function flushes the data buffer. This function is used to flush the data from the RingIO. Behavior of this function depends on the value of hardFlush argument When hardFlush is false: If function is called for the writer, all the valid data in buffer after the first attribute location will be discarded. In case there are no attributes, no data will be cleared from the buffer. Note that this does not include the data that has been already acquired by the reader. Note that the attribute will also be cleared from the attribute buffer. For the reader, all the data till the next attribute location will be discarded. And if there is no attribute in the buffer, all valid data will get discarded. Note that the attribute will remain the attribute buffer. This is different from the behavior mentioned for the writer. When hardFlush is true: If function is called from the writer, all committed data and attributes that is not acquired by reader are removed from the RingIO instance. The writer pointer is moved to point to reader's head pointer If function is called from the reader, all data and attributes that can be subsequently acquired from the reader are removed. | |
Int | RingIO_setNotifier (IN RingIO_Handle handle, IN RingIO_NotifyType notifyType, IN Uint32 notifyWatermark, IN RingIO_NotifyFunc notifyFunc, IN RingIO_NotifyParam pNotifyParam) |
This function sets Notification parameters for the RingIO Client. Both the reader and writer can set their notification mechanism using this function. | |
Int | RingIO_sendNotify (IN RingIO_Handle handle, IN RingIO_NotifyMsg msg) |
Send a notification to the other client manually. |
|
Returns the current acquire offset for the client. ============================================================================
Definition at line 154 of file dsp/inc/ringio.h. |
|
Returns the size of buffer currently acquired. ============================================================================
Definition at line 174 of file dsp/inc/ringio.h. |
|
Returns the current watermark level specified by the client. ============================================================================
Definition at line 194 of file dsp/inc/ringio.h. |
|
Definition at line 45 of file dsp/inc/ringio.h. |
|
This function acquire a data buffer from RingIO. This function is used to open an RingIO Channel either for reading or writing. Only one reader and one writer can be opened on a RingIO Channel. ============================================================================
|
|
Cancel the previous acquire. ============================================================================
|
|
This function closes a RingIO instance. ============================================================================
|
|
This function creates a RingIO instance in Shared memory using the creation params specified. ============================================================================
|
|
This function deletes a RingIO channel. ============================================================================
|
|
This function flushes the data buffer. This function is used to flush the data from the RingIO. Behavior of this function depends on the value of hardFlush argument When hardFlush is false: If function is called for the writer, all the valid data in buffer after the first attribute location will be discarded. In case there are no attributes, no data will be cleared from the buffer. Note that this does not include the data that has been already acquired by the reader. Note that the attribute will also be cleared from the attribute buffer. For the reader, all the data till the next attribute location will be discarded. And if there is no attribute in the buffer, all valid data will get discarded. Note that the attribute will remain the attribute buffer. This is different from the behavior mentioned for the writer. When hardFlush is true: If function is called from the writer, all committed data and attributes that is not acquired by reader are removed from the RingIO instance. The writer pointer is moved to point to reader's head pointer If function is called from the reader, all data and attributes that can be subsequently acquired from the reader are removed. ============================================================================
|
|
This function gets a fixed-size attribute from the attribute buffer. If an attribute is present, the attribute type and a related parameter are returned. ============================================================================
Definition at line 544 of file dsp/inc/ringio.h. References NULL, and RingIO_getvAttribute(). 00547 { 00548 return (RingIO_getvAttribute (handle, type, param, NULL, NULL)) ; 00549 }
Here is the call graph for this function: |
|
Returns the current empty attribute buffer size. ============================================================================
|
|
Returns the current empty buffer size. ============================================================================
|
|
Returns the current valid attribute size. ============================================================================
|
|
Returns the current valid data size. ============================================================================
|
|
This function gets an attribute with a variable-sized payload from the attribute buffer. If an attribute is present, the attribute type, the optional parameter, a pointer to the optional payload and the payload size are returned. ============================================================================
Referenced by RingIO_getAttribute(). |
|
This function opens a RingIO. This function is used to open an RingIO Channel either for reading or writing. Only one reader and one writer can be opened on a RingIO. ============================================================================
|
|
This function releases a data buffer to RingIO. This function releases an acquired buffer or part of it. ============================================================================
|
|
Send a notification to the other client manually. ============================================================================
|
|
This function sets a fixed-size attribute at the offset provided in the acquired data buffer. If the offset is not in the range of the acquired data buffer, the attribute is not set, and an error is returned. One exception to this rule is when no data buffer has been acquired. In this case an attribute is set at the next data buffer offset that can be acquired. ============================================================================
Definition at line 587 of file dsp/inc/ringio.h. References NULL, and RingIO_setvAttribute(). 00591 { 00592 return RingIO_setvAttribute (handle, offset, type, param, NULL, 0) ; 00593 }
Here is the call graph for this function: |
|
This function sets Notification parameters for the RingIO Client. Both the reader and writer can set their notification mechanism using this function. ============================================================================
|
|
This function sets an attribute with a variable sized payload at the offset provided in the acquired data buffer. If the offset is not in the range of the acquired data buffer, the attribute is not set, and an error is returned. One exception to this rule is when no data buffer has been acquired. In this case an attribute is set at the next data buffer offset that can be acquired. ============================================================================
Referenced by RingIO_setAttribute(). |