nw::io::IOStream Class

Syntax

class IOStream

Description

The file stream base class.

This is the base class for performing operations on data file streams. Implementation is carried out using derived classes.

typedef Definitions

IOStreamCallback This callback function is called after asynchronous processing completes.

Member Variables

NW_UT_RUNTIME_TYPEINFO
protected mAvailable
protected mAsyncResult
protected mCallback
protected mArg

Member Functions

Constructors/Destructors
V ~IOStream Destructor.
protected IOStream Constructor.
Gets the property information of the file stream.
PV CanRead Gets whether this stream can be read.
PV CanWrite Gets whether this stream can be written.
PV CanAsync Gets whether this stream can be processed asynchronously.
V GetOffsetAlign Gets the alignment required as an offset position from the file pointer used when reading/writing files.
V GetSizeAlign Gets the alignment required as a size to be read/written once when reading/writing files.
V GetBufferAlign This function gets the alignment required for a buffer address used for sending/receiving data when reading/writing.
File Stream Operations
V Read Reads data from the stream (synchronous process).
V ReadAsync Reads data from the stream (asynchronous process).
V Write Writes data to the stream (synchronous process).
V WriteAsync Writes data to the stream (asynchronous process).
WaitAsync Waits for the completion of asynchronous processing.
V IsBusy Checks whether asynchronous processing is currently executing.
Closes the file/gets status
PV Close Closes a stream.
IsAvailable Gets a value indicating whether the stream is currently available.

Revision History

2009/10/20
Initial version.

CONFIDENTIAL