IAsyncOutputStream
Engine/source/core/stream/tStream.h
An output stream that writes elements of type "T" in the background.
Public Functions
cancelWriteAt(void * handle)
Cancel the given asynchronous write operation.
void *
issueWriteAt(OffsetType offset, const ElementType * buffer, U32 num)
Queue a write operation of "num" elements from "buffer" to stream position "offset".
tryCompleteWriteAt(void * handle, bool wait)
Try moving the given asynchronous write operation to ASYNC_IO_Complete.
Detailed Description
An output stream that writes elements of type "T" in the background.
Public Types
typedef T ElementType
typedef Offset OffsetType
typedef void Parent
Public Functions
cancelWriteAt(void * handle)
Cancel the given asynchronous write operation.
note:Parameters:This method invalidates the given handle.
| handle | Handle return by "issueWriteAt". |
issueWriteAt(OffsetType offset, const ElementType * buffer, U32 num)
Queue a write operation of "num" elements from "buffer" to stream position "offset".
Parameters:
| offset | The offset in the stream at which to write the elements. |
| buffer | The buffer from which to read elements. |
| num | The number of elements to write. |
a handle to the asynchronous write operatior or NULL if the operation could not be queued.
tryCompleteWriteAt(void * handle, bool wait)
Try moving the given asynchronous write operation to ASYNC_IO_Complete.
note:Parameters:This method invalidates the given handle.
| handle | Handle returned by "issueWriteAt". |
| wait | If true, the method waits until the given operation either fails or completes successfully before returning. |
the final operation status.