+++ /dev/null
-/*-*- Mode: ObjC; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-*/
-/*
- * InterThreadMessaging -- InterThreadMessaging.h
- * Created by toby on Tue Jun 19 2001.
- *
- * A low-cost-but-not-quite-as-general alternative to D.O.
- *
- */
-
-#import <Foundation/Foundation.h>
-
-
-@interface NSThread (InterThreadMessaging)
-
-/* The inter-thread messaging category methods use NSPorts to deliver messages
- between threads. In order to receive an inter-thread message, the receiver
- must both (1) be running a run loop; and (2) be monitoring this port in its
- run loop. You must call this method from the context of the thread you wish
- to prepare for inter-thread messages (which is why these are class methods).
-
- Before a thread can receive any inter-thread messages, it must invoke one
- of the following methods to prepare the thread and its run loop to receive
- these messages. In order to process a message from another thread, the
- receiving thread must, of course, be running its run loop. */
-
-+ (void) prepareForInterThreadMessages; // in NSDefaultRunLoopMode
-
-@end
-
-
-
-/* Invoke in the specified thread a method on an object. The target
- thread must have been readied for inter-thread messages by invoking
- +prepareForInterThreadMessages. It must be running its run loop in
- order to receive the messages.
-
- In some situations, a sender may be able to blast messages to an object
- faster than they can be processed in the target thread. To prevent things
- from spiraling out of control, the underlying NSPorts implement a throtling
- mechanism in the form of a fixed queue size. When this queue is filled, all
- further messages are rejected until until a message has been pulled off the
- queue. The sender may specify a limit date; if the queue is full, the
- sender will block until this limit date expires or until space is made in
- the queue. An NSPortTimeoutException exception is thrown if the limit date
- expires (or if no limit date is specified) before the message can be
- delivered.
-
- There is one very important point to watch out for: to prevent heinously
- difficult to debug memory smashers, the receing object and all of its
- arguments are retained in the context of the sending thread. When the
- message has been delivered in the target thread, these objects are auto-
- released IN THE CONTEXT OF THE TARGET THREAD. Thus, it is possible for
- the objects to be deallocated in a thread different from the one they were
- allocated in. (In general, you don't need to worry about simple/immutable
- objects, such as NSString, NSData, etc.) */
-
-@interface NSObject (InterThreadMessaging)
-
-- (void) performSelector:(SEL)selector
- inThread:(NSThread *)thread; // before date [NSDate distantFuture]
-
-- (void) performSelector:(SEL)selector
- inThread:(NSThread *)thread
- beforeDate:(NSDate *)limitDate;
-
-- (void) performSelector:(SEL)selector
- withObject:(id)object
- inThread:(NSThread *)thread; // before date [NSDate distantFuture]
-
-- (void) performSelector:(SEL)selector
- withObject:(id)object
- inThread:(NSThread *)thread
- beforeDate:(NSDate *)limitDate;
-
-- (void) performSelector:(SEL)selector
- withObject:(id)object1
- withObject:(id)object2
- inThread:(NSThread *)thread; // before date [NSDate distantFuture]
-
-- (void) performSelector:(SEL)selector
- withObject:(id)object1
- withObject:(id)object2
- inThread:(NSThread *)thread
- beforeDate:(NSDate *)limitDate;
-
-@end
-
-
-
-
-/* Post a notification in the specified thread. The target thread must
- have been readied for inter-thread messages by sending itself the
- +prepareForInterThreadMessages. It must be running its run loop in
- order to receive the messages.
-
- In some situations, a sender may be able to blast messages to an object
- faster than they can be processed in the target thread. To prevent things
- from spiraling out of control, the underlying NSPorts implement a throtling
- mechanism in the form of a fixed queue size. When this queue is filled, all
- further messages are rejected until until a message has been pulled off the
- queue. The sender may specify a limit date; if the queue is full, the
- sender will block until this limit date expires or until space is made in
- the queue. An NSPortTimeoutException exception is thrown if the limit date
- expires (or if no limit date is specified) before the message can be
- delivered.
-
- There is one very important point to watch out for: to prevent heinously
- difficult to debug memory smashers, the notification object (and
- consequently the userInfo dictionary) are retained in the context of
- the sending thread. When the message has been delivered in the target
- thread, the notification object is auto-released IN THE CONTEXT OF THE
- TARGET THREAD. Thus, it is possible for objects to be deallocated in a
- thread different from the one they were allocated in. (In general, you
- don't need to worry about simple/immutable objects, such as NSString,
- NSData, etc.) */
-
-@interface NSNotificationCenter (InterThreadMessaging)
-
-- (void) postNotification:(NSNotification *)notification
- inThread:(NSThread *)thread; // before date [NSDate distantFuture]
-
-- (void) postNotification:(NSNotification *)notification
- inThread:(NSThread *)thread
- beforeDate:(NSDate *)limitDate;
-
-- (void) postNotificationName:(NSString *)name
- object:(id)object
- inThread:(NSThread *)thread; // before date [NSDate distantFuture]
-
-- (void) postNotificationName:(NSString *)name
- object:(id)object
- inThread:(NSThread *)thread
- beforeDate:(NSDate *)limitDate;
-
-- (void) postNotificationName:(NSString *)name
- object:(id)object
- userInfo:(NSDictionary *)userInfo
- inThread:(NSThread *)thread; // before date [NSDate distantFuture]
-
-- (void) postNotificationName:(NSString *)name
- object:(id)object
- userInfo:(NSDictionary *)userInfo
- inThread:(NSThread *)thread
- beforeDate:(NSDate *)limitDate;
-
-@end
-
+++ /dev/null
-/*-*- Mode: ObjC; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-*/
-/*
- * InterThreadMessaging -- InterThreadMessaging.m
- * Created by toby on Tue Jun 19 2001.
- *
- * NOTE: this is a modified InterThreadMessaging that schedules on the run loop for the modal mode along with default
- *
- */
-
-#import <pthread.h>
-#import "InterThreadMessaging.h"
-
-/* There are four types of messages that can be posted between threads: a
- notification to be posted to the default notification centre and selectors
- to be performed with a varying number of arguments. (I was tempted to
- implement all three in terms of performSelector:withObject:withObject:
- and passing in nil for the empty arguments, but then it occurred to me
- that perhaps the receiver has overridden performSelector: and
- performSelector:withObject:. So I think I must disambiguate between
- them all.) */
-
-typedef enum InterThreadMessageType InterThreadMessageType;
-enum InterThreadMessageType
-{
- kITMPostNotification = 1,
- kITMPerformSelector0Args,
- kITMPerformSelector1Args,
- kITMPerformSelector2Args
-};
-
-
-/* The message contents are carried between threads in this struct. The
- struct is allocated in the sending thread and freed in the receiving thread.
- It is carried between the threads in an NSPortMessage - the NSPortMessage
- contains a single NSData argument, which is a wrapper around the pointer to
- this struct. */
-
-typedef struct InterThreadMessage InterThreadMessage;
-struct InterThreadMessage
-{
- InterThreadMessageType type;
- union {
- NSNotification *notification;
- struct {
- SEL selector;
- id receiver;
- id arg1;
- id arg2;
- } sel;
- } data;
-};
-
-
-
-/* Each thread is associated with an NSPort. This port is used to deliver
- messages to the target thread. */
-
-static NSMapTable *pThreadMessagePorts = NULL;
-static pthread_mutex_t pGate = { 0 };
-
-@interface InterThreadManager : NSObject
-+ (void) threadDied:(NSNotification *)notification;
-+ (void) handlePortMessage:(NSPortMessage *)msg;
-@end
-
-static void
-createMessagePortForThread (NSThread *thread, NSRunLoop *runLoop)
-{
- NSPort *port;
-
- assert(nil != thread);
- assert(nil != runLoop);
- assert(NULL != pThreadMessagePorts);
-
- pthread_mutex_lock(&pGate);
-
- port = NSMapGet(pThreadMessagePorts, thread);
- if (nil == port) {
- port = [[NSPort allocWithZone:NULL] init];
- [port setDelegate:[InterThreadManager class]];
- [port scheduleInRunLoop:runLoop forMode:NSModalPanelRunLoopMode]; // MJR: I need this for iPhotoToAnsel usage
- [port scheduleInRunLoop:runLoop forMode:NSDefaultRunLoopMode];
- NSMapInsertKnownAbsent(pThreadMessagePorts, thread, port);
-
- /* Transfer ownership of this port to the map table. */
- [port release];
- }
-
- pthread_mutex_unlock(&pGate);
-}
-
-static NSPort *
-messagePortForThread (NSThread *thread)
-{
- NSPort *port;
-
- assert(nil != thread);
- assert(NULL != pThreadMessagePorts);
-
- pthread_mutex_lock(&pGate);
- port = NSMapGet(pThreadMessagePorts, thread);
- pthread_mutex_unlock(&pGate);
-
- if (nil == port) {
- [NSException raise:NSInvalidArgumentException
- format:@"Thread %@ is not prepared to receive "
- @"inter-thread messages. You must invoke "
- @"+prepareForInterThreadMessages first.", thread];
- }
-
- return port;
-}
-
-static void
-removeMessagePortForThread (NSThread *thread, NSRunLoop *runLoop)
-{
- NSPort *port;
-
- assert(nil != thread);
- assert(NULL != pThreadMessagePorts);
-
- pthread_mutex_lock(&pGate);
-
- port = (NSPort *) NSMapGet(pThreadMessagePorts, thread);
- if (nil != port) {
- [port removeFromRunLoop:runLoop forMode:NSModalPanelRunLoopMode]; // ZWw: I added it, so I need to remove it
- [port removeFromRunLoop:runLoop forMode:NSDefaultRunLoopMode];
- NSMapRemove(pThreadMessagePorts, thread);
- }
-
- pthread_mutex_unlock(&pGate);
-}
-
-
-
-
-@implementation NSThread (InterThreadMessaging)
-
-+ (void) prepareForInterThreadMessages
-{
- /* Force the class initialization. */
- [InterThreadManager class];
-
- createMessagePortForThread([NSThread currentThread],
- [NSRunLoop currentRunLoop]);
-}
-
-@end
-
-
-
-
-@interface NSThread (SecretStuff)
-- (NSRunLoop *) runLoop;
-@end
-
-@implementation InterThreadManager
-
-+ (void) initialize
-{
- /* Create the mutex - this should be invoked by the Objective-C runtime
- (in a thread-safe manner) before any one can use this module, so I
- don't think I need to worry about race conditions here. */
- if (nil == pThreadMessagePorts) {
- pthread_mutex_init(&pGate, NULL);
-
- pThreadMessagePorts =
- NSCreateMapTable(NSNonRetainedObjectMapKeyCallBacks,
- NSObjectMapValueCallBacks, 0);
-
- [[NSNotificationCenter defaultCenter]
- addObserver:[self class]
- selector:@selector(threadDied:)
- name:NSThreadWillExitNotification
- object:nil];
- }
-}
-
-+ (void) threadDied:(NSNotification *)notification
-{
- NSThread *thread;
- NSRunLoop *runLoop;
-
- thread = [notification object];
- runLoop = [thread runLoop];
- if (nil != runLoop) {
- removeMessagePortForThread(thread, [thread runLoop]);
- }
-}
-
-+ (void) handlePortMessage:(NSPortMessage *)portMessage
-{
- InterThreadMessage *msg;
- NSArray *components;
- NSData *data;
-
- components = [portMessage components];
- assert(1 == [components count]);
-
- data = [components objectAtIndex:0];
- msg = *((InterThreadMessage **) [data bytes]);
-
- switch (msg->type)
- {
- case kITMPostNotification:
- [[NSNotificationCenter defaultCenter]
- postNotification:msg->data.notification];
- [msg->data.notification release];
- break;
-
- case kITMPerformSelector0Args:
- [msg->data.sel.receiver performSelector:msg->data.sel.selector];
- [msg->data.sel.receiver release];
- break;
-
- case kITMPerformSelector1Args:
- [msg->data.sel.receiver performSelector:msg->data.sel.selector
- withObject:msg->data.sel.arg1];
- [msg->data.sel.receiver release];
- [msg->data.sel.arg1 release];
- break;
-
- case kITMPerformSelector2Args:
- [msg->data.sel.receiver performSelector:msg->data.sel.selector
- withObject:msg->data.sel.arg1
- withObject:msg->data.sel.arg2];
- [msg->data.sel.receiver release];
- [msg->data.sel.arg1 release];
- [msg->data.sel.arg2 release];
- break;
-
- default:
- assert(0);
- }
-
- free(msg);
-}
-
-@end
-
-
-
-
-
-static void
-postMessage (InterThreadMessage *message, NSThread *thread, NSDate *limitDate)
-{
- NSPortMessage *portMessage;
- NSMutableArray *components;
- NSPort *port;
- NSData *data;
- BOOL retval;
-
- if (nil == thread) { thread = [NSThread currentThread]; }
- port = messagePortForThread(thread);
- assert(nil != port);
-
- data = [[NSData alloc] initWithBytes:&message length:sizeof(void *)];
- components = [[NSMutableArray alloc] initWithObjects:&data count:1];
- portMessage = [[NSPortMessage alloc] initWithSendPort:port
- receivePort:nil
- components:components];
-
- if (nil == limitDate) { limitDate = [NSDate distantFuture]; }
- retval = [portMessage sendBeforeDate:limitDate];
- [portMessage release];
- [components release];
- [data release];
-
- if (!retval) {
- [NSException raise:NSPortTimeoutException
- format:@"Can't send message to thread %@: timeout "
- @"before date %@", thread, limitDate];
- }
-}
-
-static void
-performSelector (InterThreadMessageType type, SEL selector, id receiver,
- id object1, id object2, NSThread *thread, NSDate *limitDate)
-{
- InterThreadMessage *msg;
-
- assert(NULL != selector);
-
- if (nil != receiver) {
- msg = (InterThreadMessage *) malloc(sizeof(struct InterThreadMessage));
- bzero(msg, sizeof(struct InterThreadMessage));
- msg->type = type;
- msg->data.sel.selector = selector;
- msg->data.sel.receiver = [receiver retain];
- msg->data.sel.arg1 = [object1 retain];
- msg->data.sel.arg2 = [object2 retain];
-
- postMessage(msg, thread, limitDate);
- }
-}
-
-static void
-postNotification (NSNotification *notification, NSThread *thread,
- NSDate *limitDate)
-{
- InterThreadMessage *msg;
-
- assert(nil != notification);
-
- msg = (InterThreadMessage *) malloc(sizeof(struct InterThreadMessage));
- bzero(msg, sizeof(struct InterThreadMessage));
- msg->type = kITMPostNotification;
- msg->data.notification = [notification retain];
-
- postMessage(msg, thread, limitDate);
-}
-
-
-
-
-
-
-@implementation NSObject (InterThreadMessaging)
-
-- (void) performSelector:(SEL)selector
- inThread:(NSThread *)thread
-{
- performSelector(kITMPerformSelector0Args, selector, self, nil, nil,
- thread, nil);
-}
-
-- (void) performSelector:(SEL)selector
- inThread:(NSThread *)thread
- beforeDate:(NSDate *)limitDate
-{
- performSelector(kITMPerformSelector0Args, selector, self, nil, nil,
- thread, limitDate);
-}
-
-- (void) performSelector:(SEL)selector
- withObject:(id)object
- inThread:(NSThread *)thread
-{
- performSelector(kITMPerformSelector1Args, selector, self, object, nil,
- thread, nil);
-}
-
-- (void) performSelector:(SEL)selector
- withObject:(id)object
- inThread:(NSThread *)thread
- beforeDate:(NSDate *)limitDate
-{
- performSelector(kITMPerformSelector1Args, selector, self, object, nil,
- thread, limitDate);
-}
-
-- (void) performSelector:(SEL)selector
- withObject:(id)object1
- withObject:(id)object2
- inThread:(NSThread *)thread
-{
- performSelector(kITMPerformSelector2Args, selector, self, object1, object2,
- thread, nil);
-}
-
-- (void) performSelector:(SEL)selector
- withObject:(id)object1
- withObject:(id)object2
- inThread:(NSThread *)thread
- beforeDate:(NSDate *)limitDate
-{
- performSelector(kITMPerformSelector2Args, selector, self, object1, object2,
- thread, limitDate);
-}
-
-@end
-
-
-
-@implementation NSNotificationCenter (InterThreadMessaging)
-
-- (void) postNotification:(NSNotification *)notification
- inThread:(NSThread *)thread
-{
- postNotification(notification, thread, nil);
-}
-
-- (void) postNotification:(NSNotification *)notification
- inThread:(NSThread *)thread
- beforeDate:(NSDate *)limitDate
-{
- postNotification(notification, thread, limitDate);
-}
-
-- (void) postNotificationName:(NSString *)name
- object:(id)object
- inThread:(NSThread *)thread
-{
- NSNotification *notification;
-
- notification = [NSNotification notificationWithName:name
- object:object
- userInfo:nil];
- postNotification(notification, thread, nil);
-}
-
-- (void) postNotificationName:(NSString *)name
- object:(id)object
- inThread:(NSThread *)thread
- beforeDate:(NSDate *)limitDate
-{
- NSNotification *notification;
-
- notification = [NSNotification notificationWithName:name
- object:object
- userInfo:nil];
- postNotification(notification, thread, limitDate);
-}
-
-- (void) postNotificationName:(NSString *)name
- object:(id)object
- userInfo:(NSDictionary *)userInfo
- inThread:(NSThread *)thread
-{
- NSNotification *notification;
-
- notification = [NSNotification notificationWithName:name
- object:object
- userInfo:userInfo];
- postNotification(notification, thread, nil);
-}
-
-- (void) postNotificationName:(NSString *)name
- object:(id)object
- userInfo:(NSDictionary *)userInfo
- inThread:(NSThread *)thread
- beforeDate:(NSDate *)limitDate
-{
- NSNotification *notification;
-
- notification = [NSNotification notificationWithName:name
- object:object
- userInfo:userInfo];
- postNotification(notification, thread, limitDate);
-}
-
-@end
-
-
projects / horde.git / commitdiff