LibreOffice LibreOffice 4.4 SDK C/C++ API Reference

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List
- File Members

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 #ifndef INCLUDED_OSL_CONDITN_H
22 #define INCLUDED_OSL_CONDITN_H
23
24 #include <sal/config.h>
25
26 #include <osl/time.h>
27 #include <sal/saldllapi.h>
28
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32
33 typedef void* oslCondition;
34
35 typedef enum {
36 osl_cond_result_ok, /* successful completion */
37 osl_cond_result_error, /* error occurred, check osl_getLastSocketError() for details */
38 osl_cond_result_timeout, /* blocking operation timed out */
39 osl_cond_result_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
40 } oslConditionResult;
41
46 SAL_DLLPUBLIC oslCondition SAL_CALL osl_createCondition(void);
47
51 SAL_DLLPUBLIC void SAL_CALL osl_destroyCondition(oslCondition Condition);
52
58 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_setCondition(oslCondition Condition);
59
64 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_resetCondition(oslCondition Condition);
65
73 SAL_DLLPUBLIC oslConditionResult SAL_CALL osl_waitCondition(oslCondition Condition, const TimeValue* pTimeout);
74
80 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_checkCondition(oslCondition Condition);
81
82 #ifdef __cplusplus
83 }
84 #endif
85
86 #endif // INCLUDED_OSL_CONDITN_H
87
88 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
sal_Bool
unsigned char sal_Bool
Definition: types.h:48
saldllapi.h
osl_resetCondition
SAL_DLLPUBLIC sal_Bool osl_resetCondition(oslCondition Condition)
Sets condition to False => wait() will block, check() returns False.
osl_createCondition
SAL_DLLPUBLIC oslCondition osl_createCondition(void)
Creates a condition.
osl_cond_result_ok
Definition: conditn.h:36
osl_checkCondition
SAL_DLLPUBLIC sal_Bool osl_checkCondition(oslCondition Condition)
Queries the state of the condition without blocking.
oslCondition
void * oslCondition
Definition: conditn.h:33
osl_cond_result_FORCE_EQUAL_SIZE
Definition: conditn.h:39
osl_waitCondition
SAL_DLLPUBLIC oslConditionResult osl_waitCondition(oslCondition Condition, const TimeValue *pTimeout)
Blocks if condition is not set If condition has been destroyed prematurely, wait() will return with ...
time.h
osl_cond_result_timeout
Definition: conditn.h:38
osl_cond_result_error
Definition: conditn.h:37
osl_setCondition
SAL_DLLPUBLIC sal_Bool osl_setCondition(oslCondition Condition)
Sets condition to True => wait() will not block, check() returns True.
oslConditionResult
oslConditionResult
Definition: conditn.h:35
TimeValue
Definition: time.h:42
config.h
SAL_DLLPUBLIC
#define SAL_DLLPUBLIC
Definition: saldllapi.h:30
osl_destroyCondition
SAL_DLLPUBLIC void osl_destroyCondition(oslCondition Condition)
Free the memory used by the condition.