summaryrefslogtreecommitdiff
path: root/include/osl/conditn.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/osl/conditn.h')
-rw-r--r--include/osl/conditn.h35
1 files changed, 26 insertions, 9 deletions
diff --git a/include/osl/conditn.h b/include/osl/conditn.h
index 26d2cb103d62..a087f3504a49 100644
--- a/include/osl/conditn.h
+++ b/include/osl/conditn.h
@@ -32,9 +32,9 @@ extern "C" {
typedef void* oslCondition;
typedef enum {
- osl_cond_result_ok, /* successful completion */
- osl_cond_result_error, /* error occurred, check osl_getLastSocketError() for details */
- osl_cond_result_timeout, /* blocking operation timed out */
+ osl_cond_result_ok, /*<! Successful completion. */
+ osl_cond_result_error, /*<! Error occurred. @see osl_getLastSocketError() */
+ osl_cond_result_timeout, /*<! Blocking operation timed out. */
osl_cond_result_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
} oslConditionResult;
@@ -44,38 +44,55 @@ typedef enum {
for a more robust and helpful condition.
The condition is in the reset-state.
- @retval 0 if condition could not be created.
+
+ @relates Condition
+
+ @retval osl_cond_result_error Condition could not be created.
*/
SAL_DLLPUBLIC oslCondition SAL_CALL osl_createCondition(void);
/** Free the memory used by the condition.
+
+ @relates Condition
+
@param Condition the condition handle.
*/
SAL_DLLPUBLIC void SAL_CALL osl_destroyCondition(oslCondition Condition);
/** Sets condition to True => wait() will not block, check() returns True.
- NOTE: ALL threads waiting on this condition are unblocked!
+
+ @attention @em all threads waiting on this condition are unblocked!
+
+ @relates Condition
+
@param Condition handle to a created condition.
@retval False if system-call failed.
*/
SAL_DLLPUBLIC sal_Bool SAL_CALL osl_setCondition(oslCondition Condition);
/** Sets condition to False => wait() will block, check() returns False
+
+ @relates Condition
+
@param Condition handle to a created condition.
@retval False if system-call failed.
*/
SAL_DLLPUBLIC sal_Bool SAL_CALL osl_resetCondition(oslCondition Condition);
-/** Blocks if condition is not set
- If condition has been destroyed prematurely, wait() will
- return with False.
+/** Blocks if condition is not set.
+
+ @relates Condition
+
@param Condition handle to a created condition.
@param pTimeout Timeout value or NULL for infinite waiting
- @return False if system-call failed.
+ @retval False Condition has been destroyed prematurely or system call has failed.
*/
SAL_DLLPUBLIC oslConditionResult SAL_CALL osl_waitCondition(oslCondition Condition, const TimeValue* pTimeout);
/** Queries the state of the condition without blocking.
+
+ @relates Condition
+
@param Condition handle to a created condition.
@retval True condition is set
@retval False condition is not set