Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Rasalexman/KDispatcher
Simple and light-weight event dispatcher for Kotlin
https://github.com/Rasalexman/KDispatcher
android android-architecture android-library event-driven eventbus kotlin kotlin-android kotlin-library
Last synced: 3 months ago
JSON representation
Simple and light-weight event dispatcher for Kotlin
- Host: GitHub
- URL: https://github.com/Rasalexman/KDispatcher
- Owner: Rasalexman
- Created: 2017-03-23T17:44:19.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-05-08T08:33:29.000Z (about 3 years ago)
- Last Synced: 2024-01-17T02:27:14.308Z (5 months ago)
- Topics: android, android-architecture, android-library, event-driven, eventbus, kotlin, kotlin-android, kotlin-library
- Language: Kotlin
- Homepage:
- Size: 1.93 MB
- Stars: 66
- Watchers: 4
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Lists
- awesome-list - Rasalexman/KDispatcher - Simple and light-weight event dispatcher for Kotlin (Kotlin)
README
# KDispatcher is a Kotlin EventDispatcher
[](http://kotlinlang.org) [](https://jitpack.io/#Rasalexman/KDispatcher) [](https://app.codacy.com/app/Rasalexman/KDispatcher?utm_source=github.com&utm_medium=referral&utm_content=Rasalexman/KDispatcher&utm_campaign=Badge_Grade_Dashboard) [](https://github.com/KotlinBy/awesome-kotlin)
This is light-weight event dispatcher based on KOTLIN
* `priority: Int? = null` to subscribe function for sorting
* Inline function Included
You can subscribe on event by calling:
```kotlin
val EVENT_CALL_ONE = "simple_event_name"
val eventListener = ::eventHandler
val priority = 1
KDispatcher.subscribe(EVENT_CALL_ONE, eventListener, priority)
```
where:
* EVENT_CALL_ONE - simple event type
* eventListener - function listener for event
* priority - the priority to sort calling functions
```kotlin
/**
* notif:Notification - event holder object that store
* data:T? = null - can be any type of data
* eventName:String? = null - current event type
* cause u may have more then one EVENT_TYPE for current event listener
*/
fun eventHandler(notif:Notification){
when(notif.eventName){
EVENT_CALL_ONE -> println("FIRST EVENT")
}
}
```
Of course u can simpe call the event for all listeners by
```kotlin
val test:MyTestClass = MyTestClass()
KDispatcher.call(EVENT_CALL_ONE, test)
```
Don't forget to unsubscribe your listeners when u dont need it anymore.
```kotlin
KDispatcher.unsubscribe(EVENT_CALL_ONE, eventListener)
```
Sinse version 0.1.2 you can use extension and inline functions of KDispatcher. All you need to do is implement `IKDispatcher` interface. Also you can use single lambda functions like `(Notification) -> Unit` as event handlers
```kotlin
class MainActivity : AppCompatActivity(), IKDispatcher {
private val eventListenerOne = this::eventOneHandler
//...
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
scopeOperation()
}
private fun scopeOperation() {
// subscribe event to this handlers
subscribe(EVENT_CALL_ONE, eventListenerOne, 3)
subscribe(EVENT_CALL_ONE, ::eventListenerTwo, 1)
subscribe(EVENT_CALL_ONE, MyClass::eventListenerFour, 2)
// call event
call(EVENT_CALL_ONE, "FIRST CALL FROM KDISPATCHER")
/**
* But you can simple use inner lambda function to handler notification.
* So as u hasn't a reference to ISubscriber handler function, when you call
* `usubscribe(String)` you will delete all references ISubscriber-listener
*/
val eventName = "LAMBDA_EVENT"
subscribe(eventName) { notification ->
println("LAMBDA_EVENT HAS FIRED with event name ${notification.eventName} and data ${notification.data}")
unsubscribe(notification.eventName)
}
call(eventName, "FIRST CALL CUSTOM LABDA EVENT")
/**
* Since version 0.1.7 you can subscribe by scope of events by a single callback
*/
subscribeList(listOf("notif_one", "notif_two")) {
when(it.eventName) {
"notif_one" -> Toast.makeText(this, "This is notif_one", Toast.LENGTH_SHORT).show()
"notif_two" -> Toast.makeText(this, "This is notif_two", Toast.LENGTH_SHORT).show()
}
}
call("notif_one")
call("notif_two")
}
fun eventOneHandler(notification:Notification) {
println("eventOneHandler MY TEST IS COMING event = ${notification.eventName} AND data = ${notification.data}")
}
}
```
Gradle:
```kotlin
implementation 'com.rasalexman.kdispatcher:kdispatcher:x.y.z'
```
Maven:
```kotlin
com.rasalexman.kdispatcher
kdispatcher
x.y.z
pom
```
* ThreadSafe
* Simple
* Usefull
# License
----
MIT License
Copyright (c) 2021 Alexandr Minkin ([email protected])
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.