Push vs Pull Signal

Contents

1. 1. Monad
2. 2. Sync vs Async
3. 3. Push Signal
   1. 3.1. Implementation
   2. 3.2. Usage
   3. 3.3. Callbacks
4. 4. Pull Signal
   1. 4.1. Implementation
   2. 4.2. Usage
   3. 4.3. Callbacks

The idea of Signal may originate from Elm Reactivity, and it has now been widely adopted in iOS

I once asked What are examples of hot and cold signal in ReactiveCocoa?

• When to use IEnumerable vs IObservable?
• ReactiveCocoa Framework Overview
• Rx – for beginners (part 9): Hot Vs. Cold observable
• RxSwift Hot and Cold Observables

Whether it is hot vs cold, Signal vs Signal Producer, Observable vs Enumerable, … it’s good to understand how it gets implemented, so that to have a good sense of how they work

Monad

• Understanding Monad

Basically, Signal and its Result are just monads, which are thing that can be mapped and chained.

Signal makes use of deferred execution callback blocks, and push vs pull is just how the Signal updates its value and the order the callbacks are called

Execution callback block is that we pass a function to another function, and it will get called when appropriated

Sync vs Async

Monad can be in either sync or async mode. Sync is easier to understand, but async is somewhat you’re already familiar and used in practice

Basically,

• Sync: you get the returned value right away via return
• Aync: you get the returned value via callback block

Here is an example of a simple function

// Sync
func sum(a: Int, b: Int) -> Int {
    return a + b
}

// Async
func sum(a: Int, b: Int, completion: Int -> Void) {
    // Assumed it is a very long task to get the result
    let result = a + b

    completion(result)
}

Here is an example of Event

// Sync
public func map(@noescape f: T -> U) -> Event {
    switch self {
    case let .Next(value):
        return .Next(value: f(value))
    case let .Failed(error):
        return .Failed(error: error)
    }
}

// Async
public func map(f: (T, U -> Void) -> Void) -> ((Event -> Void) -> Void) {
        return { g in   // g: Event -> Void
            switch self {
            case let .Next(value):
                f(value) { transformedValue in  // transformedValue: U
                    g(.Next(value: transformedValue))
                }
            case let .Failed(error):
                g(.Failed(error: error))
            }
        }
    }

Push Signal

• Signal.swift

Take a look at my Push Signal, called Signal, it is like how Promise A+ Then works

Implementation

public final class Signal {
    var event: Event?
    var callbacks: [Event -> Void] = []

    func notify() {
        guard let event = event else {
            return
        }

        callbacks.forEach { callback in
            callback(event)
        }
    }

    func update(event event: Event) {
        dispatch_sync(lockQueue) {
            self.event = event
        }

        notify()
    }

    public func subscribe(f: Event -> Void) -> Signal {
        // Callback
        if let event = event {
            f(event)
        }

        callbacks.append(f)

        return self
    }

    public func map(f: T -> U) -> Signal {
        let signal = Signal()

        subscribe { event in
            signal.update(event: event.map(f))
        }

        return signal
    }
}

Usage

let signal = Signal()

signal.map { value in
        return value.characters.count
    }.subscribe { event in
        if case let .Next(value) = event {
            XCTAssert(value == 4)
        } else {
            XCTAssert(false)
        }
}

signal.sendNext("test")

Callbacks

Given a chained signals like this

A -(map)-> B -(flatMap)-> C -(flatMap)-> D -(subscribe)

• The idea is we send event to the source signal, and it propagates events through via callbacks.
• Triggered by sending event to the source signal.
• We must keep A as it keeps the others around
• We subscribe the last D
• We send event to the first A
• A ‘s callback gets called, it it in turn calls callback of B with the result of A ‘s map, then B ‘s callback calls C ‘s callback with the result of B
  ‘s flatMap, …

Pull Signal

• Future.swift

Take a look at my Pull Signal, called Future

Implementation

Here operation is a task, when called and completed, will notify its completion

public struct Future {
    let operation: (Event -> Void) -> Void

    public init(operation: (Event -> Void) -> Void) {
        self.operation = operation
    }

    public func start(completion: Event -> Void) {
        operation() { event in
            completion(event)
        }
    }

    public func map(f: T -> U) -> Future {
        return Future { completion in
            self.start { event in
                completion(event.map(f))
            }
        }
    }
}

Usage

let _ = Future { completion in
        // There is some work here
        completion(Event(value: "test"))
    }
    .map { value in
        value.characters.count
    }.start { event in
        if case let .Next(value) = event {
            XCTAssert(value == 4)
        } else {
            XCTAssert(false)
        }
    }

Callbacks

Given a chained signals like this

A -(map)-> B -(flatMap)-> C -(flatMap)-> D -(subscribe)

• The idea is we subscribe to the final signal D, and it cause the previous signals to action.
• Triggered by subscribing to the final signal.
• We must keep D as it keeps the others around
• We subscribe the last D
• D ‘s operation actions, and it cause C ‘s operation to action, … then A ‘s operation actions. It is in A that the task is performed (like fetching network, retrieving database, file access, heavy computation, …) to get the result, and A ‘s completion gets called. Then A’s completion calls B ‘s completion with the result mapped by B ‘s map, … all the way to the subscriber ‘s completion block