Diffusion Apple API

Introduction

The Diffusion Apple Unified client library enables interaction with a Diffusion server from iOS, tvOS and OS X / macOS applications.

The library has been developed against Apple's Foundation Framework (a.k.a. Cocoa), providing support for developers targetting both desktop and mobile-derived platforms. The API is the same for all platforms, there are no platform-specific interfaces.

For each platform, the library is supplied as a universal (multi-architecture) framework encapsulating API headers and dynamic library binary:

• iOS (iphoneos)
• OS X / macOS (macosx)
• tvOS (appletvos)

Getting Started

For basic instructions on how to get connected to a Diffusion server see Quickstart Guide.

---

Development Environment

We recommend using Xcode 15.1, against which this library was built. It includes:

• iOS 12.2 SDK
• macOS 10.14.4 SDK
• tvOS 12.2 SDK

A minimum of Xcode 15.1 is required.

---

Runtime Support

Diffusion Protocols:

URL Scheme	Protocol	Default TCP Port
ws	WebSocket	80
wss	Secure WebSocket	443

Minimum deployment targets:

Operating System	Version
iOS	12.0
OS X / macOS	10.13
tvOS	12.0

Processor Architectures:

Apple SDK	Included arch_type slices
OS X / macOS (macosx)	aarch64, x86_64
iOS (iphoneos)	arm64
iOS Simulator (iphonesimulator)	x86_64
tvOS (appletvos)	arm64
tvOS Simulator (appletvsimulator)	x86_64

---

Index

Core functionality

• Session management
• Publishing and Subscribing
• Messaging
• Ping
• Topic Datatypes

Advanced functionality

• Wrangling
• Topic Management

Client control functionality

• Session Management
• Server Configuration

---

Links

Additional Documentation

• Quickstart Guide
• Latest Diffusion Release Notes
• Diffusion User Manual

Support Links

• Download Diffusion Apple SDK
• DiffusionData Developer Hub
• DiffusionData Homepage