LibreOffice
LibreOffice 5.3 SDK C/C++ API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Typedefs | Enumerations | Functions
conditn.h File Reference
#include <sal/config.h>
#include <osl/time.h>
#include <sal/saldllapi.h>

Go to the source code of this file.

Typedefs

typedef void * oslCondition
 

Enumerations

enum  oslConditionResult { osl_cond_result_ok, osl_cond_result_error, osl_cond_result_timeout, osl_cond_result_FORCE_EQUAL_SIZE = SAL_MAX_ENUM }
 

Functions

SAL_DLLPUBLIC oslCondition osl_createCondition (void)
 Creates a condition. More...
 
SAL_DLLPUBLIC void osl_destroyCondition (oslCondition Condition)
 Free the memory used by the condition. More...
 
SAL_DLLPUBLIC sal_Bool osl_setCondition (oslCondition Condition)
 Sets condition to True => wait() will not block, check() returns True. More...
 
SAL_DLLPUBLIC sal_Bool osl_resetCondition (oslCondition Condition)
 Sets condition to False => wait() will block, check() returns False. More...
 
SAL_DLLPUBLIC oslConditionResult osl_waitCondition (oslCondition Condition, const TimeValue *pTimeout)
 Blocks if condition is not set
If condition has been destroyed prematurely, wait() will return with False. More...
 
SAL_DLLPUBLIC sal_Bool osl_checkCondition (oslCondition Condition)
 Queries the state of the condition without blocking. More...
 

Typedef Documentation

typedef void* oslCondition

Enumeration Type Documentation

Enumerator
osl_cond_result_ok 
osl_cond_result_error 
osl_cond_result_timeout 
osl_cond_result_FORCE_EQUAL_SIZE 

Function Documentation

SAL_DLLPUBLIC sal_Bool osl_checkCondition ( oslCondition  Condition)

Queries the state of the condition without blocking.

Parameters
Conditionhandle to a created condition.
Returns
True: condition is set.
False: condition is not set.
SAL_DLLPUBLIC oslCondition osl_createCondition ( void  )

Creates a condition.

The condition is in the reset-state.

Returns
0 if condition could not be created.
SAL_DLLPUBLIC void osl_destroyCondition ( oslCondition  Condition)

Free the memory used by the condition.

Parameters
Conditionthe condition handle.
SAL_DLLPUBLIC sal_Bool osl_resetCondition ( oslCondition  Condition)

Sets condition to False => wait() will block, check() returns False.

Parameters
Conditionhandle to a created condition.
Returns
False if system-call failed.
SAL_DLLPUBLIC sal_Bool osl_setCondition ( oslCondition  Condition)

Sets condition to True => wait() will not block, check() returns True.

NOTE: ALL threads waiting on this condition are unblocked!

Parameters
Conditionhandle to a created condition.
Returns
False if system-call failed.
SAL_DLLPUBLIC oslConditionResult osl_waitCondition ( oslCondition  Condition,
const TimeValue pTimeout 
)

Blocks if condition is not set
If condition has been destroyed prematurely, wait() will return with False.

Parameters
Conditionhandle to a created condition.
pTimeoutTimeout value or NULL for infinite waiting
Returns
False if system-call failed.