QoreCondition Class Reference

a thread condition class implementing a wrapper for pthread_cond_t More...

#include <QoreCondition.h>

Inherited by DatasourcePool.

Public Member Methods
DLLEXPORT	QoreCondition ()
	creates the condition object
DLLEXPORT	~QoreCondition ()
	destroys the condition object
DLLEXPORT int	broadcast ()
	singles all threads blocked on this condition to wake up
DLLEXPORT int	signal ()
	signals a single waiting thread to wake up
DLLEXPORT int	wait (pthread_mutex_t *m)
	blocks a thread on a mutex until the condition is signaled
DLLEXPORT int	wait (pthread_mutex_t *m, int timeout_ms)
	blocks a thread on a mutex for a certain number of milliseconds until the condition is signaled
DLLLOCAL int	wait (QoreThreadLock &l)
	blocks a thread on a lock until the condition is signaled
DLLLOCAL int	wait (QoreThreadLock &l, int timeout_ms)
	blocks a thread on a lock for a certain number of milliseconds until the condition is signaled
DLLLOCAL int	wait (QoreThreadLock *l)
	blocks a thread on a lock until the condition is signaled
DLLLOCAL int	wait (QoreThreadLock *l, int timeout_ms)
	blocks a thread on a lock for a certain number of milliseconds until the condition is signaled
DLLEXPORT int	wait2 (pthread_mutex_t *m, int64 timeout_ms)
	blocks a thread on a mutex for a certain number of milliseconds until the condition is signaled
DLLLOCAL int	wait2 (QoreThreadLock &l, int64 timeout_ms)
	blocks a thread on a lock for a certain number of milliseconds until the condition is signaled
DLLLOCAL int	wait2 (QoreThreadLock *l, int64 timeout_ms)
	blocks a thread on a lock for a certain number of milliseconds until the condition is signaled
DLLEXPORT int	waitWithInterrupt (pthread_mutex_t *m, ExceptionSink *xsink=nullptr)
	blocks a thread on a mutex until the condition is signaled, with interrupt support
DLLEXPORT int	waitWithInterrupt (pthread_mutex_t *m, int64 timeout_ms, ExceptionSink *xsink=nullptr)
	blocks a thread on a mutex for a certain number of milliseconds until the condition is signaled, with interrupt support
DLLLOCAL int	waitWithInterrupt (QoreThreadLock &l, ExceptionSink *xsink=nullptr)
	blocks a thread on a lock until the condition is signaled, with interrupt support
DLLLOCAL int	waitWithInterrupt (QoreThreadLock &l, int64 timeout_ms, ExceptionSink *xsink=nullptr)
	blocks a thread on a lock for a certain number of milliseconds until the condition is signaled, with interrupt support
DLLLOCAL int	waitWithInterrupt (QoreThreadLock *l, ExceptionSink *xsink=nullptr)
	blocks a thread on a lock until the condition is signaled, with interrupt support
DLLLOCAL int	waitWithInterrupt (QoreThreadLock *l, int64 timeout_ms, ExceptionSink *xsink=nullptr)
	blocks a thread on a lock for a certain number of milliseconds until the condition is signaled, with interrupt support

Detailed Description

a thread condition class implementing a wrapper for pthread_cond_t

all threads that block on a given QoreCondition object should use the same mutex or QoreThreadLock object for blocking

See also

QoreThreadLock

Member Function Documentation

wait() [1/6]

DLLEXPORT int QoreCondition::wait

(

pthread_mutex_t *

m

)

blocks a thread on a mutex until the condition is signaled

Parameters

m	the mutex to wait on

Returns

0 for success, non-zero for error

Referenced by wait(), wait(), wait(), and wait().

wait() [2/6]

DLLEXPORT int QoreCondition::wait	(	pthread_mutex_t *	m,
		int	timeout_ms
	)

blocks a thread on a mutex for a certain number of milliseconds until the condition is signaled

Parameters

m	the mutext to wait on
timeout_ms	the timeout value is milliseconds; if <= 0 will wait indefinitely

Returns

a non-zero return value indicates a timeout occured

Deprecated:

use wait2(pthread_mutex_t*, int64) instead

wait() [3/6]

DLLLOCAL int QoreCondition::wait ( QoreThreadLock &  l )

inline

blocks a thread on a lock until the condition is signaled

Parameters

l	the QoreThreadLock to wait on

Returns

0 for success, non-zero for error

References wait().

wait() [4/6]

DLLLOCAL int QoreCondition::wait ( QoreThreadLock &  l, int  timeout_ms  )

inline

blocks a thread on a lock for a certain number of milliseconds until the condition is signaled

Parameters

l	the QoreThreadLock to wait on
timeout_ms	the timeout value is milliseconds; if <= 0 will wait indefinitely

Returns

a non-zero return value indicates a timeout occured

Deprecated:

use wait2(QoreThreadLock&, int64) instead

References signal(), and wait().

wait() [5/6]

DLLLOCAL int QoreCondition::wait ( QoreThreadLock *  l )

inline

blocks a thread on a lock until the condition is signaled

Parameters

l	the QoreThreadLock to wait on

Returns

0 for success, non-zero for error

References wait().

wait() [6/6]

DLLLOCAL int QoreCondition::wait ( QoreThreadLock *  l, int  timeout_ms  )

inline

blocks a thread on a lock for a certain number of milliseconds until the condition is signaled

Parameters

l	the QoreThreadLock to wait on
timeout_ms	the timeout value is milliseconds; if <= 0 will wait indefinitely

Returns

a non-zero return value indicates a timeout occured

Deprecated:

use wait2(QoreThreadLock*, int64) instead

References signal(), and wait().

wait2() [1/3]

DLLEXPORT int QoreCondition::wait2	(	pthread_mutex_t *	m,
		int64	timeout_ms
	)

blocks a thread on a mutex for a certain number of milliseconds until the condition is signaled

Parameters

m	the mutext to wait on
timeout_ms	the timeout value is milliseconds; if <= 0 will wait indefinitely

Returns

a non-zero return value indicates a timeout occured

Referenced by wait2(), and wait2().

wait2() [2/3]

DLLLOCAL int QoreCondition::wait2 ( QoreThreadLock &  l, int64  timeout_ms  )

inline

blocks a thread on a lock for a certain number of milliseconds until the condition is signaled

Parameters

l	the QoreThreadLock to wait on
timeout_ms	the timeout value is milliseconds; if <= 0 will wait indefinitely

Returns

a non-zero return value indicates a timeout occured

References signal(), and wait2().

wait2() [3/3]

DLLLOCAL int QoreCondition::wait2 ( QoreThreadLock *  l, int64  timeout_ms  )

inline

blocks a thread on a lock for a certain number of milliseconds until the condition is signaled

Parameters

l	the QoreThreadLock to wait on
timeout_ms	the timeout value is milliseconds; if <= 0 will wait indefinitely

Returns

a non-zero return value indicates a timeout occured

References signal(), and wait2().

waitWithInterrupt() [1/6]

DLLEXPORT int QoreCondition::waitWithInterrupt	(	pthread_mutex_t *	m,
		ExceptionSink *	xsink = nullptr
	)

blocks a thread on a mutex until the condition is signaled, with interrupt support

This method supports sandbox interrupt checking. When a SandboxManager is attached to the current program and an interrupt is requested, this method will return with QORE_COND_RESULT_INTERRUPTED.

Parameters

m	the mutex to wait on
xsink	exception sink for interrupt errors (optional - if nullptr, no exception raised)

Returns

QORE_COND_RESULT_SUCCESS (0) if signaled, QORE_COND_RESULT_INTERRUPTED if interrupted

Since

Qore 2.1

Referenced by waitWithInterrupt(), waitWithInterrupt(), waitWithInterrupt(), and waitWithInterrupt().

waitWithInterrupt() [2/6]

DLLEXPORT int QoreCondition::waitWithInterrupt	(	pthread_mutex_t *	m,
		int64	timeout_ms,
		ExceptionSink *	xsink = nullptr
	)

blocks a thread on a mutex for a certain number of milliseconds until the condition is signaled, with interrupt support

This method supports sandbox interrupt checking. When a SandboxManager is attached to the current program and an interrupt is requested, this method will return with QORE_COND_RESULT_INTERRUPTED.

Parameters

m	the mutex to wait on
timeout_ms	the timeout value in milliseconds; if < 0 will wait indefinitely
xsink	exception sink for interrupt errors (optional - if nullptr, no exception raised)

Returns

QORE_COND_RESULT_SUCCESS (0) if signaled, QORE_COND_RESULT_TIMEOUT if timed out, QORE_COND_RESULT_INTERRUPTED if interrupted

Since

Qore 2.1

waitWithInterrupt() [3/6]

DLLLOCAL int QoreCondition::waitWithInterrupt ( QoreThreadLock &  l, ExceptionSink *  xsink = nullptr  )

inline

blocks a thread on a lock until the condition is signaled, with interrupt support

This method supports sandbox interrupt checking.

Parameters

l	the QoreThreadLock to wait on
xsink	exception sink for interrupt errors (optional)

Returns

QORE_COND_RESULT_SUCCESS (0) if signaled, QORE_COND_RESULT_INTERRUPTED if interrupted

Since

Qore 2.1

References waitWithInterrupt().

waitWithInterrupt() [4/6]

DLLLOCAL int QoreCondition::waitWithInterrupt ( QoreThreadLock &  l, int64  timeout_ms, ExceptionSink *  xsink = nullptr  )

inline

blocks a thread on a lock for a certain number of milliseconds until the condition is signaled, with interrupt support

This method supports sandbox interrupt checking.

Parameters

l	the QoreThreadLock to wait on
timeout_ms	the timeout value in milliseconds; if < 0 will wait indefinitely
xsink	exception sink for interrupt errors (optional)

Returns

QORE_COND_RESULT_SUCCESS (0) if signaled, QORE_COND_RESULT_TIMEOUT if timed out, QORE_COND_RESULT_INTERRUPTED if interrupted

Since

Qore 2.1

References signal(), and waitWithInterrupt().

waitWithInterrupt() [5/6]

DLLLOCAL int QoreCondition::waitWithInterrupt ( QoreThreadLock *  l, ExceptionSink *  xsink = nullptr  )

inline

blocks a thread on a lock until the condition is signaled, with interrupt support

This method supports sandbox interrupt checking.

Parameters

l	the QoreThreadLock to wait on
xsink	exception sink for interrupt errors (optional)

Returns

QORE_COND_RESULT_SUCCESS (0) if signaled, QORE_COND_RESULT_INTERRUPTED if interrupted

Since

Qore 2.1

References waitWithInterrupt().

waitWithInterrupt() [6/6]

DLLLOCAL int QoreCondition::waitWithInterrupt ( QoreThreadLock *  l, int64  timeout_ms, ExceptionSink *  xsink = nullptr  )

inline

blocks a thread on a lock for a certain number of milliseconds until the condition is signaled, with interrupt support

This method supports sandbox interrupt checking.

Parameters

l	the QoreThreadLock to wait on
timeout_ms	the timeout value in milliseconds; if < 0 will wait indefinitely
xsink	exception sink for interrupt errors (optional)

Returns

QORE_COND_RESULT_SUCCESS (0) if signaled, QORE_COND_RESULT_TIMEOUT if timed out, QORE_COND_RESULT_INTERRUPTED if interrupted

Since

Qore 2.1

References signal(), and waitWithInterrupt().

---

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

• /tmp/qore/include/qore/QoreCondition.h