sal/inc/osl/conditn.h

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