struct CP_PIPETYPE |
content pipe definition
Public Attributes | |
---|---|
CPresult (* | CheckAvailableBytes |
CPresult (* | Close |
CPresult (* | Create |
CPresult (* | GetPosition |
CPresult (* | GetWriteBuffer |
CPresult (* | Open |
CPresult (* | Read |
CPresult (* | ReadBuffer |
CPresult (* | RegisterCallback |
CPresult (* | ReleaseReadBuffer |
CPresult (* | SetPosition |
CPresult (* | Write |
CPresult (* | WriteBuffer |
CPresult (* | CheckAvailableBytes |
Check the that specified number of bytes are available for reading or writing (depending on access type).
CPresult (* | GetPosition |
Retrieve the current position relative to the start of the content.
CPresult (* | GetWriteBuffer |
Retrieve a buffer allocated by the pipe used to write data to the content. Client will fill buffer with output data. Note: pipe provides pointer. This function is appropriate for large writes. The client must call WriteBuffer when done it has filled the buffer with data.
CPresult (* | Read |
Retrieve data of the specified size from the content stream (advance content pointer by size of data). Note: pipe client provides pointer. This function is appropriate for small high frequency reads.
CPresult (* | ReadBuffer |
Retrieve a buffer allocated by the pipe that contains the requested number of bytes. Buffer contains the next block of bytes, as specified by nSize, of the content. nSize also returns the size of the block actually read. Content pointer advances the by the returned size. Note: pipe provides pointer. This function is appropriate for large reads. The client must call ReleaseReadBuffer when done with buffer.
In some cases the requested block may not reside in contiguous memory within the pipe implementation. For instance if the pipe leverages a circular buffer then the requested block may straddle the boundary of the circular buffer. By default a pipe implementation performs a copy in this case to provide the block to the pipe client in one contiguous buffer. If, however, the client sets bForbidCopy, then the pipe returns only those bytes preceding the memory boundary. Here the client may retrieve the data in segments over successive calls.
CPresult (* | RegisterCallback |
Register a per-handle client callback with the content pipe.
CPresult (* | ReleaseReadBuffer |
Release a buffer obtained by ReadBuffer back to the pipe.
CPresult (* | SetPosition |
Seek to certain position in the content relative to the specified origin.
CPresult (* | Write |
Write data of the specified size to the content (advance content pointer by size of data). Note: pipe client provides pointer. This function is appropriate for small high frequency writes.
CPresult (* | WriteBuffer |
Deliver a buffer obtained via GetWriteBuffer to the pipe. Pipe will write the the contents of the buffer to content and advance content pointer by the size of the buffer
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.