runtime/objc-sync.h

   1 /*
   2  * Copyright (c) 1999 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24  */
  25 //
  26 //  objc_sync.h
  27 //
  28 //  Copyright (c) 2002 Apple Computer, Inc. All rights reserved.
  29 //
  30
  31 #ifndef __OBJC_SNYC_H_
  32 #define __OBJC_SNYC_H_
  33
  34 #include <objc/objc.h>
  35
  36 // Begin synchronizing on 'obj'.
  37 // Allocates recursive pthread_mutex associated with 'obj' if needed.
  38 // Returns OBJC_SYNC_SUCCESS once lock is acquired.
  39 OBJC_EXPORT  int objc_sync_enter(id obj);
  40
  41 // End synchronizing on 'obj'.
  42 // Returns OBJC_SYNC_SUCCESS or OBJC_SYNC_NOT_OWNING_THREAD_ERROR
  43 OBJC_EXPORT  int objc_sync_exit(id obj);
  44
  45 // Temporarily release lock on 'obj' and wait for another thread to notify on 'obj'
  46 // Return OBJC_SYNC_SUCCESS, OBJC_SYNC_NOT_OWNING_THREAD_ERROR, OBJC_SYNC_TIMED_OUT
  47 OBJC_EXPORT  int objc_sync_wait(id obj, long long milliSecondsMaxWait);
  48
  49 // Wake up another thread waiting on 'obj'
  50 // Return OBJC_SYNC_SUCCESS, OBJC_SYNC_NOT_OWNING_THREAD_ERROR
  51 OBJC_EXPORT  int objc_sync_notify(id obj);
  52
  53 // Wake up all threads waiting on 'obj'
  54 // Return OBJC_SYNC_SUCCESS, OBJC_SYNC_NOT_OWNING_THREAD_ERROR
  55 OBJC_EXPORT  int objc_sync_notifyAll(id obj);
  56
  57 enum {
  58         OBJC_SYNC_SUCCESS                 = 0,
  59         OBJC_SYNC_NOT_OWNING_THREAD_ERROR = -1,
  60         OBJC_SYNC_TIMED_OUT               = -2,
  61         OBJC_SYNC_NOT_INITIALIZED         = -3
  62 };
  63
  64
  65 #endif // __OBJC_SNYC_H_