Home About ASN.1 Products Free Software Documents Services Resources Resellers Customers Careers About Us Contact Us

OSStream Class Reference The base class for streams. More... #include <rtxCppStream.h> Inheritance diagram for OSStream: List of all members. Public Member Functions virtual  ~OSStream ()   Virtual destructor. virtual int  close ()   Closes the input or output stream and releases any system resources associated with the stream. virtual int  flush ()   Flushes the buffered data to the stream. virtual OSCtxtPtr  getContext ()   This method returns a pointer to the underlying OSContext 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 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   OSStream ()   The default constructor. Protected Attributes OSCtxtPtr  mpContext   Pointer to a context structure. OSBOOL  mbAttached   Flag, TRUE for "attached" streams. int  mStatus   Last stream operation status. int  mInitStatus   Initialization status. 0 if initialized successfully. Detailed Description The base class for streams. Definition at line 37 of file rtxCppStream.h. Constructor & Destructor Documentation OSStream::OSStream (   )  [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 OSStream::~OSStream (   )  [virtual]   Virtual destructor. Closes the stream if it was opened. Member Function Documentation virtual int OSStream::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 OSStreamIF. Reimplemented in OSInputStream, and OSOutputStream. virtual int OSStream::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 OSStreamIF. Reimplemented in OSInputStream, and OSOutputStream. virtual OSCtxtPtr OSStream::getContext (   )  [inline, virtual]   This method returns a pointer to the underlying OSContext object. Returns: A reference-counted pointer to an OSContext object. The OSContext 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. Implements OSStreamIF. Reimplemented in OSInputStream, and OSOutputStream. Definition at line 93 of file rtxCppStream.h. Referenced by OSOutputStream::getContext(), and OSInputStream::getContext(). virtual OSCTXT* OSStream::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. Implements OSStreamIF. Reimplemented in OSInputStream, and OSOutputStream. Definition at line 103 of file rtxCppStream.h. Referenced by OSOutputStream::getCtxtPtr(), and OSInputStream::getCtxtPtr(). virtual char* OSStream::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 occured. Implements OSStreamIF. Reimplemented in OSInputStream, and OSOutputStream. Definition at line 134 of file rtxCppStream.h. virtual char* OSStream::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. Implements OSStreamIF. Reimplemented in OSInputStream, and OSOutputStream. Definition at line 114 of file rtxCppStream.h. Referenced by OSOutputStream::getErrorInfo(), and OSInputStream::getErrorInfo(). int OSStream::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. Implements OSStreamIF. Reimplemented in OSInputStream, and OSOutputStream. Definition at line 147 of file rtxCppStream.h. Referenced by OSOutputStream::getStatus(), and OSInputStream::getStatus(). virtual OSBOOL OSStream::isOpened (   )  [virtual]   Checks, is the stream opened or not. Returns: TRUE, if the stream is opened, FALSE otherwise. See also: rtxStreamIsOpened Implements OSStreamIF. Reimplemented in OSInputStream, and OSOutputStream. The documentation for this class was generated from the following file: rtxCppStream.h This file was last modified on 8 Jan 2007. XBinder, Version 1.1.9