Creating a collaborative session
At a glance
| Item | Summary |
|---|---|
| Purpose | Enable nearby devices to share an AR experience by using a peer-to-peer multiuser strategy. |
| App architecture | A Swift sample with the source-visible chain AppDelegate → ViewController → MultipeerSession → ARKit APIs. |
| Main patterns | View-controller organization, Delegate or data-source callbacks |
| Project style | 6 scanned source file(s) across Swift, organized around ranked entry, type, and file boundaries. |
| Execution model | Source-visible boundaries: DispatchQueue.main.async; none alone proves a background thread. |
| State/event model | No structured observation or publisher-scheduling marker indexed. |
| Key frameworks/packages | ARKit, UIKit, MultipeerConnectivity, RealityKit, Foundation; these are source dependencies, not architecture labels. |
Project structure
Source bundle/
├── CollaborativeSession/
│ ├── AppDelegate.swift
│ ├── MultipeerSession.swift
│ ├── ViewController.swift
│ ├── MessageLabel.swift
│ ├── Utilities.swift
│ ├── ViewController+CoachingOverlay.swift
│ ├── Base.lproj/
│ │ ├── LaunchScreen.storyboard
│ │ └── Main.storyboard
│ └── Info.plist
├── CollaborativeSession.xcodeproj/
│ ├── .xcodesamplecode.plist
│ └── project.pbxproj
└── Configuration/
└── SampleCode.xcconfig
Structure observations
- Architecturally prominent files are ranked from entry points and role-named declarations; resource-only paths are omitted.
- Primary languages: Swift.
- The verified tree contains 6 project/configuration file(s) and 4 source declaration(s).
Overall architecture
flowchart LR
N1["AppDelegate"]
N2["ViewController"]
N3["MultipeerSession"]
N4["ARKit APIs"]
N1 --> N2
N2 --> N3
N3 --> N4
Reference code
CollaborativeSession/AppDelegate.swift:11 — architecture anchor
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
var window: UIWindow?
func application(_ application: UIApplication,
didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil) -> Bool {
guard ARWorldTrackingConfiguration.isSupported else {
fatalError("""
ARKit is not available on this device. For apps that require ARKit
for core functionality, use the `arkit` key in the key in the
`UIRequiredDeviceCapabilities` section of the Info.plist to prevent
the app from installing. (If the app can't be installed, this error
can't be triggered in a production scenario.)
In apps where AR is an additive feature, use `isSupported` to
determine whether to show UI for launching AR experiences.
""") // For details, see https://developer.apple.com/documentation/arkit
}
return true
}
}Interpretation
The arrows summarize the source-visible entry, role-named types or folders, and framework direction; when nodes come from structural folders, the sequence is a high-level interpretation rather than proof that every adjacent node calls the next. Ownership is claimed only where the next section cites a stored property or assignment. The diagram is intentionally limited to the dominant path into ARKit.
Ownership and state
classDiagram
AppDelegate o-- UIWindow : window
MultipeerSession *-- MCPeerID : myPeerID
MultipeerSession o-- MCSession : session
MultipeerSession o-- MCNearbyServiceAdvertiser : serviceAdvertiser
Ownership evidence
CollaborativeSession/AppDelegate.swift:14 — stored dependency or nearest verified ownership anchor
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
// ...
var window: UIWindow?
// ...
}| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
AppDelegate |
UIWindow (window) |
stores or receives | App/module collaborators |
MultipeerSession |
MCPeerID (myPeerID) |
creates and retains | Initialized by the owner; the binding is immutable |
MultipeerSession |
MCSession (session) |
stores or receives | Owning lexical scope |
MultipeerSession |
MCNearbyServiceAdvertiser (serviceAdvertiser) |
stores or receives | Owning lexical scope |
Composition arrows indicate a source-visible construction expression or locally owned value state; aggregation means the owner stores or receives a dependency without proving exclusive lifetime ownership.
Concurrency, scheduling, and thread safety
Evidence limit: actor isolation, async/await, or Task creation does not by itself prove background-thread execution; Sendable conformance alone does not prove thread-safe mutation.
| Concern | Source mechanism | Verified placement or handoff | Evidence |
|---|---|---|---|
| Queue scheduling | DispatchQueue.main.async |
The source addresses the main dispatch queue. | CollaborativeSession/MessageLabel.swift:23 |
@MainActor/MainActor.run, DispatchQueue.main, and RunLoop.main are reported as distinct isolation, queue, and event-loop mechanisms. A plain Task is kept separate from Task.detached; neither is labeled as a background thread.
Reference code
CollaborativeSession/MessageLabel.swift:23 — representative execution boundary
DispatchQueue.main.async {
self.isHidden = true
self.text = ""
}State propagation, frameworks, and dependencies
Evidence limit: an import proves a source-level compilation dependency at the cited line; it does not prove runtime use, architectural adoption, or whether a Swift package is a direct application dependency.
| Category | Mechanism or module | Verified role | Evidence |
|---|---|---|---|
| Source import | ARKit |
The cited file imports this module; runtime use and architectural role are not inferred. | CollaborativeSession/AppDelegate.swift:9 |
| Source import | UIKit |
The cited file imports this module; runtime use and architectural role are not inferred. | CollaborativeSession/AppDelegate.swift:8 |
| Source import | MultipeerConnectivity |
The cited file imports this module; runtime use and architectural role are not inferred. | CollaborativeSession/MultipeerSession.swift:8 |
| Source import | RealityKit |
The cited file imports this module; runtime use and architectural role are not inferred. | CollaborativeSession/Utilities.swift:9 |
| Source import | Foundation |
The cited file imports this module; runtime use and architectural role are not inferred. | CollaborativeSession/Utilities.swift:8 |
receive(on:) describes downstream delivery scheduling, while subscribe(on:) describes upstream subscription/request/cancel scheduling. An import Combine alone establishes neither behavior nor a Store, reducer, Redux, or other application architecture.
Class and protocol design
CollaborativeSession/AppDelegate.swift:12 — representative type boundary
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
// ...
var window: UIWindow?
// ...
}| Type | Responsibility | Depends on or conforms to |
|---|---|---|
AppDelegate |
Receives callback-driven events | UIResponder, UIApplicationDelegate |
MultipeerSession |
Owns a session-scoped interaction | NSObject |
ViewController |
View lifecycle, callbacks, and feature coordination | UIViewController, ARSessionDelegate |
MessageLabel |
Owns feature behavior and collaborator lifecycle | UILabel |
No local protocol conformance is claimed as protocol-oriented design; external framework conformances are listed only as dependencies.
Access control
| Symbol | Access | Verified effect | Likely rationale |
|---|---|---|---|
myPeerID (CollaborativeSession/MultipeerSession.swift:13) |
private |
Use is restricted to the lexical declaration and same-file extensions allowed by Swift. | Inference: keep state mutation or dependency lifetime inside the owning implementation. |
session (CollaborativeSession/MultipeerSession.swift:14) |
private |
Use is restricted to the lexical declaration and same-file extensions allowed by Swift. | Inference: keep state mutation or dependency lifetime inside the owning implementation. |
serviceAdvertiser (CollaborativeSession/MultipeerSession.swift:15) |
private |
Use is restricted to the lexical declaration and same-file extensions allowed by Swift. | Inference: keep state mutation or dependency lifetime inside the owning implementation. |
serviceBrowser (CollaborativeSession/MultipeerSession.swift:16) |
private |
Use is restricted to the lexical declaration and same-file extensions allowed by Swift. | Inference: keep state mutation or dependency lifetime inside the owning implementation. |
Reference code
CollaborativeSession/MultipeerSession.swift:13 — representative boundary
class MultipeerSession: NSObject {
// ...
private let myPeerID = MCPeerID(displayName: UIDevice.current.name)
// ...
}Swift declarations without a modifier are internal; explicit private, fileprivate, private(set), public, or open entries above are interpreted by language semantics. Objective-C/C samples instead rely on header and implementation boundaries, which are not equivalent to Swift lexical privacy.
Logic ownership and placement
| Logic | Owning type or file | Placement rationale |
|---|---|---|
| View lifecycle, callbacks, and feature coordination | ViewController |
The source’s Controller suffix makes this role explicit. |
| Receives callback-driven events | AppDelegate |
The source’s Delegate suffix makes this role explicit. |
| Owns a session-scoped interaction | MultipeerSession |
The source’s Session suffix makes this role explicit. |
Design patterns
| Pattern | Source evidence | Purpose or tradeoff |
|---|---|---|
| View-controller organization | CollaborativeSession/ViewController.swift:13 |
A controller is the verified coordination boundary; this is MVC-style only where a separate model is present. |
| Delegate or data-source callbacks | CollaborativeSession/AppDelegate.swift:12 |
Callback protocols invert event delivery back into the sample’s owner. |
Naming conventions
- Types: Controller: ViewController; Delegate: AppDelegate; Session: MultipeerSession.
- Protocols: no local protocol declaration in the scanned source.
- Methods:
application,sendToAllPeers,sendToPeers,session,browser,advertiser,viewDidAppear,handleTap. - Files:
CollaborativeSession/AppDelegate.swift,CollaborativeSession/MultipeerSession.swift,CollaborativeSession/ViewController.swift,CollaborativeSession/MessageLabel.swift.
Architecture takeaways
AppDelegateis the main source-visible entry or composition anchor for this sample.- Framework work reaches ARKit, UIKit, MultipeerConnectivity, RealityKit through a deliberately small high-level chain; the detailed API graph remains inside the cited implementation files.
- Stored-property evidence identifies lifecycle collaboration; it does not by itself prove exclusive object ownership.
- Access-control conclusions separate verified language visibility from the likely design rationale.
- The source does not justify labeling the design protocol-oriented.
Source map
| Source file | Relevant symbols |
|---|---|
CollaborativeSession/AppDelegate.swift |
Cited implementation, AppDelegate, ARKit, UIKit |
CollaborativeSession/MultipeerSession.swift |
Cited implementation, MultipeerConnectivity, MultipeerSession |
CollaborativeSession/ViewController.swift |
ViewController |
CollaborativeSession/MessageLabel.swift |
DispatchQueue.main.async, MessageLabel |
CollaborativeSession/Utilities.swift |
RealityKit, Foundation, Feature implementation |
CollaborativeSession/ViewController+CoachingOverlay.swift |
Feature implementation |