The Free and Open Productivity Suite
Follow us on Twitter: @ApacheOO

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


Global Functions in Global Namespace C++
in Sourcefile conditn.h


osl_checkCondition
extern "C"
sal_Bool osl_checkCondition(
oslCondition Condition );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Queries the state of the condition without blocking.
Parameters
Condition
handle to a created condition.
Return
True: condition is set.
False: condition is not set.

osl_createCondition
extern "C"
oslCondition osl_createCondition(
void );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Description
Creates a condition. The condition is in the reset-state. @returns 0 if condition could not be created.

osl_destroyCondition
extern "C"
void osl_destroyCondition(
oslCondition Condition );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Free the memory used by the condition.
Parameters
Condition
the condition handle.

osl_resetCondition
extern "C"
sal_Bool osl_resetCondition(
oslCondition Condition );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Sets condition to False => wait() will block, check() returns False
Parameters
Condition
handle to a created condition.
Return
False if system-call failed.

osl_setCondition
extern "C"
sal_Bool osl_setCondition(
oslCondition Condition );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Sets condition to True => wait() will not block, check() returns True. NOTE: ALL threads waiting on this condition are unblocked!
Parameters
Condition
handle to a created condition.
Return
False if system-call failed.

osl_waitCondition
extern "C"
oslConditionResult osl_waitCondition(
oslCondition Condition,
const TimeValue * pTimeout );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Description
Blocks if condition is not set
If condition has been destroyed prematurely, wait() will return with False.
Parameters
Condition
handle to a created condition.
pTimeout
Tiemout value or NULL for infinite waiting
Return
False if system-call failed.

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Website Feedback | Contact Us | Donate | Thanks

Apache, the Apache feather logo, and OpenOffice are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.