FileOutputStream Class Reference

Private data for the Qore::FileOutputStream class. More...

#include <FileOutputStream.h>

Inheritance diagram for FileOutputStream:

Collaboration diagram for FileOutputStream:

Public Member Methods
DLLLOCAL void	close (ExceptionSink *xsink) override
	Flushes any buffered (unwritten) bytes, closes the output stream and releases resources.
DLLLOCAL const char *	getName () override
	Returns the name of the class.
DLLLOCAL bool	isClosed () override
	Returns true is the stream has been closed.
DLLLOCAL void	write (const void *ptr, int64 count, ExceptionSink *xsink) override
	Writes bytes to the output stream.
Public Member Methods inherited from OutputStream
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.
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().
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.
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.

Additional Inherited Members
Private Member Methods inherited from OutputStream
	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

Private data for the Qore::FileOutputStream class.

Member Function Documentation

close()

DLLLOCAL void FileOutputStream::close ( ExceptionSink *  xsink )

inlineoverridevirtual

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

Parameters

xsink

the exception sink

Implements OutputStream.

References QoreFile::close(), isClosed(), and ExceptionSink::raiseException().

getName()

DLLLOCAL const char * FileOutputStream::getName ( )

inlineoverridevirtual

Returns the name of the class.

Returns

the name of the class

Implements StreamBase.

isClosed()

DLLLOCAL bool FileOutputStream::isClosed ( )

inlineoverridevirtual

Returns true is the stream has been closed.

Returns

true is the stream has been closed

Implements OutputStream.

References QoreFile::isOpen().

Referenced by close(), and write().

write()

DLLLOCAL void FileOutputStream::write ( const void *  ptr, int64  count, ExceptionSink *  xsink  )

inlineoverridevirtual

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

Implements OutputStream.

References isClosed(), ExceptionSink::raiseException(), and QoreFile::write().

---

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

• /tmp/qore/include/qore/intern/FileOutputStream.h