Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mcmatan/topicEventBus
Publish–subscribe design pattern implementation framework, with an ability to publish events by topic.
https://github.com/mcmatan/topicEventBus
Last synced: about 1 month ago
JSON representation
Publish–subscribe design pattern implementation framework, with an ability to publish events by topic.
- Host: GitHub
- URL: https://github.com/mcmatan/topicEventBus
- Owner: mcmatan
- License: mit
- Created: 2018-08-03T11:23:51.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-03-20T12:21:01.000Z (over 5 years ago)
- Last Synced: 2024-08-04T21:30:30.731Z (about 1 month ago)
- Language: Swift
- Homepage:
- Size: 184 KB
- Stars: 55
- Watchers: 3
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - TopicEventBus - Publish–subscribe design pattern implementation framework, with ability to publish events by topic. (NotificationCenter extended alternative). (EventBus / Getting Started)
- awesome-swift - TopicEventBus - Publish–subscribe design pattern implementation framework, with ability to publish events by topic. (Libs / Events)
- awesome-swift - TopicEventBus - Publish–subscribe design pattern implementation framework, with ability to publish events by topic. (Libs / Events)
- awesome-ios-star - TopicEventBus - Publish–subscribe design pattern implementation framework, with ability to publish events by topic. (NotificationCenter extended alternative). (EventBus / Getting Started)
- fucking-awesome-swift - TopicEventBus - Publish–subscribe design pattern implementation framework, with ability to publish events by topic. (Libs / Events)
- awesome-swift - TopicEventBus - Publish–subscribe design pattern implementation framework, with an ability to publish events by topic. ` 📝 3 years ago ` (Events [🔝](#readme))
README
# TopicEventBus
Publish–subscribe design pattern implementation framework, with ability to publish events by topic.
(NotificationCenter extended alternative)
On Medium: https://medium.com/@matancohen_22770/why-you-should-stop-using-notificationcenter-and-start-using-topiceventbus-c4c7ab312643
[](https://developer.apple.com/swift)
## About:
TopicEventBus is Easy to use, type safe way of implementing Publish–subscribe design pattern.
There are many other libraries out there, aiming to solve this issue, but none of them support publishing events by topic, in a type-safe way, with no magic strings.
Also, TopicEventBus holds weak referenced for Its observers, so you don't have to be afraid of memory leaks.
## What is a topic?
The topic is for example, when you would like to publish "ConversationUpdateEvent" yet have the ability to publish that event only to listeners with conversation id "1234" or to all listeners.
Specifying the conversation Id is specifying a topic for that event.
## Show me the code! and what's in it for me.
Let's build a chat app!
In this app, we are going to have multiple conversations screens, each one of them would like to know only about changes to Its conversation.
The first step, create an event for conversation update:
```Swift
class ConversationChangedEvent: TopicEvent {
let newTitle: String
init(conversationId: String, newTitle: String) {
self.newTitle = newTitle
super.init()
self.key = conversationId
}
}
```
Every event must inherit from "TopicEvent," and in case it has a topic (Our example it will be the conversation id) set "key" property to the correct value.
Now inside ConversationVC, subscribe to this event:
*Notice you only need to specify the return value you are expecting, for TopicEventBus to figure out the event you are subscribing for*
```Swift
class ConversationVC: UIViewController {
let topicEventBus: TopicEventBus
let conversationId = "1234"
init(topicEventBus: TopicEventBus) {
self.topicEventBus = topicEventBus
}
override func viewDidLoad() {
super.viewDidLoad()
_ = self.topicEventBus.subscribe(topic: conversationId, callback: { (conversationChangedEvent: ConversationChangedEvent) in
// This will run every time "ConversationChangedEvent" with id 1234 will be fired.
})
}
}
```
This is how you fire an event:
```Swift
class FiringService {
let topicEventBus: TopicEventBus
init(topicEventBus: TopicEventBus) {
self.topicEventBus = topicEventBus
}
func conversationTitleChanged() {
self.topicEventBus.fire(event: ConversationChangedEvent.init(conversationId: "1234",
newTitle: "First update"))
}
}
```
You did it! You fired your first event with topic 🤗 🎉
## API
If you subscribe to event and specify no topic, you will receive all events from that type, no matter their key:
```Swift
_ = self.topicEventBus.subscribe { (conversationChangedEvent: ConversationChangedEvent) in
// All events from this type: ConversationChangedEvent will trigger this block
}
```
Unsubscribe by calling "stop" on the returned object after subscribing:
```Swift
let listener = self.topicEventBus.subscribe(topic: conversationId, callback: { (conversationChangedEvent: ConversationChangedEvent) in
//
})
listener.stop()
```
On app log out, terminate TopicEventBus by just calling:
```Swift
self.topicEventBus.terminate()
```
## Example project
Please notice example project contains tests to support all edge cases, plus example code from the above snippets.
## Installation
#### Cocoapods
**TopicEventBus** is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your Podfile:
```ruby
pod 'TopicEventBus'
```
#### Manually
1. Download and drop ```/TopicEventBus``` folder in your project.
2. Congratulations!
## Author
[Matan](https://github.com/mcmatan) made this with ❤️.