include/osl/conditn.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_OSL_CONDITN_H
  21 #define INCLUDED_OSL_CONDITN_H
  22
  23 #include <sal/config.h>
  24
  25 #include <osl/time.h>
  26 #include <sal/saldllapi.h>
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 typedef void* oslCondition;
  33
  34 typedef enum {
  35     osl_cond_result_ok,         /* successful completion */
  36     osl_cond_result_error,      /* error occurred, check osl_getLastSocketError() for details */
  37     osl_cond_result_timeout,    /* blocking operation timed out */
  38     osl_cond_result_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
  39 } oslConditionResult;
  40
  41 /** Creates a condition.
  42
  43     @deprecated use C++11's std::condition_variable instead
  44                 for a more robust and helpful condition.
  45
  46     The condition is in the reset-state.
  47     @retval 0 if condition could not be created.
  48 */
  49 SAL_DLLPUBLIC oslCondition SAL_CALL osl_createCondition(void);
  50
  51 /** Free the memory used by the condition.
  52     @param Condition the condition handle.
  53 */
  54 SAL_DLLPUBLIC void SAL_CALL osl_destroyCondition(oslCondition Condition);
  55
  56 /** Sets condition to True => wait() will not block, check() returns True.
  57     NOTE: ALL threads waiting on this condition are unblocked!
  58     @param Condition handle to a created condition.
  59     @retval False if system-call failed.
  60 */
  61 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_setCondition(oslCondition Condition);
  62
  63 /** Sets condition to False => wait() will block, check() returns False
  64     @param Condition handle to a created condition.
  65     @retval False if system-call failed.
  66 */
  67 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_resetCondition(oslCondition Condition);
  68
  69 /** Blocks if condition is not set
  70     If condition has been destroyed prematurely, wait() will
  71     return with False.
  72     @param Condition handle to a created condition.
  73     @param pTimeout Timeout value or NULL for infinite waiting
  74     @return False if system-call failed.
  75 */
  76 SAL_DLLPUBLIC oslConditionResult SAL_CALL osl_waitCondition(oslCondition Condition, const TimeValue* pTimeout);
  77
  78 /** Queries the state of the condition without blocking.
  79     @param Condition handle to a created condition.
  80     @retval True condition is set
  81     @retval False condition is not set
  82 */
  83 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_checkCondition(oslCondition Condition);
  84
  85 #ifdef __cplusplus
  86 }
  87 #endif
  88
  89 #endif // INCLUDED_OSL_CONDITN_H
  90
  91 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */