1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
/*************************************************************************
*
* $RCSfile: conditn.h,v $
*
* $Revision: 1.5 $
*
* last change: $Author: obr $ $Date: 2001-11-08 15:48:05 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef _OSL_CONDITION_H_
#define _OSL_CONDITION_H_
#ifndef _OSL_TIME_H_
#include <osl/time.h>
#endif
#ifdef __cplusplus
extern "C" {
#endif
/** condition synchronization object handle
@seealso osl_createCondition()
*/
typedef void* oslCondition;
/** enumeration of possible error values for conditions
@seealso osl_waitCondition()
*/
typedef enum {
/** successful completion */
osl_cond_result_ok,
/** an unspecified error occured */
osl_cond_result_error,
/** blocking operation timed out */
osl_cond_result_timeout,
osl_cond_result_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
} oslConditionResult;
/** Creates a condition.
The condition is in the reset-state.
@return a pointer to the created condition object or
NULL if the condition could not be created.
*/
oslCondition SAL_CALL osl_createCondition(void);
/** Free the memory used by the condition.
@param Condition the condition handle.
*/
void SAL_CALL osl_destroyCondition(oslCondition Condition);
/** Sets the condition state to set
Any call to osl_waitCondition() will not block, osl_checkCondition()
returns sal_True.
NOTE: ALL threads waiting on this condition are unblocked!
@param Condition handle to a created condition.
@return sal_True if the condition has been set or
sal_False if the system-call failed.
*/
sal_Bool SAL_CALL osl_setCondition(oslCondition Condition);
/** Resets condition to unset state
Any call to osl_waitCondition() will block, osl_checkCondition()
will return sal_False.
@param Condition handle to a created condition.
@return sal_True if the condition has been unset or
sal_False if the system-call failed.
*/
sal_Bool SAL_CALL osl_resetCondition(oslCondition Condition);
/** Blocks if condition is not set.
If condition has been destroyed prematurely, osl_waitCondition()
will return sal_False.
@param Condition handle to a created condition.
@param pTimeout Tiemout value or NULL for infinite waiting
@return on of the following result values: osl_cond_result_ok,
osl_cond_result_error, osl_cond_result_timeout.
*/
oslConditionResult SAL_CALL osl_waitCondition(oslCondition Condition, const TimeValue* pTimeout);
/** Queries the state of the condition without blocking.
@param Condition handle to a created condition.
@return sal_True if condition is in set state or sal_False otherwise.
*/
sal_Bool SAL_CALL osl_checkCondition(oslCondition Condition);
#ifdef __cplusplus
}
#endif
#endif /* _OSL_CONDITION_H_ */
|
