sl@0: 
sl@0: /* Copyright (c) 2009 The Khronos Group Inc.
sl@0:  *
sl@0:  * Permission is hereby granted, free of charge, to any person obtaining a
sl@0:  * copy of this software and/or associated documentation files (the
sl@0:  * "Materials"), to deal in the Materials without restriction, including
sl@0:  * without limitation the rights to use, copy, modify, merge, publish,
sl@0:  * distribute, sublicense, and/or sell copies of the Materials, and to
sl@0:  * permit persons to whom the Materials are furnished to do so, subject to
sl@0:  * the following conditions:
sl@0:  *
sl@0:  * The above copyright notice and this permission notice shall be included
sl@0:  * in all copies or substantial portions of the Materials.
sl@0:  *
sl@0:  * THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
sl@0:  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
sl@0:  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
sl@0:  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
sl@0:  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
sl@0:  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
sl@0:  * MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
sl@0:  */
sl@0: 
sl@0: #ifndef OWFCOND_H_
sl@0: #define OWFCOND_H_
sl@0: 
sl@0: #include "owftypes.h"
sl@0: #include "owfmutex.h"
sl@0: 
sl@0: 
sl@0: #ifdef __cplusplus
sl@0: extern "C" {
sl@0: #endif
sl@0: 
sl@0: 
sl@0: typedef void* OWF_COND;
sl@0: 
sl@0: /*! \brief Initialize a condition variable
sl@0:  *
sl@0:  *  \param cond
sl@0:  *  \param mutex mutex to be used when wait is called
sl@0:  *
sl@0:  *  \return true or false depending whether initialization
sl@0:  *  succeeded or not
sl@0:  */
sl@0: OWF_API_CALL OWFboolean
sl@0: OWF_Cond_Init(OWF_COND* cond, OWF_MUTEX mutex);
sl@0: 
sl@0: /*! \brief Destroy a condition variable
sl@0:  *
sl@0:  *  \cond cond variable
sl@0:  */
sl@0: OWF_API_CALL void
sl@0: OWF_Cond_Destroy(OWF_COND* cond);
sl@0: 
sl@0: /*! \brief Block on a condition variable
sl@0:  *
sl@0:  *  \param cond
sl@0:  *  \param timeout maximum time to wait in nanoseconds
sl@0:  *
sl@0:  * Cond must be initialized with OWF_Cond_Init. Caller MUST hold
sl@0:  * the mutex specified upon initialization. Call will block on
sl@0:  * the cond and release mutex until cond is signalled. After cond
sl@0:  * is signalled the mutex is regained.
sl@0:  *
sl@0:  * The call will not block if timeout equals to zero. If timeout is
sl@0:  * greater than zero, the call will not return until 'timeout'
sl@0:  * nanoseconds has elapsed or cond is signalled. It timeout equal to
sl@0:  * OWF_FOREVER, the call returns only after cond is signalled.
sl@0:  */
sl@0: OWF_API_CALL OWFboolean
sl@0: OWF_Cond_Wait(OWF_COND cond, OWFtime timeout);
sl@0: 
sl@0: /*! \brief Signal a condition variable
sl@0:  *
sl@0:  *  \param cond
sl@0:  *
sl@0:  *  Only one of waiters for cond will be woke-up
sl@0:  */
sl@0: OWF_API_CALL OWFboolean
sl@0: OWF_Cond_Signal(OWF_COND cond);
sl@0: 
sl@0: /*! \brief Signal a condition variable
sl@0:  *
sl@0:  *  \param cond
sl@0:  *
sl@0:  *  Wake-up all waiters of cond.
sl@0:  */
sl@0: OWF_API_CALL OWFboolean
sl@0: OWF_Cond_SignalAll(OWF_COND cond);
sl@0: 
sl@0: 
sl@0: #ifdef __cplusplus
sl@0: }
sl@0: #endif
sl@0: 
sl@0: 
sl@0: 
sl@0: #endif /* OWFCOND_H_ */