1*cdf0e10cSrcweir /************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir 29*cdf0e10cSrcweir #ifndef _OSL_CONDITION_H_ 30*cdf0e10cSrcweir #define _OSL_CONDITION_H_ 31*cdf0e10cSrcweir 32*cdf0e10cSrcweir #include <osl/time.h> 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir #ifdef __cplusplus 35*cdf0e10cSrcweir extern "C" { 36*cdf0e10cSrcweir #endif 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir typedef void* oslCondition; 39*cdf0e10cSrcweir 40*cdf0e10cSrcweir typedef enum { 41*cdf0e10cSrcweir osl_cond_result_ok, /* successful completion */ 42*cdf0e10cSrcweir osl_cond_result_error, /* error occured, check osl_getLastSocketError() for details */ 43*cdf0e10cSrcweir osl_cond_result_timeout, /* blocking operation timed out */ 44*cdf0e10cSrcweir osl_cond_result_FORCE_EQUAL_SIZE = SAL_MAX_ENUM 45*cdf0e10cSrcweir } oslConditionResult; 46*cdf0e10cSrcweir 47*cdf0e10cSrcweir /** Creates a condition. 48*cdf0e10cSrcweir The condition is in the reset-state. 49*cdf0e10cSrcweir @returns 0 if condition could not be created. 50*cdf0e10cSrcweir */ 51*cdf0e10cSrcweir oslCondition SAL_CALL osl_createCondition(void); 52*cdf0e10cSrcweir 53*cdf0e10cSrcweir /** Free the memory used by the condition. 54*cdf0e10cSrcweir @param Condition the condition handle. 55*cdf0e10cSrcweir */ 56*cdf0e10cSrcweir void SAL_CALL osl_destroyCondition(oslCondition Condition); 57*cdf0e10cSrcweir 58*cdf0e10cSrcweir /** Sets condition to True => wait() will not block, check() returns True. 59*cdf0e10cSrcweir NOTE: ALL threads waiting on this condition are unblocked! 60*cdf0e10cSrcweir @param Condition handle to a created condition. 61*cdf0e10cSrcweir @return False if system-call failed. 62*cdf0e10cSrcweir */ 63*cdf0e10cSrcweir sal_Bool SAL_CALL osl_setCondition(oslCondition Condition); 64*cdf0e10cSrcweir 65*cdf0e10cSrcweir /** Sets condition to False => wait() will block, check() returns False 66*cdf0e10cSrcweir @param Condition handle to a created condition. 67*cdf0e10cSrcweir @return False if system-call failed. 68*cdf0e10cSrcweir */ 69*cdf0e10cSrcweir sal_Bool SAL_CALL osl_resetCondition(oslCondition Condition); 70*cdf0e10cSrcweir 71*cdf0e10cSrcweir /** Blocks if condition is not set<BR> 72*cdf0e10cSrcweir If condition has been destroyed prematurely, wait() will 73*cdf0e10cSrcweir return with False. 74*cdf0e10cSrcweir @param Condition handle to a created condition. 75*cdf0e10cSrcweir @param pTimeout Tiemout value or NULL for infinite waiting 76*cdf0e10cSrcweir @return False if system-call failed. 77*cdf0e10cSrcweir */ 78*cdf0e10cSrcweir oslConditionResult SAL_CALL osl_waitCondition(oslCondition Condition, const TimeValue* pTimeout); 79*cdf0e10cSrcweir 80*cdf0e10cSrcweir /** Queries the state of the condition without blocking. 81*cdf0e10cSrcweir @param Condition handle to a created condition. 82*cdf0e10cSrcweir @return True: condition is set. <BR> 83*cdf0e10cSrcweir False: condition is not set. <BR> 84*cdf0e10cSrcweir */ 85*cdf0e10cSrcweir sal_Bool SAL_CALL osl_checkCondition(oslCondition Condition); 86*cdf0e10cSrcweir 87*cdf0e10cSrcweir #ifdef __cplusplus 88*cdf0e10cSrcweir } 89*cdf0e10cSrcweir #endif 90*cdf0e10cSrcweir 91*cdf0e10cSrcweir #endif /* _OSL_CONDITION_H_ */ 92*cdf0e10cSrcweir 93