Bump version to 6.4-15
[LibreOffice.git] / include / osl / mutex.h
blobd624beb0cd864c01af6a6f0d070f37aeef4ad41a
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
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/.
9 * This file incorporates work covered by the following license notice:
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 .
20 #ifndef INCLUDED_OSL_MUTEX_H
21 #define INCLUDED_OSL_MUTEX_H
23 #include "sal/config.h"
25 #include "sal/saldllapi.h"
26 #include "sal/types.h"
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
32 struct _oslMutexImpl;
33 typedef struct _oslMutexImpl * oslMutex;
35 /** Create a mutex.
37 @return 0 if the mutex could not be created, otherwise a handle to the mutex.
39 SAL_DLLPUBLIC oslMutex SAL_CALL osl_createMutex(void);
41 /** Release the OS-structures and free mutex data-structure.
43 @param Mutex the mutex-handle
45 SAL_DLLPUBLIC void SAL_CALL osl_destroyMutex(oslMutex Mutex);
47 /** Acquire the mutex, block if already acquired by another thread.
48 @param Mutex handle to a created mutex.
49 @retval False if system-call fails.
51 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_acquireMutex(oslMutex Mutex);
53 /** Try to acquire the mutex without blocking.
55 @param Mutex handle to a created mutex.
57 @retval False if it could not be acquired.
59 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_tryToAcquireMutex(oslMutex Mutex);
61 /** Release the mutex.
63 @param Mutex handle to a created mutex.
64 @retval False if system-call fails.
66 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_releaseMutex(oslMutex Mutex);
68 /** Returns a unique and global mutex.
70 @return the global mutex.
72 SAL_DLLPUBLIC oslMutex * SAL_CALL osl_getGlobalMutex(void);
74 #ifdef __cplusplus
76 #endif
78 #endif // INCLUDED_OSL_MUTEX_H
80 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */