Up

NSNotificationCenter class reference

Authors

Andrew Kachites McCallum (mccallum@gnu.ai.mit.edu)
Richard Frith-Macdonald (rfm@gnu.org)
Richard Frith-Macdonald (richard@brainstorm.co.uk)

Version: 29753

Date: 2010-02-25 18:49:31 +0000 (Thu, 25 Feb 2010)

Copyright: (C) 1996,1999 Free Software Foundation, Inc.


Contents -

  1. Software documentation for the NSNotification class
  2. Software documentation for the NSNotificationCenter class

Software documentation for the NSNotification class

NSNotification : NSObject

Declared in:
Foundation/NSNotification.h
Conforms to:
NSCopying
NSCoding
Availability: OpenStep

Represents a notification for posting to an NSNotificationCenter . Consists of a name, an object, and an optional dictionary. The notification center will check for observers registered to receive either notifications with the name, the object, or both and pass the notification instance on to them.

This class is actually the interface for a class cluster, so instances will be of a (private) subclass.

Method summary

notificationWithName: object: 

+ (NSNotification*) notificationWithName: (NSString*)name object: (id)object;
Availability: OpenStep

Create a new autoreleased notification by calling +notificationWithName:object:userInfo: with a nil user info argument.

notificationWithName: object: userInfo: 

+ (NSNotification*) notificationWithName: (NSString*)name object: (id)object userInfo: (NSDictionary*)info;
Availability: OpenStep

Create a new autoreleased notification.

name 

- (NSString*) name;
Availability: OpenStep

Returns the notification name.

object 

- (id) object;
Availability: OpenStep

Returns the notification object.

userInfo 

- (NSDictionary*) userInfo;
Availability: OpenStep

Returns the notification user information.

Software documentation for the NSNotificationCenter class

NSNotificationCenter : NSObject

Declared in:
Foundation/NSNotification.h
Availability: OpenStep

GNUstep provides a framework for sending messages between objects within a process called notifications. Objects register with an NSNotificationCenter to be informed whenever other objects post NSNotification s to it matching certain criteria. The notification center processes notifications synchronously -- that is, control is only returned to the notification poster once every recipient of the notification has received it and processed it. Asynchronous processing is possible using an NSNotificationQueue .

Obtain an instance using the +defaultCenter method.

In a multithreaded process, notifications are always sent on the thread that they are posted from.

Use the NSDistributedNotificationCenter for interprocess communications on the same machine.

Method summary

defaultCenter 

+ (NSNotificationCenter*) defaultCenter;
Availability: OpenStep

Returns the default notification center being used for this task (process). This is used for all notifications posted by the Base library unless otherwise noted.

addObserver: selector: name: object: 

- (void) addObserver: (id)observer selector: (SEL)selector name: (NSString*)name object: (id)object;
Availability: OpenStep

Registers observer to receive notifications with the name notificationName and/or containing object (one or both of these two must be non-nil; nil acts like a wildcard). When a notification of name name containing object is posted, observer receives a selector message with this notification as the argument. The notification center waits for the observer to finish processing the message, then informs the next registree matching the notification, and after all of this is done, control returns to the poster of the notification. Therefore the processing in the selector implementation should be short.

The notification center does not retain observer or object. Therefore, you should always send removeObserver: or removeObserver:name:object: to the notification center before releasing these objects.
As a convenience, when built with garbage collection, you do not need to remove any garbage collected observer as the system will do it implicitly.

NB. For MacOS-X compatibility, adding an observer multiple times will register it to receive multiple copies of any matching notification, however removing an observer will remove all of the multiple registrations.


postNotification: 

- (void) postNotification: (NSNotification*)notification;
Availability: OpenStep

Posts notification to all the observers that match its NAME and OBJECT.
The GNUstep implementation calls -postNotificationName:object:userInfo: to perform the actual posting.

postNotificationName: object: 

- (void) postNotificationName: (NSString*)name object: (id)object;
Availability: OpenStep

Creates and posts a notification using the -postNotificationName:object:userInfo: passing a nil user info argument.

postNotificationName: object: userInfo: 

- (void) postNotificationName: (NSString*)name object: (id)object userInfo: (NSDictionary*)info;
Availability: OpenStep

The preferred method for posting a notification.
For performance reasons, we don't wrap an exception handler round every message sent to an observer. This means that, if one observer raises an exception, later observers in the lists will not get the notification.

removeObserver: 

- (void) removeObserver: (id)observer;
Availability: OpenStep

Deregisters observer from all notifications. This should be called before the observer is deallocated.

removeObserver: name: object: 

- (void) removeObserver: (id)observer name: (NSString*)name object: (id)object;
Availability: OpenStep

Deregisters observer for notifications matching name and/or object. If either or both is nil, they act like wildcards. The observer may still remain registered for other notifications; use -removeObserver: to remove it from all. If observer is nil, the effect is to remove all registrees for the specified notifications, unless both observer and name are nil, in which case nothing is done.


Up