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_MUTEX_H_ 29*cdf0e10cSrcweir #define _OSL_MUTEX_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 struct _oslMutexImpl; 38*cdf0e10cSrcweir typedef struct _oslMutexImpl * oslMutex; 39*cdf0e10cSrcweir 40*cdf0e10cSrcweir /** Create a thread-local mutex. 41*cdf0e10cSrcweir @return 0 if the mutex could not be created, otherwise a handle to the mutex. 42*cdf0e10cSrcweir */ 43*cdf0e10cSrcweir oslMutex SAL_CALL osl_createMutex(void); 44*cdf0e10cSrcweir 45*cdf0e10cSrcweir /** Release the OS-structures and free mutex data-structure. 46*cdf0e10cSrcweir @param Mutex the mutex-handle 47*cdf0e10cSrcweir */ 48*cdf0e10cSrcweir void SAL_CALL osl_destroyMutex(oslMutex Mutex); 49*cdf0e10cSrcweir 50*cdf0e10cSrcweir /** Acquire the mutex, block if already acquired by another thread. 51*cdf0e10cSrcweir @param Mutex handle to a created mutex. 52*cdf0e10cSrcweir @return False if system-call fails. 53*cdf0e10cSrcweir */ 54*cdf0e10cSrcweir sal_Bool SAL_CALL osl_acquireMutex(oslMutex Mutex); 55*cdf0e10cSrcweir 56*cdf0e10cSrcweir /** Try to acquire the mutex without blocking. 57*cdf0e10cSrcweir @param Mutex handle to a created mutex. 58*cdf0e10cSrcweir @return False if it could not be acquired. 59*cdf0e10cSrcweir */ 60*cdf0e10cSrcweir sal_Bool SAL_CALL osl_tryToAcquireMutex(oslMutex Mutex); 61*cdf0e10cSrcweir 62*cdf0e10cSrcweir /** Release the mutex. 63*cdf0e10cSrcweir @param Mutex handle to a created mutex. 64*cdf0e10cSrcweir @return False if system-call fails. 65*cdf0e10cSrcweir */ 66*cdf0e10cSrcweir sal_Bool SAL_CALL osl_releaseMutex(oslMutex Mutex); 67*cdf0e10cSrcweir 68*cdf0e10cSrcweir /** Returns a unique and global mutex. 69*cdf0e10cSrcweir @return the global mutex. 70*cdf0e10cSrcweir */ 71*cdf0e10cSrcweir oslMutex * SAL_CALL osl_getGlobalMutex(void); 72*cdf0e10cSrcweir 73*cdf0e10cSrcweir #ifdef __cplusplus 74*cdf0e10cSrcweir } 75*cdf0e10cSrcweir #endif 76*cdf0e10cSrcweir 77*cdf0e10cSrcweir #endif /* _OSL_MUTEX_H_ */ 78