#include <OSRTStream.h>

Inheritance diagram for OSRTStream:

Public Member Functions
virtual EXTRTMETHOD	~OSRTStream ()

virtual EXTRTMETHOD int	close ()

virtual EXTRTMETHOD int	flush ()

virtual OSRTCtxtPtr	getContext ()

virtual OSCTXT *	getCtxtPtr ()

virtual char *	getErrorInfo ()

virtual char *	getErrorInfo (char *pBuf, size_t &bufSize)

int	getStatus () const

OSBOOL	isInitialized ()

virtual EXTRTMETHOD OSBOOL	isOpened ()

void	printErrorInfo ()

void	resetErrorInfo ()

Protected Member Functions
EXTRTMETHOD	OSRTStream (OSRTContext *pContext, OSBOOL attachStream=FALSE)

EXTRTMETHOD	OSRTStream (OSRTStream &original)

EXTRTMETHOD	OSRTStream ()

EXTRTMETHOD char *	getErrorInfo (size_t *pBufSize)

Protected Attributes
OSRTCtxtHolder	mCtxtHolder

OSBOOL	mbAttached

int	mStatus

int	mInitStatus

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.

Constructor & Destructor Documentation

◆ OSRTStream()

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.

◆ ~OSRTStream()

virtual EXTRTMETHOD OSRTStream::~OSRTStream ( )

virtual

Virtual destructor. Closes the stream if it was opened.

Member Function Documentation

◆ close()

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

Reimplemented in OSRTOutputStream, and OSRTInputStream.

◆ flush()

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

Reimplemented in OSRTInputStream, and OSRTOutputStream.

◆ getContext()

virtual OSRTCtxtPtr OSRTStream::getContext ( )

inlinevirtual

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 in OSRTInputStream, and OSRTOutputStream.

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

◆ getCtxtPtr()

virtual OSCTXT* OSRTStream::getCtxtPtr ( )

inlinevirtual

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 in OSRTInputStream, and OSRTOutputStream.

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

◆ getErrorInfo() [1/2]

virtual char* OSRTStream::getErrorInfo ( )

inlinevirtual

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 in OSRTInputStream, and OSRTOutputStream.

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

◆ getErrorInfo() [2/2]

virtual char* OSRTStream::getErrorInfo	(	char *	pBuf,
		size_t &	bufSize
	)

inlinevirtual

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 in OSRTInputStream, and OSRTOutputStream.

◆ getStatus()

int OSRTStream::getStatus ( ) const

inline

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: