Simperium libraries and samples
The easiest way to add Simperium is to download the latest release. Unzip the source code somewhere convenient.
Then, drag and drop Simperium.xcodeproj into your application's project, and add Simperium.framework in your target's Build Phase tab (under Link Binary with Libraries). You'll still need to add some dependencies.
Everything works pretty much the same on OSX. Some changes are noted in the online documentation.
The master branch always has the latest stable release, and is tagged. Simperium is used by hundreds of thousands of people across many different apps and devices, and is considered production-ready.
The develop branch has an ongoing development build (not intended for production use).
Simperium. Everything is accessed from a
Simperiuminstance. This class can be safely instantiated more than once in the same app (e.g. for unit testing).
Object. Simperium does a lot of diffing in order to send only data that changes. Any object class that conforms to the
SPDiffableprotocol can be supported.
SPManagedObjectis for Core Data, and
SPObjectis a container for raw JSON (not yet supported).
SPGhostis an object's opinion of its own state on the server (the name "ghost" was borrowed from the Tribes Networking Model).
SPDiffercan perform diffs on any
SPDiffableobject. Each differ adheres to an
SPSchema. The schema stores a list of members/properties (of type
SPMember) for an object of a particular type. Each subclass of
SPMembercorresponds to a data type, and knows how to diff itself. In the future these will be parameterized for custom diffing, conflict resolution, validation, etc.
SPBucketprovides access to a synchronized bucket of objects of a particular type. The
SPDifferto perform diffs, an
SPStorageProviderfor locally reading and writing data, an
SPChangeProcessorfor processing incoming and outgoing changes, and an
SPIndexProcessorfor processing indexes retrieved from the server. The processors run in their own threads.
SPStorageProviderdefines an interface for local reading and writing of objects. In particular it defines a
threadSafeStoragemethod that returns a thread safe instance.
SPCoreDataProvideris currently the only fully functional storage provider.
SPAuthenticatorhandles all authentication with Simperium, and can be customized or overridden as necessary. There are companion classes for iOS and OSX that provide a code-driven UI for signing in and signing up (
SPNetworkProviderdefines an interface for remote reading and writing of objects in an
SPBucket. The network provider sends local data and receives remote data in the background, passing it through threaded processors as necessary. Although there is an HTTP provider, the WebSockets provider is intended to become the default (but is still under development).
User. Basic access to a user's data. In the future this will hold custom properties and presence information.
Helpers. Exporter, keychain, etc.
The Simperium iOS library is available for free and commercial use under the MIT license.