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

#include <StreamPipe.h>

Inheritance diagram for PipeInputStream:

Collaboration diagram for PipeInputStream:

Public Member Methods
virtual DLLLOCAL const char *	getName () override
	Returns the name of the class.

DLLLOCAL int64	peek (ExceptionSink *xsink) override
	Peeks the next byte from the input stream.

DLLLOCAL int64	read (void ptr, int64 limit, ExceptionSink xsink) override
	Reads up to `limit` bytes from the input stream.

Public Member Methods inherited from InputStream
DLLLOCAL QoreValue	peekHelper (ExceptionSink *xsink)
	Helper method that checks that the current thread is the same as when the instance was created, calls peek() and wraps the result to Qore's `int` value.

DLLLOCAL BinaryNode *	readHelper (int64 limit, ExceptionSink *xsink)
	Helper method that checks that the current thread is the same as when the instance was created, calls read() and wraps the read data to Qore's `binary` value.

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 InputStream
	InputStream ()=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::PipeInputStream class.

Member Function Documentation

◆ getName()

virtual DLLLOCAL const char * PipeInputStream::getName ( )

inlineoverridevirtual

Returns the name of the class.

Returns: the name of the class

Implements StreamBase.

◆ peek()

DLLLOCAL int64 PipeInputStream::peek ( ExceptionSink * xsink )

overridevirtual

Peeks the next byte from the input stream.

Parameters

xsink the exception sink

Returns: the next byte available to be read, -1 indicates end of the stream, -2 indicates an error

Implements InputStream.

◆ read()

DLLLOCAL int64 PipeInputStream::read	(	void *	ptr,
		int64	limit,
		ExceptionSink *	xsink
	)

overridevirtual

Reads up to `limit` bytes from the input stream.