sal/inc/osl/semaphor.h

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