Difference between revisions of "CPDistributedMessagingCenter"

From iPhone Development Wiki
Jump to: navigation, search
m
m
Line 1: Line 1:
{{occlass|library=AppSupport.framework}}
+
[[CPDistributedMessagingCenter]] is a wrapper over the existing messaging facilities in the operating system. It provides server-client communication between different processes using simple messages and dictionaries. All dictionaries transferred must be serializable as a property list.
  
[[CPDistributedMessagingCenter]] is a simple wrapper over the existing messaging facilities in the operating system. It provides two-way communication between different processes using simple messages and dictionaries. All dictionaries transferred must be serializable as a property list.
+
== Usage ==
 
+
=== Server ===
== Server ==
 
 
<source lang="objc">
 
<source lang="objc">
 
-(id)init... {
 
-(id)init... {
Line 29: Line 28:
 
</source>
 
</source>
  
== Client ==
+
=== Client ===
 
<source lang="objc">
 
<source lang="objc">
 
CPDistributedMessagingCenter *messagingCenter;
 
CPDistributedMessagingCenter *messagingCenter;
Line 35: Line 34:
  
 
// One-way (message only)
 
// One-way (message only)
[messagingCenter sendMessageName:@"message" userInfo:/* optional dictionary. in this example it will be ignored. */];
+
[messagingCenter sendMessageName:@"message" userInfo:nil/* optional dictionary. in this example it will be ignored. */];
  
 
// Two-way (wait for reply)
 
// Two-way (wait for reply)
 
NSDictionary *reply;
 
NSDictionary *reply;
reply = [messagingCenter sendMessageAndReceiveReplyName:@"messageThatHasInfo" userInfo:/* optional dictionary */];
+
reply = [messagingCenter sendMessageAndReceiveReplyName:@"messageThatHasInfo" userInfo:nil/* optional dictionary */];
 
</source>
 
</source>
 +
 +
== CPDistributedMessagingCenter as a MIG subsystem ==
 +
The CPDistributedMessagingCenter is a complex wrapper on top of the MIG-generated RPC subsystem (<tt>_CPDMCPDistributedMessaging_subsystem</tt>). The center name will in fact be registered as ''the'' service name in the bootstrap name. Therefore, existing services like <tt>com.apple.springboard.services</tt> cannot be used as the center name.
 +
 +
This subsystem has only 2 routines: 79000 (CPDMMessage) and 79001 (CPDMTwoWayMessage).
  
 
== Header ==
 
== Header ==
 
* http://github.com/kennytm/iphone-private-frameworks/blob/master/AppSupport/CPDistributedMessagingCenter.h
 
* http://github.com/kennytm/iphone-private-frameworks/blob/master/AppSupport/CPDistributedMessagingCenter.h
 +
 +
{{occlass|library=AppSupport.framework|navbox=1}}

Revision as of 12:53, 28 October 2009

CPDistributedMessagingCenter is a wrapper over the existing messaging facilities in the operating system. It provides server-client communication between different processes using simple messages and dictionaries. All dictionaries transferred must be serializable as a property list.

Usage

Server

-(id)init... {
...

  CPDistributedMessagingCenter *messagingCenter;
  // Center name must be unique, recommend using application identifier.
  messagingCenter = [CPDistributedMessagingCenter centerNamed:@"unique.name.for.messaging.center"];
  [messagingCenter runServerOnCurrentThread];

  // Register Messages
  [messagingCenter registerForMessageName:@"messageThatHasInfo" target:self selector:@selector(handleMessageNamed:withUserInfo:)];
  [messagingCenter registerForMessageName:@"message" target:self selector:@selector(handleSimpleMessageNamed:)];

...
}

- (NSDictionary *)handleMessageNamed:(NSString *)name withUserInfo:(NSDictionary *)userinfo {
    // Process userinfo (simple dictionary) and return a dictionary (or nil)
}

- (void)handleSimpleMessageNamed:(NSString *)name {
    // ...
}

Client

CPDistributedMessagingCenter *messagingCenter;
messagingCenter = [CPDistributedMessagingCenter centerNamed:@"unique.name.for.messaging.center"];

// One-way (message only)
[messagingCenter sendMessageName:@"message" userInfo:nil/* optional dictionary. in this example it will be ignored. */];

// Two-way (wait for reply)
NSDictionary *reply;
reply = [messagingCenter sendMessageAndReceiveReplyName:@"messageThatHasInfo" userInfo:nil/* optional dictionary */];

CPDistributedMessagingCenter as a MIG subsystem

The CPDistributedMessagingCenter is a complex wrapper on top of the MIG-generated RPC subsystem (_CPDMCPDistributedMessaging_subsystem). The center name will in fact be registered as the service name in the bootstrap name. Therefore, existing services like com.apple.springboard.services cannot be used as the center name.

This subsystem has only 2 routines: 79000 (CPDMMessage) and 79001 (CPDMTwoWayMessage).

Header