Foundation/NSThread/NSThread.h

   1 /* Copyright (c) 2006-2007 Christopher J. W. Lloyd
   2
   3 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
   4
   5 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
   6
   7 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
   8
   9 #import <Foundation/NSException.h>
  10 #import <Foundation/NSDate.h>
  11
  12 @class NSDictionary, NSMutableDictionary, NSAutoreleasePool, NSLock;
  13
  14 FOUNDATION_EXPORT NSString *const NSDidBecomeSingleThreadedNotification;
  15 FOUNDATION_EXPORT NSString *const NSWillBecomeMultiThreadedNotification;
  16 FOUNDATION_EXPORT NSString *const NSThreadWillExitNotification;
  17
  18 @interface NSThread : NSObject {
  19     NSMutableDictionary *_dictionary;
  20     NSMutableDictionary *_sharedObjects;
  21     NSLock *_sharedObjectLock;
  22     NSAutoreleasePool *_currentPool;
  23     NSExceptionFrame *_currentHandler;
  24     NSString *_name;
  25     SEL _selector;
  26     id _argument;
  27     id _target;
  28     BOOL _cancelled;
  29     BOOL _executing;
  30     BOOL _finished;
  31 }
  32
  33 + (BOOL)isMultiThreaded;
  34 + (BOOL)isMainThread;
  35
  36 + (NSThread *)mainThread;
  37
  38 + (void)detachNewThreadSelector:(SEL)selector toTarget:target
  39                      withObject:argument;
  40
  41 + (NSThread *)currentThread;
  42 + (NSArray *)callStackReturnAddresses;
  43 + (NSArray *)callStackSymbols;
  44
  45 + (double)threadPriority;
  46 + (BOOL)setThreadPriority:(double)value;
  47
  48 + (void)sleepUntilDate:(NSDate *)date;
  49 + (void)sleepForTimeInterval:(NSTimeInterval)value;
  50
  51 + (void)exit;
  52
  53 - init;
  54 - initWithTarget:target selector:(SEL)selector object:argument;
  55
  56 - (BOOL)isMainThread;
  57 - (BOOL)isCancelled;
  58 - (BOOL)isExecuting;
  59 - (BOOL)isFinished;
  60
  61 - (void)start;
  62 - (void)cancel;
  63 - (void)main;
  64
  65 - (NSString *)name;
  66 - (NSUInteger)stackSize;
  67
  68 - (NSMutableDictionary *)threadDictionary;
  69
  70 - (void)setName:(NSString *)value;
  71 - (void)setStackSize:(NSUInteger)value;
  72
  73 // private
  74 - (NSMutableDictionary *)sharedDictionary;
  75 - (void)setSharedObject:object forClassName:(NSString *)className;
  76
  77 @end
  78
  79 @interface NSObject (NSThread)
  80 - (void)performSelector:(SEL)selector onThread:(NSThread *)thread withObject:(id)object waitUntilDone:(BOOL)waitUntilDone modes:(NSArray *)modes;
  81 - (void)performSelector:(SEL)selector onThread:(NSThread *)thread withObject:(id)object waitUntilDone:(BOOL)waitUntilDone;
  82 - (void)performSelectorOnMainThread:(SEL)selector withObject:object waitUntilDone:(BOOL)waitUntilDone modes:(NSArray *)modes;
  83 - (void)performSelectorOnMainThread:(SEL)selector withObject:object waitUntilDone:(BOOL)waitUntilDone;
  84 - (void)performSelectorInBackground:(SEL)selector withObject:object;
  85 @end
  86
  87 // PRIVATE
  88 FOUNDATION_EXPORT NSThread *NSCurrentThread(void);
  89 FOUNDATION_EXPORT id NSThreadSharedInstance(NSString *className);
  90 FOUNDATION_EXPORT id NSThreadSharedInstanceDoNotCreate(NSString *className);