1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski 25*b1cdbd2cSJim Jagielski #ifndef _OSL_CONDITION_H_ 26*b1cdbd2cSJim Jagielski #define _OSL_CONDITION_H_ 27*b1cdbd2cSJim Jagielski 28*b1cdbd2cSJim Jagielski #include <osl/time.h> 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski #ifdef __cplusplus 31*b1cdbd2cSJim Jagielski extern "C" { 32*b1cdbd2cSJim Jagielski #endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski typedef void* oslCondition; 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski typedef enum { 37*b1cdbd2cSJim Jagielski osl_cond_result_ok, /* successful completion */ 38*b1cdbd2cSJim Jagielski osl_cond_result_error, /* error occured, check osl_getLastSocketError() for details */ 39*b1cdbd2cSJim Jagielski osl_cond_result_timeout, /* blocking operation timed out */ 40*b1cdbd2cSJim Jagielski osl_cond_result_FORCE_EQUAL_SIZE = SAL_MAX_ENUM 41*b1cdbd2cSJim Jagielski } oslConditionResult; 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski /** Creates a condition. 44*b1cdbd2cSJim Jagielski The condition is in the reset-state. 45*b1cdbd2cSJim Jagielski @returns 0 if condition could not be created. 46*b1cdbd2cSJim Jagielski */ 47*b1cdbd2cSJim Jagielski oslCondition SAL_CALL osl_createCondition(void); 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski /** Free the memory used by the condition. 50*b1cdbd2cSJim Jagielski @param Condition the condition handle. 51*b1cdbd2cSJim Jagielski */ 52*b1cdbd2cSJim Jagielski void SAL_CALL osl_destroyCondition(oslCondition Condition); 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielski /** Sets condition to True => wait() will not block, check() returns True. 55*b1cdbd2cSJim Jagielski NOTE: ALL threads waiting on this condition are unblocked! 56*b1cdbd2cSJim Jagielski @param Condition handle to a created condition. 57*b1cdbd2cSJim Jagielski @return False if system-call failed. 58*b1cdbd2cSJim Jagielski */ 59*b1cdbd2cSJim Jagielski sal_Bool SAL_CALL osl_setCondition(oslCondition Condition); 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski /** Sets condition to False => wait() will block, check() returns False 62*b1cdbd2cSJim Jagielski @param Condition handle to a created condition. 63*b1cdbd2cSJim Jagielski @return False if system-call failed. 64*b1cdbd2cSJim Jagielski */ 65*b1cdbd2cSJim Jagielski sal_Bool SAL_CALL osl_resetCondition(oslCondition Condition); 66*b1cdbd2cSJim Jagielski 67*b1cdbd2cSJim Jagielski /** Blocks if condition is not set<BR> 68*b1cdbd2cSJim Jagielski If condition has been destroyed prematurely, wait() will 69*b1cdbd2cSJim Jagielski return with False. 70*b1cdbd2cSJim Jagielski @param Condition handle to a created condition. 71*b1cdbd2cSJim Jagielski @param pTimeout Tiemout value or NULL for infinite waiting 72*b1cdbd2cSJim Jagielski @return False if system-call failed. 73*b1cdbd2cSJim Jagielski */ 74*b1cdbd2cSJim Jagielski oslConditionResult SAL_CALL osl_waitCondition(oslCondition Condition, const TimeValue* pTimeout); 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski /** Queries the state of the condition without blocking. 77*b1cdbd2cSJim Jagielski @param Condition handle to a created condition. 78*b1cdbd2cSJim Jagielski @return True: condition is set. <BR> 79*b1cdbd2cSJim Jagielski False: condition is not set. <BR> 80*b1cdbd2cSJim Jagielski */ 81*b1cdbd2cSJim Jagielski sal_Bool SAL_CALL osl_checkCondition(oslCondition Condition); 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski #ifdef __cplusplus 84*b1cdbd2cSJim Jagielski } 85*b1cdbd2cSJim Jagielski #endif 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski #endif /* _OSL_CONDITION_H_ */ 88*b1cdbd2cSJim Jagielski 89