LibreOffice
LibreOffice 26.2 SDK C/C++ API Reference
Toggle main menu visibility
Loading...
Searching...
No Matches
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 "
osl/time.h
"
30
#include "
sal/saldllapi.h
"
31
32
#ifdef __cplusplus
33
extern
"C"
{
34
#endif
35
36
typedef
void
*
oslCondition
;
37
38
typedef
enum
{
39
osl_cond_result_ok
,
/*<! Successful completion. */
40
osl_cond_result_error
,
/*<! Error occurred. @see osl_getLastSocketError() */
41
osl_cond_result_timeout
,
/*<! Blocking operation timed out. */
42
osl_cond_result_FORCE_EQUAL_SIZE
=
SAL_MAX_ENUM
43
}
oslConditionResult
;
44
54
SAL_DLLPUBLIC
oslCondition
SAL_CALL
osl_createCondition
(
void
);
55
60
SAL_DLLPUBLIC
void
SAL_CALL
osl_destroyCondition
(
oslCondition
Condition);
61
69
SAL_DLLPUBLIC
sal_Bool
SAL_CALL
osl_setCondition
(
oslCondition
Condition);
70
76
SAL_DLLPUBLIC
sal_Bool
SAL_CALL
osl_resetCondition
(
oslCondition
Condition);
77
84
SAL_DLLPUBLIC
oslConditionResult
SAL_CALL
osl_waitCondition
(
oslCondition
Condition,
const
TimeValue
* pTimeout);
85
93
SAL_DLLPUBLIC
sal_Bool
SAL_CALL
osl_checkCondition
(
oslCondition
Condition);
94
95
#ifdef __cplusplus
96
}
97
#endif
98
99
#endif
// INCLUDED_OSL_CONDITN_H
100
101
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
SAL_MAX_ENUM
#define SAL_MAX_ENUM
Definition
types.h:205
sal_Bool
unsigned char sal_Bool
Definition
types.h:38
saldllapi.h
SAL_DLLPUBLIC
#define SAL_DLLPUBLIC
Definition
saldllapi.h:34
config.h
time.h
osl_resetCondition
SAL_DLLPUBLIC sal_Bool osl_resetCondition(oslCondition Condition)
Sets condition to False => wait() will block, check() returns False.
oslConditionResult
oslConditionResult
Definition
conditn.h:38
osl_cond_result_error
@ osl_cond_result_error
Definition
conditn.h:40
osl_cond_result_ok
@ osl_cond_result_ok
Definition
conditn.h:39
osl_cond_result_FORCE_EQUAL_SIZE
@ osl_cond_result_FORCE_EQUAL_SIZE
Definition
conditn.h:42
osl_cond_result_timeout
@ osl_cond_result_timeout
Definition
conditn.h:41
osl_createCondition
SAL_DLLPUBLIC oslCondition osl_createCondition(void)
Creates a condition.
osl_waitCondition
SAL_DLLPUBLIC oslConditionResult osl_waitCondition(oslCondition Condition, const TimeValue *pTimeout)
Blocks if condition is not set.
oslCondition
void * oslCondition
Definition
conditn.h:36
osl_setCondition
SAL_DLLPUBLIC sal_Bool osl_setCondition(oslCondition Condition)
Sets condition to True => wait() will not block, check() returns True.
osl_checkCondition
SAL_DLLPUBLIC sal_Bool osl_checkCondition(oslCondition Condition)
Queries the state of the condition without blocking.
osl_destroyCondition
SAL_DLLPUBLIC void osl_destroyCondition(oslCondition Condition)
Free the memory used by the condition.
TimeValue
Time since Jan-01-1970.
Definition
time.h:76
osl
conditn.h
Generated by
1.17.0