OSRTStream Class Reference
[ASN.1 Stream Classes]

The default base class for using I/O streams. More...

#include <OSRTStream.h>

Inheritance diagram for OSRTStream:


Public Member Functions
virtual EXTRTMETHOD	~OSRTStream ()
	Virtual destructor.
virtual EXTRTMETHOD int	close ()
	Closes the input 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.
int	getStatus () const
	This method returns the completion status of previous operation.
OSBOOL	isInitialized ()
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.
Protected Member Functions
EXTRTMETHOD	OSRTStream ()
	The default constructor.
Protected Attributes
OSBOOL	mbAttached
	Flag, TRUE for "attached" streams.
int	mStatus
	Last stream operation status.
int	mInitStatus
	Initialization status. 0 if initialized successfully.

Detailed Description

The default base class for using I/O streams.

This class may be subclassed, as in the case of OSRTInputStream and OSRTOutputStream or other custom implementations.

Definition at line 44 of file OSRTStream.h.

Constructor & Destructor Documentation

EXTRTMETHOD OSRTStream::OSRTStream ( ) [protected]

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 OSRTStream::~OSRTStream ( ) [virtual]

Virtual destructor.

Closes the stream if it was opened.

Member Function Documentation

virtual EXTRTMETHOD int OSRTStream::close ( ) [virtual]

Closes the input 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 OSRTStreamIF.

Reimplemented in OSRTInputStream, and OSRTOutputStream.

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

Flushes the buffered data to the stream.

Returns:

Completion status of operation:

0 = success,
negative return value is error.

See also:: rtxStreamFlush

Implements OSRTStreamIF.

Reimplemented in OSRTInputStream, and OSRTOutputStream.

virtual OSRTCtxtPtr OSRTStream::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 OSRTCtxtHolder.

Reimplemented in OSRTInputStream, and OSRTOutputStream.

Definition at line 99 of file OSRTStream.h.

References OSRTCtxtHolder::getContext().

Referenced by OSRTOutputStream::getContext(), and OSRTInputStream::getContext().

virtual OSCTXT* OSRTStream::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 OSRTCtxtHolder.

Reimplemented in OSRTInputStream, and OSRTOutputStream.

Definition at line 109 of file OSRTStream.h.

References OSRTCtxtHolder::getCtxtPtr().

Referenced by OSRTOutputStream::getCtxtPtr(), and OSRTInputStream::getCtxtPtr().

virtual char* OSRTStream::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 OSRTCtxtHolder.

Reimplemented in OSRTInputStream, and OSRTOutputStream.

Definition at line 140 of file OSRTStream.h.

References OSRTCtxtHolder::getErrorInfo().

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