runtime/objc-sync.h

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