OutputStream Class Reference

Interface for private data of output streams. More...

#include <OutputStream.h>

Inheritance diagram for OutputStream:

Collaboration diagram for OutputStream:

Public Member Methods
DLLLOCAL bool	check (ExceptionSink *xsink)
	Checks that the current thread is the same as when the instance was created or assigned via unassignThread() and reassignThread() and that the stream has not yet been closed.
virtual void	close (ExceptionSink *xsink)=0
	Flushes any buffered (unwritten) bytes, closes the output stream and releases resources.
DLLLOCAL void	closeHelper (ExceptionSink *xsink)
	Helper method that checks that the current thread is the same as when the instance was created, that the stream has not yet been closed and calls close().
virtual bool	isClosed ()=0
	Returns true is the stream has been closed.
virtual void	write (const void *ptr, int64 count, ExceptionSink *xsink)=0
	Writes bytes to the output stream.
DLLLOCAL void	writeHelper (const BinaryNode *data, ExceptionSink *xsink)
	Helper method that checks that the current thread is the same as when the instance was created, that the stream has not yet been closed and calls write().
DLLLOCAL void	writeHelper (const QoreString *data, ExceptionSink *xsink)
	Helper method that checks that the current thread is the same as when the instance was created, that the stream has not yet been closed and calls write().
Public Member Methods inherited from StreamBase
DLLLOCAL bool	check (ExceptionSink *xsink)
	Checks that the current thread is the same as when the instance was created or assigned via unassignThread() and reassignThread() and that the stream has not yet been closed.
virtual DLLLOCAL const char *	getName ()=0
	Returns the name of the class.
DLLLOCAL int	getThreadId ()
	Get currently assigned thread id.
DLLLOCAL void	reassignThread (ExceptionSink *xsink)
	Reassigns current thread as thread used for stream manipulation, see check()
DLLLOCAL void	unassignThread (ExceptionSink *xsink)
	Unassigns current thread as thread used for stream manipulation, see check()
Public Member Methods inherited from AbstractPrivateData
virtual DLLLOCAL void	deref ()
	decrements the reference count of the object without the possibility of throwing a Qore-language exception
virtual DLLLOCAL void	deref (ExceptionSink *xsink)
	decrements the reference count of the object
DLLLOCAL void	ref () const
	increments the reference count of the object
Public Member Methods inherited from QoreReferenceCounter
DLLEXPORT	QoreReferenceCounter ()
	Creates the reference counter object.
DLLEXPORT	QoreReferenceCounter (const QoreReferenceCounter &old)
	Creates a new object with a reference count of 1.
DLLEXPORT	~QoreReferenceCounter ()
	destroys the reference counter object
DLLEXPORT bool	is_unique () const
	Returns true if the reference count is 1.
DLLEXPORT bool	optRef ()
	Make a strong reference only if the object is valid.
DLLEXPORT int	reference_count () const
	Gets the reference count.
DLLEXPORT bool	ROdereference () const
	Atomically decrements the reference count.
DLLEXPORT void	ROreference () const
	Atomically increments the reference count.

Private Member Methods
	OutputStream ()=default
	Constructor.
Private Member Methods inherited from StreamBase
	StreamBase ()
	Constructor.
Private Member Methods inherited from AbstractPrivateData
virtual DLLLOCAL	~AbstractPrivateData ()
	as these objects are reference counted, the destructor should be called only when the reference count = 0 and not manually

Detailed Description

Interface for private data of output streams.

Methods in this interface serve as low-level API for using output streams from C++ code.

Member Function Documentation

check()

DLLLOCAL bool OutputStream::check ( ExceptionSink *  xsink )

inline

Checks that the current thread is the same as when the instance was created or assigned via unassignThread() and reassignThread() and that the stream has not yet been closed.

Parameters

xsink

the exception sink

Returns

true if the checks passed, false if an exception has been raised

Exceptions

STREAM-THREAD-ERROR	if the current thread is not the same as when the instance was created
OUTPUT-STREAM-CLOSED-ERROR	if the stream has been closed

References StreamBase::check(), StreamBase::getName(), isClosed(), and ExceptionSink::raiseException().

Referenced by closeHelper(), writeHelper(), and writeHelper().

close()

virtual void OutputStream::close ( ExceptionSink *  xsink )

pure virtual

Flushes any buffered (unwritten) bytes, closes the output stream and releases resources.

Parameters

xsink

the exception sink

Implemented in BinaryOutputStream, FileOutputStream, OutputStreamWrapper, StderrOutputStream, StdoutOutputStream, PipeOutputStream, and StringOutputStream.

Referenced by closeHelper().

closeHelper()

DLLLOCAL void OutputStream::closeHelper ( ExceptionSink *  xsink )

inline

Helper method that checks that the current thread is the same as when the instance was created, that the stream has not yet been closed and calls close().

Parameters

xsink

the exception sink

References check(), and close().

isClosed()

virtual bool OutputStream::isClosed ( )

pure virtual

Returns true is the stream has been closed.

Returns

true is the stream has been closed

Implemented in BinaryOutputStream, FileOutputStream, OutputStreamWrapper, StderrOutputStream, StdoutOutputStream, PipeOutputStream, and StringOutputStream.

Referenced by check().

write()

virtual void OutputStream::write ( const void *  ptr, int64  count, ExceptionSink *  xsink  )

pure virtual

Writes bytes to the output stream.

Parameters

ptr	the source buffer to write to the stream
count	the number of bytes to write, must be >= 0
xsink	the exception sink

Implemented in BinaryOutputStream, FileOutputStream, OutputStreamWrapper, StderrOutputStream, StdoutOutputStream, PipeOutputStream, and StringOutputStream.

Referenced by writeHelper(), and writeHelper().

writeHelper() [1/2]

DLLLOCAL void OutputStream::writeHelper ( const BinaryNode *  data, ExceptionSink *  xsink  )

inline

Helper method that checks that the current thread is the same as when the instance was created, that the stream has not yet been closed and calls write().

Parameters

data	the data to write
xsink	the exception sink

References check(), BinaryNode::getPtr(), BinaryNode::size(), and write().

writeHelper() [2/2]

DLLLOCAL void OutputStream::writeHelper ( const QoreString *  data, ExceptionSink *  xsink  )

inline

Helper method that checks that the current thread is the same as when the instance was created, that the stream has not yet been closed and calls write().

Parameters

data	the data to write
xsink	the exception sink

References QoreString::c_str(), check(), QoreString::size(), and write().

---

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

• /tmp/qore/include/qore/OutputStream.h