include/osl/mutex.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   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/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  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 .
  18  */
  19
  20 #ifndef INCLUDED_OSL_MUTEX_H
  21 #define INCLUDED_OSL_MUTEX_H
  22
  23 #include "sal/config.h"
  24
  25 #include "sal/saldllapi.h"
  26 #include "sal/types.h"
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 struct _oslMutexImpl;
  33 typedef struct _oslMutexImpl * oslMutex;
  34
  35 /** Create a mutex.
  36
  37     @return 0 if the mutex could not be created, otherwise a handle to the mutex.
  38 */
  39 SAL_DLLPUBLIC oslMutex SAL_CALL osl_createMutex(void);
  40
  41 /** Release the OS-structures and free mutex data-structure.
  42
  43     @param Mutex the mutex-handle
  44 */
  45 SAL_DLLPUBLIC void SAL_CALL osl_destroyMutex(oslMutex Mutex);
  46
  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.
  50 */
  51 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_acquireMutex(oslMutex Mutex);
  52
  53 /** Try to acquire the mutex without blocking.
  54
  55     @param Mutex handle to a created mutex.
  56
  57     @retval False if it could not be acquired.
  58 */
  59 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_tryToAcquireMutex(oslMutex Mutex);
  60
  61 /** Release the mutex.
  62
  63     @param Mutex handle to a created mutex.
  64     @retval False if system-call fails.
  65 */
  66 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_releaseMutex(oslMutex Mutex);
  67
  68 /** Returns a unique and global mutex.
  69
  70     @return the global mutex.
  71 */
  72 SAL_DLLPUBLIC oslMutex * SAL_CALL osl_getGlobalMutex(void);
  73
  74 #ifdef __cplusplus
  75 }
  76 #endif
  77
  78 #endif // INCLUDED_OSL_MUTEX_H
  79
  80 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */