Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

XPC simplified for Cocoa. Deal with NS* objects instead of xpc_object_t.

branch: master

This branch is 0 commits ahead and 0 commits behind master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 TestApp
Octocat-spinner-32 TestService
Octocat-spinner-32 XPCKit.xcodeproj
Octocat-spinner-32 XPCKit.xcworkspace
Octocat-spinner-32 XPCKit
Octocat-spinner-32 XPCKitTests
Octocat-spinner-32 .gitignore
Octocat-spinner-32 README.md
README.md

This Fork

...is a substantial extension/modification to the original XPCKit. Its highlights are:

  • Supports messages associated with a specific reply handler (like xpc_connection_send_message_with_reply)
  • Supports messages containing objects conforming to the NSCoding protocol
  • Supports sending a message to an object once it reached the other process
  • Supports environment agnostic (XPC/non-XPC) message dispatching (very convenient if you plan to run on OS X 10.6 (though 10.6 API compatiblity not tested yet))

This fork is not API-compatible with its origin and its API is still in flux


The original readme:

XPCKit is a Cocoa library for wrapping the XPC C APIs in a handy object-oriented model. It is merely meant as an object-oriented wrapper for the C library, and does not attempt to layer any additional semantics on top. It contains code to run both "clients" (which create connections to services) and "services" (which receive connections), although you can mix and match to write raw C code or Objective-C code between different clients and services.

Features

  • Simplified Objective-C API for interacting with XPC processes
  • Auto-boxing and auto-unboxing of objects from xpc_object_t objects to:
    • NSArray
    • NSDictionary
    • NSData
    • NSString
    • NSDate
    • NSNumber for bool, UInt64, Int64, and double types
    • NSFileHandle
    • UUIDs (via a custom XPCUUID class)
  • Block-based callbacks
  • Probably safe to use from multiple threads

Wish List

  • Auto-boxing and auto-unboxing for
    • NSData, backed by shared memory (some code for this exists but it is not reliable, causes crashes, doesn't return consistent data, etc.)
    • IOSurfaceRef
    • XPCConnection
  • Compatibility mode for iOS/Snow Leopard
    • Both client and service code lives within the app
    • A mapping of service names to their classes would be added by the developer to the app's Info.plist
    • Objects would be passed through XPCConnection to an XPCService that is contained within the same process
    • No xpc_* types would be available

Authors

Sample Code

Given this sample data, converted to an NSDictionary, you can see how:

  • the client sends this command as a message, and
  • the service receives this command, processes it, and sends the response back

Installation

You can use XPCKit in the client, service, or both; you just have to include the code. You can include XPCKit in one of three ways:

  1. Include the source files yourself (everything in XPCKit)
  2. Make a dependency of XPCKit's framework
  3. Make a dependency of XPCKit's static library (note: you will need to add linker flags -all_load and -ObjC to make this work properly)

Setting up the Client

  1. In your app, add the XPCKit source files, library or framework
  2. Set up an XPCConnection object with the name of your service
  3. Send it a message

Setting up the Service

  1. If you haven't already, create a new "XPC Service" target (located in Mac OS X > Framework & Library)
  2. Add the XPCKit source files, library or framework
  3. Link against the Foundation framework
  4. Rename "main.c" to "main.m"
  5. In your main function, call +[XPCService runServiceWithConnectionHandler:] to start listening for incoming connections.
  6. In the connection handler, set an event handler on the XPCConnection to receive messages.

License

Copyright 2011 XPCKit

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Something went wrong with that request. Please try again.