xref: /trunk/main/sal/inc/osl/mutex.h (revision 9eab2a37)
1*9eab2a37SAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3*9eab2a37SAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4*9eab2a37SAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5*9eab2a37SAndrew Rist  * distributed with this work for additional information
6*9eab2a37SAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7*9eab2a37SAndrew Rist  * to you under the Apache License, Version 2.0 (the
8*9eab2a37SAndrew Rist  * "License"); you may not use this file except in compliance
9*9eab2a37SAndrew Rist  * with the License.  You may obtain a copy of the License at
10*9eab2a37SAndrew Rist  *
11*9eab2a37SAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12*9eab2a37SAndrew Rist  *
13*9eab2a37SAndrew Rist  * Unless required by applicable law or agreed to in writing,
14*9eab2a37SAndrew Rist  * software distributed under the License is distributed on an
15*9eab2a37SAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*9eab2a37SAndrew Rist  * KIND, either express or implied.  See the License for the
17*9eab2a37SAndrew Rist  * specific language governing permissions and limitations
18*9eab2a37SAndrew Rist  * under the License.
19*9eab2a37SAndrew Rist  *
20*9eab2a37SAndrew Rist  *************************************************************/
21*9eab2a37SAndrew Rist 
22*9eab2a37SAndrew Rist 
23cdf0e10cSrcweir 
24cdf0e10cSrcweir #ifndef _OSL_MUTEX_H_
25cdf0e10cSrcweir #define _OSL_MUTEX_H_
26cdf0e10cSrcweir 
27cdf0e10cSrcweir #include <sal/types.h>
28cdf0e10cSrcweir 
29cdf0e10cSrcweir #ifdef __cplusplus
30cdf0e10cSrcweir extern "C" {
31cdf0e10cSrcweir #endif
32cdf0e10cSrcweir 
33cdf0e10cSrcweir struct _oslMutexImpl;
34cdf0e10cSrcweir typedef struct _oslMutexImpl * oslMutex;
35cdf0e10cSrcweir 
36cdf0e10cSrcweir /** Create a thread-local mutex.
37cdf0e10cSrcweir 	@return 0 if the mutex could not be created, otherwise a handle to the mutex.
38cdf0e10cSrcweir */
39cdf0e10cSrcweir oslMutex SAL_CALL osl_createMutex(void);
40cdf0e10cSrcweir 
41cdf0e10cSrcweir /** Release the OS-structures and free mutex data-structure.
42cdf0e10cSrcweir 	@param Mutex the mutex-handle
43cdf0e10cSrcweir */
44cdf0e10cSrcweir void SAL_CALL osl_destroyMutex(oslMutex Mutex);
45cdf0e10cSrcweir 
46cdf0e10cSrcweir /** Acquire the mutex, block if already acquired by another thread.
47cdf0e10cSrcweir 	@param Mutex handle to a created mutex.
48cdf0e10cSrcweir 	@return False if system-call fails.
49cdf0e10cSrcweir */
50cdf0e10cSrcweir sal_Bool SAL_CALL osl_acquireMutex(oslMutex Mutex);
51cdf0e10cSrcweir 
52cdf0e10cSrcweir /** Try to acquire the mutex without blocking.
53cdf0e10cSrcweir 	@param Mutex handle to a created mutex.
54cdf0e10cSrcweir 	@return False if it could not be acquired.
55cdf0e10cSrcweir */
56cdf0e10cSrcweir sal_Bool SAL_CALL osl_tryToAcquireMutex(oslMutex Mutex);
57cdf0e10cSrcweir 
58cdf0e10cSrcweir /** Release the mutex.
59cdf0e10cSrcweir 	@param Mutex handle to a created mutex.
60cdf0e10cSrcweir 	@return False if system-call fails.
61cdf0e10cSrcweir */
62cdf0e10cSrcweir sal_Bool SAL_CALL osl_releaseMutex(oslMutex Mutex);
63cdf0e10cSrcweir 
64cdf0e10cSrcweir /** Returns a unique and global mutex.
65cdf0e10cSrcweir 	@return the global mutex.
66cdf0e10cSrcweir */
67cdf0e10cSrcweir oslMutex * SAL_CALL osl_getGlobalMutex(void);
68cdf0e10cSrcweir 
69cdf0e10cSrcweir #ifdef __cplusplus
70cdf0e10cSrcweir }
71cdf0e10cSrcweir #endif
72cdf0e10cSrcweir 
73cdf0e10cSrcweir #endif	/* _OSL_MUTEX_H_ */
74