Home > Support > Documentation

OSRTOutputStream Class Reference
[Generic Output Stream Classes]

The base class definition for operations with output streams. More...

#include <OSRTOutputStream.h>

Inheritance diagram for OSRTOutputStream:

OSRTStream OSRTOutputStreamIF OSRTCtxtHolder OSRTStreamIF OSRTStreamIF OSRTCtxtHolderIF OSRTCtxtHolderIF OSRTCtxtHolderIF OSRTFileOutputStream OSRTMemoryOutputStream OSRTSocketOutputStream List of all members.

Public Member Functions

EXTRTMETHOD OSRTOutputStream ()
 The default constructor.
virtual EXTRTMETHOD ~OSRTOutputStream ()
 Virtual destructor.
virtual EXTRTMETHOD int close ()
 Closes the output or output stream and releases any system resources associated with the stream.
virtual EXTRTMETHOD int flush ()
 Flushes the buffered data to the stream.
virtual OSRTCtxtPtr getContext ()
 This method returns a pointer to the underlying OSRTContext object.
virtual OSCTXT * getCtxtPtr ()
 This method returns a pointer to the underlying OSCTXT object.
virtual char * getErrorInfo ()
 Returns error text in a dynamic memory buffer.
virtual char * getErrorInfo (char *pBuf, size_t &bufSize)
 Returns error text in a memory buffer.
virtual int getStatus () const
 This method returns the completion status of previous operation.
virtual EXTRTMETHOD OSBOOL isOpened ()
 Checks, is the stream opened or not.
void printErrorInfo ()
 The printErrorInfo method prints information on errors contained within the context.
void resetErrorInfo ()
 The resetErrorInfo method resets information on errors contained within the context.
virtual EXTRTMETHOD long write (const OSOCTET *pdata, size_t size)
 Write data to the stream.

Detailed Description

The base class definition for operations with output streams.

As with the input stream, this implementation is backed by memory buffers to improve I/O performance.

Definition at line 43 of file OSRTOutputStream.h.

Constructor & Destructor Documentation

EXTRTMETHOD OSRTOutputStream::OSRTOutputStream (   ) 
 

The default constructor.

It initializes a buffered stream. A buffered stream maintains data in memory before reading or writing to the device. This generally provides better performance than an unbuffered stream.

virtual EXTRTMETHOD OSRTOutputStream::~OSRTOutputStream (   )  [virtual]
 

Virtual destructor.

Closes the stream if it was opened.

Member Function Documentation

virtual EXTRTMETHOD int OSRTOutputStream::close (   )  [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, rtxStreamBufClose

Reimplemented from OSRTStream.

virtual EXTRTMETHOD int OSRTOutputStream::flush (   )  [virtual]
 

Flushes the buffered data to the stream.

Returns:
Completion status of operation:
  • 0 = success,
  • negative return value is error.
See also:
rtxStreamFlush, rtxStreamBufFlush

Reimplemented from OSRTStream.

virtual OSRTCtxtPtr OSRTOutputStream::getContext (   )  [inline, virtual]
 

This method returns a pointer to the underlying OSRTContext object.

Returns:
A reference-counted pointer to an OSRTContext object. The OSRTContext object will not be released until all referenced-counted pointer variables go out of scope. This allows safe sharing of the context between different run-time classes.

Reimplemented from OSRTStream.

Definition at line 91 of file OSRTOutputStream.h.

References OSRTStream::getContext().

virtual OSCTXT* OSRTOutputStream::getCtxtPtr (   )  [inline, virtual]
 

This method returns a pointer to the underlying OSCTXT object.

This is the structure used in calls to low-level C encode/decode functions.

Returns:
Pointer to a context (OSCTXT) structure.

Reimplemented from OSRTStream.

Definition at line 101 of file OSRTOutputStream.h.

References OSRTStream::getCtxtPtr().

virtual char* OSRTOutputStream::getErrorInfo (  char *  pBuf,
size_t &  bufSize
)  [inline, virtual]
 

Returns error text in a memory buffer.

If buffer pointer is specified in parameters (not NULL) then error text will be copied in the passed buffer. Otherwise, this method allocates memory using the 'operator new []' function. The calling routine is responsible to free the memory by using 'operator delete []'.

Parameters:
pBuf A pointer to a destination buffer to obtain the error text. If NULL, dynamic buffer will be allocated.
bufSize A reference to buffer size. If pBuf is NULL it will receive the size of allocated dynamic buffer.
Returns:
A pointer to a buffer with error text. If pBuf is not NULL, the return pointer will be equal to it. Otherwise, returns newly allocated buffer with error text. NULL, if error occurred.

Reimplemented from OSRTStream.

Definition at line 132 of file OSRTOutputStream.h.

References OSRTStream::getErrorInfo().

virtual char* OSRTOutputStream::getErrorInfo (   )  [inline, virtual]
 

Returns error text in a dynamic memory buffer.

Buffer will be allocated by 'operator new []'. The calling routine is responsible to free the memory by using 'operator delete []'.

Returns:
A pointer to a newly allocated buffer with error text.

Reimplemented from OSRTStream.

Definition at line 112 of file OSRTOutputStream.h.

References OSRTStream::getErrorInfo().

virtual int OSRTOutputStream::getStatus (   )  const [inline, 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.

Reimplemented from OSRTStream.

Definition at line 145 of file OSRTOutputStream.h.

References OSRTStream::getStatus().

virtual EXTRTMETHOD OSBOOL OSRTOutputStream::isOpened (   )  [virtual]
 

Checks, is the stream opened or not.

Returns:
s TRUE, if the stream is opened, FALSE otherwise.
See also:
rtxStreamIsOpened

Reimplemented from OSRTStream.

virtual EXTRTMETHOD long OSRTOutputStream::write (  const OSOCTET *  pdata,
size_t  size
)  [virtual]
 

Write data to the stream.

This method writes the given number of octets from the given array to the output stream.

Parameters:
pdata The 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

Implements OSRTOutputStreamIF.

The documentation for this class was generated from the following file: