Distributed actors overview in Swift - Step-by-Step Execution

Concept Flow - Distributed actors overview

Define distributed actor

↓

Create instance locally or remotely

↓

Call method on distributed actor

↓

System routes call

↓

If local: execute directly

↓

If remote: send message over network

↓

Receive response

↓

Return result to caller

This flow shows how a distributed actor is defined, created, and how method calls are routed either locally or remotely, with results returned to the caller.

Execution Sample

Swift

distributed actor ChatRoom {
    distributed func sendMessage(_ msg: String) async -> Bool {
        print("Sending: \(msg)")
        return true
    }
}

let room = ChatRoom()
let success = await room.sendMessage("Hello")

Defines a distributed actor ChatRoom, creates an instance, and calls a method asynchronously.

Execution Table

Step	Action	Evaluation	Result
1	Define distributed actor ChatRoom	Distributed actor type created	ChatRoom type ready
2	Create instance room = ChatRoom()	Instance created locally	room is local ChatRoom actor
3	Call await room.sendMessage("Hello")	Check if room is local or remote	room is local
4	Execute sendMessage locally	Print message	Output: Sending: Hello
5	Return true from sendMessage	Result true	success = true
6	End of execution	All steps done	Program complete

💡 Execution stops after method call returns and result is assigned

Variable Tracker

Variable	Start	After Step 2	After Step 5	Final
room	undefined	local ChatRoom instance	local ChatRoom instance	local ChatRoom instance
success	undefined	undefined	true	true

Key Moments - 3 Insights

Why does the method call use 'await'?

Because distributed actor methods are asynchronous, the call may involve waiting for a remote response. See execution_table step 3 and 4 where the call is awaited.

How does the system know if the actor is local or remote?

The system tracks actor location internally. In step 3, it checks if 'room' is local or remote to decide how to execute the method.

What happens if the actor was remote?

The system would send a network message instead of direct execution. This is shown in the concept_flow where calls route differently for remote actors.

Visual Quiz - 3 Questions

Look at the execution_table, what is the value of 'success' after step 5?

A false

B undefined

C true

D nil

💡 Hint

Check the 'Result' column in row for step 5 in execution_table

At which step does the system decide if the actor is local or remote?

A Step 3

B Step 2

C Step 4

D Step 5

💡 Hint

Look at the 'Action' and 'Evaluation' columns in execution_table step 3

If the actor was remote, what would change in the execution flow?

A The method would execute locally without network

B The system would send a network message instead of direct call

C The actor instance would be undefined

D The method would not return any result

💡 Hint

Refer to concept_flow where remote calls send messages over network

Concept Snapshot

distributed actor TypeName {
    distributed func someMethod() async {}
}

- Distributed actors can run locally or remotely.
- Calls to distributed actors are async and use 'await'.
- System routes calls: local executes directly, remote sends network message.
- Results return asynchronously to caller.

Full Transcript

This visual execution trace shows how distributed actors work in Swift. First, a distributed actor type is defined. Then an instance is created locally. When calling a method on the actor, the system checks if the actor is local or remote. If local, the method runs directly. If remote, the call is sent over the network. The method returns asynchronously, so calls use 'await'. Variables like the actor instance and result track their values step-by-step. Key moments clarify why 'await' is needed and how location affects execution. Quiz questions test understanding of variable values and flow decisions.

Practice

1. What is the main purpose of a distributed actor in Swift?

easy

A. To define a class that cannot be used with concurrency

B. To create a local-only actor with no network communication

C. To allow an actor to work across multiple computers easily

D. To replace all functions with synchronous calls

Solution

1. Step 1: Understand the role of distributed actors

   Distributed actors are designed to work across different machines, enabling remote communication.

2. Step 2: Compare options with the concept

   Only To allow an actor to work across multiple computers easily correctly describes this purpose; others describe unrelated or incorrect features.

3. Final Answer:

   To allow an actor to work across multiple computers easily -> Option C

4. Quick Check:

   Distributed actor purpose = cross-computer use [OK]

Hint: Distributed actors enable remote work across computers [OK]

Common Mistakes:

• Thinking distributed actors are local-only
• Confusing distributed actors with regular classes
• Assuming distributed actors disable concurrency

2. Which of the following is the correct way to declare a distributed function inside a distributed actor?

easy

A. func fetchData() async throws -> String

B. func distributed fetchData() async throws -> String

C. distributed func fetchData() -> String

D. distributed func fetchData() async throws -> String

Solution

1. Step 1: Recall distributed function syntax

   Distributed functions inside distributed actors use the keyword distributed func and are usually async and throwable.

2. Step 2: Check each option

   distributed func fetchData() async throws -> String matches the correct syntax exactly. func fetchData() async throws -> String misses the distributed keyword. distributed func fetchData() -> String misses async and throws. func distributed fetchData() async throws -> String has incorrect keyword order.

3. Final Answer:

   distributed func fetchData() async throws -> String -> Option D

4. Quick Check:

   Distributed function syntax = distributed func [OK]

Hint: Use 'distributed func' keyword for remote calls [OK]

Common Mistakes:

• Omitting 'distributed' keyword
• Placing 'distributed' after 'func'
• Forgetting async or throws in distributed funcs

3. Given the code below, what will be printed when calling await greeter.sayHello()?

distributed actor Greeter {
    distributed func sayHello() async -> String {
        return "Hello from distributed actor!"
    }
}

let greeter = Greeter()
Task {
    let message = await greeter.sayHello()
    print(message)
}

medium

A. Error: distributed actor cannot be instantiated directly

B. Hello from distributed actor!

C. Hello from local actor!

D. Runtime error due to missing network connection

Solution

1. Step 1: Understand distributed actor instantiation

   Distributed actors can be instantiated locally for testing or local use, so Greeter() is valid here.

2. Step 2: Analyze the distributed function call

   The sayHello() function returns the string "Hello from distributed actor!" asynchronously, so the print will output this string.

3. Final Answer:

   Hello from distributed actor! -> Option B

4. Quick Check:

   Distributed func returns greeting string [OK]

Hint: Distributed actors can be called locally for testing [OK]

Common Mistakes:

• Assuming distributed actors cannot be instantiated locally
• Expecting network errors without remote setup
• Confusing distributed actor with local-only actor

4. Identify the error in the following distributed actor code:

distributed actor Counter {
    var count = 0

    distributed func increment() {
        count += 1
    }
}

medium

A. Distributed functions must be async and throwable

B. Distributed actors cannot have mutable state

C. The distributed func must return a value

D. The count variable must be declared as distributed

Solution

1. Step 1: Check distributed function requirements

   Distributed functions must be declared as async and can throw errors because they involve remote calls.

2. Step 2: Analyze the given function

   The increment() function is missing async and throws keywords, which is a syntax error for distributed functions.

3. Final Answer:

   Distributed functions must be async and throwable -> Option A

4. Quick Check:

   Distributed func requires async and throws [OK]

Hint: Always add async and throws to distributed funcs [OK]

Common Mistakes:

• Forgetting async keyword in distributed funcs
• Assuming distributed funcs can be synchronous
• Thinking distributed actors disallow mutable vars

5. You want to build a distributed chat app using Swift's distributed actors. Which approach correctly uses distributed actors and functions to send a message to a remote user?

hard

A. Define a distributed actor ChatUser with a distributed func sendMessage(_ message: String) that can be called remotely.

B. Use a regular class with async functions and manually handle network communication.

C. Define a distributed actor but use non-distributed functions for sending messages.

D. Use global functions with no actors to send messages asynchronously.

Solution

1. Step 1: Understand distributed actors for remote communication

   Distributed actors are designed to simplify remote calls, so defining a ChatUser as a distributed actor with distributed functions fits the use case.

2. Step 2: Evaluate options for remote message sending

   Define a distributed actor ChatUser with a distributed func sendMessage(_ message: String) that can be called remotely. correctly uses distributed actors and distributed functions for remote calls. Options B, C, and D either ignore distributed actors or misuse function types, making remote communication harder or incorrect.

3. Final Answer:

   Define a distributed actor ChatUser with a distributed func sendMessage(_ message: String) that can be called remotely. -> Option A

4. Quick Check:

   Distributed actors + distributed funcs = remote calls [OK]

Hint: Use distributed actors with distributed funcs for remote calls [OK]

Common Mistakes:

• Using regular classes instead of distributed actors
• Calling non-distributed functions remotely
• Ignoring actor isolation and concurrency