Header file of Buffer Management related APIs. More...
Go to the source code of this file.
Classes | |
| struct | ClBufferPoolConfigT |
| The type of the buffer configuration info. More... | |
Typedefs | |
| typedef ClPtrT | ClBufferHandleT |
| The type of the handle for the buffer messages. | |
| typedef enum ClBufferMode | ClBufferModeT |
| The config mode of the Buffer. | |
Enumerations | |
| enum | ClBufferMode { CL_BUFFER_NATIVE_MODE, CL_BUFFER_PREALLOCATED_MODE } |
| The config mode of the Buffer. More... | |
| enum | ClBufferSeekTypeT { CL_BUFFER_SEEK_SET = 0, CL_BUFFER_SEEK_CUR, CL_BUFFER_SEEK_END } |
Functions | |
| ClRcT | clBufferChecksum16Compute (ClBufferHandleT messageHandle, ClUint32T startOffset, ClUint32T length, ClUint16T *pChecksum) |
| Computes a 16-bit checksum on a message. | |
| ClRcT | clBufferChecksum32Compute (ClBufferHandleT messageHandle, ClUint32T startOffset, ClUint32T length, ClUint32T *pChecksum) |
| Computes a 32-bit checksum on a message. | |
| ClRcT | clBufferClear (ClBufferHandleT messageHandle) |
| Deletes the content of the buffer message. | |
| ClRcT | clBufferConcatenate (ClBufferHandleT destination, ClBufferHandleT *pSource) |
| Concatenates source message to destination message. | |
| ClRcT | clBufferCreate (ClBufferHandleT *pMessageHandle) |
| Creates a new message. | |
| ClRcT | clBufferCreateAndAllocate (ClUint32T size, ClBufferHandleT *pMessageHandle) |
| Creates buffers for a requested size of a message. | |
| ClRcT | clBufferDataPrepend (ClBufferHandleT messageHandle, ClUint8T *pByteBuffer, ClUint32T numberOfBytesToWrite) |
| Prepends specified number of bytes at the begining of message. | |
| ClRcT | clBufferDelete (ClBufferHandleT *pMessageHandle) |
| Deletes the Buffers. | |
| ClRcT | clBufferDuplicate (ClBufferHandleT messageHandle, ClBufferHandleT *pDuplicatedMessage) |
| Duplicates a message. | |
| ClRcT | clBufferFinalize (void) |
| Cleans up the Buffer Management library. | |
| ClRcT | clBufferFlatten (ClBufferHandleT messageHandle, ClUint8T **ppFlattenBuffer) |
| Flattens message into a single buffer. | |
| ClRcT | clBufferHeaderTrim (ClBufferHandleT messageHandle, ClUint32T numberOfBytes) |
| Trims the start of the message. | |
| ClRcT | clBufferInitialize (const ClBufferPoolConfigT *pConfig) |
| Initializes the Buffer Management library. | |
| ClRcT | clBufferKernelToUserCopy (ClBufferHandleT kernelMessageHandle, ClBufferHandleT userMessageHandle) |
| Copies message from kernel-space to user-space. | |
| ClRcT | clBufferLengthCalc (ClBufferHandleT bufferHandle) |
| Recompute the message length & set internal variable. | |
| ClRcT | clBufferLengthGet (ClBufferHandleT messageHandle, ClUint32T *pMessageLength) |
| Returns the length of the message. | |
| ClRcT | clBufferNBytesRead (ClBufferHandleT messageHandle, ClUint8T *pByteBuffer, ClUint32T *pNumberOfBytesToRead) |
| Reads the specified number of bytes of data from a message. | |
| ClRcT | clBufferNBytesWrite (ClBufferHandleT messageHandle, ClUint8T *pByteBuffer, ClUint32T numberOfBytesToWrite) |
| Writes the specified number bytes of data from a message. | |
| ClRcT | clBufferReadOffsetGet (ClBufferHandleT messageHandle, ClUint32T *pReadOffset) |
| Returns current read offset of the message. | |
| ClRcT | clBufferReadOffsetSet (ClBufferHandleT messageHandle, ClInt32T newReadOffset, ClBufferSeekTypeT seekType) |
| Sets current read offset of the message. | |
| ClRcT | clBufferShrink (ClPoolShrinkOptionsT *pShrinkOptions) |
| Frees up the unused pools of all sizes. | |
| ClRcT | clBufferToBufferCopy (ClBufferHandleT sourceMessage, ClUint32T sourceMessageOffset, ClBufferHandleT destinationMessage, ClUint32T numberOfBytes) |
| Copies specific number of bytes from one message to another. | |
| ClRcT | clBufferTrailerTrim (ClBufferHandleT messageHandle, ClUint32T numberOfBytes) |
| Trims the tail of the message. | |
| ClRcT | clBufferUserToKernelCopy (ClBufferHandleT userMessageHandle, ClBufferHandleT *pKernelMessageHandle) |
| Copies message from user-space to kernel-space. | |
| ClRcT | clBufferWriteOffsetGet (ClBufferHandleT messageHandle, ClUint32T *pWriteOffset) |
| Returns current write offset of the message. | |
| ClRcT | clBufferWriteOffsetSet (ClBufferHandleT messageHandle, ClInt32T newWriteOffset, ClBufferSeekTypeT seekType) |
| Sets current write offset of the message. | |
| ClRcT | clDbgBufferPrint (ClBufferHandleT buffer) |
| Dumps the buffer for debugging, etc. | |
Header file of Buffer Management related APIs.