OSOutputStreamIF Class ReferenceThe base interface class for output streams.
More...
#include <rtxCppOutputStreamIF.h>
Inheritance diagram for OSOutputStreamIF:
List of all members.
|
Public Member Functions |
| virtual | ~OSOutputStreamIF () |
| | Virtual destructor.
|
| virtual int | close ()=0 |
| | Closes the output or output stream and releases any system resources associated with the stream.
|
| virtual int | flush ()=0 |
| | Flushes the buffered data to the stream.
|
| virtual int | getStatus () const =0 |
| | This method returns the completion status of previous operation.
|
| virtual OSBOOL | isOpened ()=0 |
| | Checks, is the stream opened or not.
|
| virtual long | write (const OSOCTET *pdata, size_t size)=0 |
| | Write data to the stream.
|
Detailed Description
The base interface class for output streams.
Definition at line 36 of file rtxCppOutputStreamIF.h.
Constructor & Destructor Documentation
| virtual OSOutputStreamIF::~OSOutputStreamIF |
( |
|
) |
[virtual] |
|
|
|
Virtual destructor.
Closes the stream if it was opened. |
Member Function Documentation
| virtual int OSOutputStreamIF::close |
( |
|
) |
[pure virtual] |
|
|
|
Closes the output or output stream and releases any system resources associated with the stream.
For output streams this function also flushes all internal buffers to the stream.
- Returns:
- Completion status of operation:
- 0 = success,
- negative return value is error.
- See also:
- rtxStreamClose
Implements OSStreamIF.
Implemented in OSOutputStream. |
| virtual int OSOutputStreamIF::flush |
( |
|
) |
[pure virtual] |
|
|
|
Flushes the buffered data to the stream.
- Returns:
- Completion status of operation:
- 0 = success,
- negative return value is error.
- See also:
- rtxStreamFlush
Implements OSStreamIF.
Implemented in OSOutputStream. |
| virtual int OSOutputStreamIF::getStatus |
( |
|
) |
const [pure virtual] |
|
|
|
This method returns the completion status of previous operation.
It can be used to check completion status of constructors or methods, which do not return completion status.
- Returns:
- Runtime status code:
- 0 = success,
- negative return value is error.
Implements OSStreamIF.
Implemented in OSOutputStream. |
| virtual OSBOOL OSOutputStreamIF::isOpened |
( |
|
) |
[pure virtual] |
|
|
|
Checks, is the stream opened or not.
- Returns:
- s TRUE, if the stream is opened, FALSE otherwise.
- See also:
- rtxStreamIsOpened
Implements OSStreamIF.
Implemented in OSOutputStream. |
| virtual long OSOutputStreamIF::write |
( |
const OSOCTET * |
pdata, |
|
|
size_t |
size |
|
) |
[pure virtual] |
|
|
|
Write data to the stream.
This method writes the given number of octets from the given array to the output stream.
- Parameters:
-
| pdata | Pointer to the data to be written. |
| size | The number of octets to write. |
- Returns:
- The total number of octets written into the stream, or negative value with error code if any error is occurred.
- See also:
- rtxStreamWrite
Implemented in OSOutputStream. |
The documentation for this class was generated from the following file:
|
