LibreOfficeDev
LibreOfficeDev 27.2 SDK C/C++ API Reference
conditn.h
Go to the documentation of this file.
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 /*
21  * This file is part of LibreOffice published API.
22  */
23 
24 #ifndef INCLUDED_OSL_CONDITN_H
25 #define INCLUDED_OSL_CONDITN_H
26 
27 #include "sal/config.h"
28 
29 #include "sal/saldllapi.h"
30 
31 #if defined LIBO_INTERNAL_ONLY && defined __cplusplus
32 struct TimeValue;
33 #else
34 #include "osl/time.h"
35 #endif
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 occurred. @see osl_getLastSocketError() */
46  osl_cond_result_timeout, /*<! Blocking operation timed out. */
49 
60 
66 
75 
82 
90 
99 
100 #ifdef __cplusplus
101 }
102 #endif
103 
104 #endif // INCLUDED_OSL_CONDITN_H
105 
106 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
#define SAL_DLLPUBLIC
Definition: saldllapi.h:34
#define SAL_MAX_ENUM
Definition: types.h:205
unsigned char sal_Bool
Definition: types.h:38
SAL_DLLPUBLIC sal_Bool osl_resetCondition(oslCondition Condition)
Sets condition to False => wait() will block, check() returns False.
oslConditionResult
Definition: conditn.h:43
@ osl_cond_result_error
Definition: conditn.h:45
@ osl_cond_result_ok
Definition: conditn.h:44
@ osl_cond_result_FORCE_EQUAL_SIZE
Definition: conditn.h:47
@ osl_cond_result_timeout
Definition: conditn.h:46
SAL_DLLPUBLIC oslCondition osl_createCondition(void)
Creates a condition.
SAL_DLLPUBLIC oslConditionResult osl_waitCondition(oslCondition Condition, const TimeValue *pTimeout)
Blocks if condition is not set.
void * oslCondition
Definition: conditn.h:41
SAL_DLLPUBLIC sal_Bool osl_setCondition(oslCondition Condition)
Sets condition to True => wait() will not block, check() returns True.
SAL_DLLPUBLIC sal_Bool osl_checkCondition(oslCondition Condition)
Queries the state of the condition without blocking.
SAL_DLLPUBLIC void osl_destroyCondition(oslCondition Condition)
Free the memory used by the condition.
Time since Jan-01-1970.
Definition: time.h:76