EventHub

1.0.0

Simple typesafe EventHub in Swift using callbacks/listeners defined by generic types.
imbue11235/EventHub

What's New

Official release

2018-06-06T20:46:35Z

PodSpec trunk installation + privacy level adjustments

Swift EventHub

Simple implementation of an EventHub in Swift. Supports callbacks and listeners.

Examples

Callback

struct CounterEvent: Event {
    let currentCount: Int
}

let eventHub = EventHub(queue: .global())
eventHub.subscribe { (event: CounterEvent)
    print(event.currentCount) // => 5
}

eventHub.trigger(CounterEvent(currentCount: 5))

Listener

struct SomeErrorEvent: Event {
    let message: String
    let code: Int 
}

class NotifyAdminListener: Listener<SomeErrorEvent> {
    override func handle(event: SomeErrorEvent) {
        print("Oh no! We got error \(error.code) with the message '\(error.message)'")
    }
}

let eventHub = EventHub(queue: .global())
eventHub.subscribe(NotifyAdminListener())
eventHub.trigger(SomeErrorEvent(message: "Fatal and dangerous error", code: 500))

Usage

  1. Initialize the EventHub class on a DispatchQueue. Add the EventHub to a global scope (e.g. shared instance), for cross-events/listeners, or use it in an internal scope
let hub = EventHub(queue: .global())
  1. Define events by making them comply to the Event protocol
struct MyEvent: Event {}
  1. Subscribe to the events either by callback or listener (see examples above)
hub.subscribe { (event: MyEvent) in 
    // Do something with the event
}
  1. Trigger events by calling the method .trigger(event: Event)
hub.trigger(MyEvent())
  1. The events triggered are distributed to all listeners attached to the hub, listening for that specific event.

  2. To unsubscribe, the returned UUID from the .subscribe method, can be used

let subscription = hub.subscribe { // ... }
hub.unsubscribe(subscription)

Requirements

Swift 4.1

Installation

With CocoaPods:

pod 'SwiftEventHub'

Description

  • Swift Tools 4.0.0
View More Packages from this Author

Dependencies

  • None
Last updated: Tue Aug 30 2022 03:49:09 GMT-0500 (GMT-05:00)