xref: /aoo41x/main/sal/inc/osl/semaphor.h (revision cdf0e10c)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef _OSL_SEMAPHORE_H_
29*cdf0e10cSrcweir #define _OSL_SEMAPHORE_H_
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include <sal/types.h>
32*cdf0e10cSrcweir 
33*cdf0e10cSrcweir #ifdef __cplusplus
34*cdf0e10cSrcweir extern "C" {
35*cdf0e10cSrcweir #endif
36*cdf0e10cSrcweir 
37*cdf0e10cSrcweir typedef void* oslSemaphore;
38*cdf0e10cSrcweir 
39*cdf0e10cSrcweir /** Creates a semaphore.<BR>
40*cdf0e10cSrcweir 
41*cdf0e10cSrcweir     @deprecated
42*cdf0e10cSrcweir     Must not be used, as unnamed semaphores are not supported on Mac OS X.
43*cdf0e10cSrcweir 
44*cdf0e10cSrcweir 	@param InitialCount denotes the starting value the semaphore. If you set it to
45*cdf0e10cSrcweir 	zero, the first acquire() blocks. Otherwise InitialCount acquire()s  are
46*cdf0e10cSrcweir 	immedeatly  successfull.
47*cdf0e10cSrcweir 	@return 0 if the semaphore could not be created, otherwise a handle to the sem.
48*cdf0e10cSrcweir */
49*cdf0e10cSrcweir oslSemaphore SAL_CALL osl_createSemaphore(sal_uInt32 initialCount);
50*cdf0e10cSrcweir 
51*cdf0e10cSrcweir /** Release the OS-structures and free semaphore data-structure
52*cdf0e10cSrcweir 
53*cdf0e10cSrcweir     @deprecated
54*cdf0e10cSrcweir     Must not be used, as unnamed semaphores are not supported on Mac OS X.
55*cdf0e10cSrcweir 
56*cdf0e10cSrcweir 	@return fbbb
57*cdf0e10cSrcweir */
58*cdf0e10cSrcweir void SAL_CALL osl_destroySemaphore(oslSemaphore Semaphore);
59*cdf0e10cSrcweir 
60*cdf0e10cSrcweir /** acquire() decreases the count. It will block if it tries to
61*cdf0e10cSrcweir 	decrease below zero.
62*cdf0e10cSrcweir 
63*cdf0e10cSrcweir     @deprecated
64*cdf0e10cSrcweir     Must not be used, as unnamed semaphores are not supported on Mac OS X.
65*cdf0e10cSrcweir 
66*cdf0e10cSrcweir 	@return False if the system-call failed.
67*cdf0e10cSrcweir */
68*cdf0e10cSrcweir sal_Bool SAL_CALL osl_acquireSemaphore(oslSemaphore Semaphore);
69*cdf0e10cSrcweir 
70*cdf0e10cSrcweir /** tryToAcquire() tries to decreases the count. It will
71*cdf0e10cSrcweir 	return with False if it would decrease the count below zero.
72*cdf0e10cSrcweir 	(When acquire() would block.) If it could successfully
73*cdf0e10cSrcweir 	decrease the count, it will return True.
74*cdf0e10cSrcweir 
75*cdf0e10cSrcweir     @deprecated
76*cdf0e10cSrcweir     Must not be used, as unnamed semaphores are not supported on Mac OS X.
77*cdf0e10cSrcweir */
78*cdf0e10cSrcweir sal_Bool SAL_CALL osl_tryToAcquireSemaphore(oslSemaphore Semaphore);
79*cdf0e10cSrcweir 
80*cdf0e10cSrcweir /** release() increases the count.
81*cdf0e10cSrcweir 
82*cdf0e10cSrcweir     @deprecated
83*cdf0e10cSrcweir     Must not be used, as unnamed semaphores are not supported on Mac OS X.
84*cdf0e10cSrcweir 
85*cdf0e10cSrcweir 	@return False if the system-call failed.
86*cdf0e10cSrcweir */
87*cdf0e10cSrcweir sal_Bool SAL_CALL osl_releaseSemaphore(oslSemaphore Semaphore);
88*cdf0e10cSrcweir 
89*cdf0e10cSrcweir #ifdef __cplusplus
90*cdf0e10cSrcweir }
91*cdf0e10cSrcweir #endif
92*cdf0e10cSrcweir 
93*cdf0e10cSrcweir #endif  /* _OSL_SEMAPHORE_H_  */
94*cdf0e10cSrcweir 
95*cdf0e10cSrcweir 
96