A powerful in-process event dispatcher based on Kotlin and Coroutines.

Last update: Oct 3, 2022

Related tags

Kotlin android kotlin swing functional-programming javafx coroutines eventbus event-driven event-dispatcher

Overview

KEvent

A powerful in-process event dispatcher based on Kotlin and Coroutines.

Feature List

Implement publish–subscribe pattern
Tiny (52.8kb jar) and super-fast (no reflection)
Usable in plenty scenarios: plain kotlin, server side, android, javafx, swing
Use Enum as event type, so you don't have to create numerous event classes

Support 3 event dispatch modes with 3 subscriber thread modes

DispatchMode\ThreadMode	POSTING	BACKGROUND	UI
POSTING	√	×	×
SEQUENTIAL	×	√	√
CONCURRENT	×	√	×

Support a bunch of advanced features:
- event blocking
- event dispatch cancellation
- sticky events
- subscriber management
- subscriber priority
- subscriber tag
- subscribe multiple event types with same subscriber
- multiple ways to subscribe and unsubscribe
- provide a helpful subscriber interface
Thread safe
Fully tested

Download

Gradle Kotlin DSL

implementation("org.rationalityfrontline:kevent:2.1.0")

Maven

<dependency>
    <groupId>org.rationalityfrontline</groupId>
    <artifactId>kevent</artifactId>
    <version>2.1.0</version>
</dependency>

Usage

enum class EventTypes {
    UNIT_EVENT,
    STRING_EVENT,
}

private class ExampleSubscriber : KEventSubscriber {
    fun registerSubscribers() {
        subscribe<Unit>(EventTypes.UNIT_EVENT) { event ->
            println("${"ExampleSubscriber.lambda".padEnd(35)}: $event")
        }
        subscribe(EventTypes.STRING_EVENT, ::onStringEvent)
        subscribeMultiple(
            listOf(
                EventTypes.UNIT_EVENT,
                EventTypes.STRING_EVENT,
            ), ::onAnyEvent
        )
    }

    fun unregisterSubscribers() {
        unsubscribeAll()
    }

    private fun onStringEvent(event: Event<String>) {
        println("${"ExampleSubscriber.onStringEvent".padEnd(35)}: $event")
    }

    private fun onAnyEvent(event: Event<Any>) {
        try {
            when (event.type) {
                EventTypes.UNIT_EVENT -> event.data as Unit
                EventTypes.STRING_EVENT -> event.data as String
            }
        } catch (e: ClassCastException) {
            println("Different event data types might come with same event type: ${e.message}")
        }
        println("${"ExampleSubscriber.onAnyEvent".padEnd(35)}: $event")
    }
}

private fun topLevelOnStringEvent(event: Event<String>) {
    println("${"topLevelOnStringEvent".padEnd(35)}: $event")
}

fun main() {
    KEVENT.subscribe<Unit>(EventTypes.UNIT_EVENT, tag = "main") { event ->
        println("${"main.lambda".padEnd(35)}: $event")
    }
    KEVENT.subscribe(EventTypes.STRING_EVENT, ::topLevelOnStringEvent)

    val subscriber = ExampleSubscriber()
    subscriber.registerSubscribers()

    KEVENT.post(EventTypes.UNIT_EVENT, Unit)
    KEVENT.post(EventTypes.STRING_EVENT, "KEvent is awesome!")
    KEVENT.post(EventTypes.STRING_EVENT, 42)

    subscriber.unregisterSubscribers()

    KEVENT.removeSubscribersByTag("main")
    KEVENT.unsubscribe(EventTypes.STRING_EVENT, ::topLevelOnStringEvent)
}

Running the code above will produce the following outputs:

main.lambda                        : Event(type=UNIT_EVENT, data=kotlin.Unit, dispatchMode=POSTING, isSticky=false)
ExampleSubscriber.lambda           : Event(type=UNIT_EVENT, data=kotlin.Unit, dispatchMode=POSTING, isSticky=false)
ExampleSubscriber.onAnyEvent       : Event(type=UNIT_EVENT, data=kotlin.Unit, dispatchMode=POSTING, isSticky=false)
topLevelOnStringEvent              : Event(type=STRING_EVENT, data=KEvent is awesome!, dispatchMode=POSTING, isSticky=false)
ExampleSubscriber.onStringEvent    : Event(type=STRING_EVENT, data=KEvent is awesome!, dispatchMode=POSTING, isSticky=false)
ExampleSubscriber.onAnyEvent       : Event(type=STRING_EVENT, data=KEvent is awesome!, dispatchMode=POSTING, isSticky=false)
topLevelOnStringEvent              : Event(type=STRING_EVENT, data=42, dispatchMode=POSTING, isSticky=false)
ExampleSubscriber.onStringEvent    : Event(type=STRING_EVENT, data=42, dispatchMode=POSTING, isSticky=false)
Different event data types might come with same event type: class java.lang.Integer cannot be cast to class java.lang.String (java.lang.Integer and java.lang.String are in module java.base of loader 'bootstrap')
ExampleSubscriber.onAnyEvent       : Event(type=STRING_EVENT, data=42, dispatchMode=POSTING, isSticky=false)

For advanced features, please refer to the corresponding test specifications:

Performance

There is a sample benchmark code in the repository, you can clone this repository and run the benchmark on your own machine. Here is the benchmark results on my machine:

Conditions\AvgCallTime(ms)\ThreadMode	POSTING	SEQUENTIAL	CONCURRENT
event-1; subs-10000; tc-false; st-false	4.6920002E-5	0.00142243	8.7184E-4
event-1; subs-10000; tc-true; st-false	10.446612	10.578969	1.3352561
event-10000; subs-1; tc-false; st-false	0.00128533	0.00481413	0.0026817601
event-10000; subs-1; tc-true; st-false	10.942825	1.3770571	1.3426003
event-1000; subs-10000; tc-false; st-false	2.238846E-5	3.071547E-4	6.2108616E-4
event-1; subs-10000; tc-false; st-true			6.9659E-4
event-1; subs-10000; tc-true; st-true			1.3062543
event-10000; subs-1; tc-false; st-true			0.0034271
event-10000; subs-1; tc-true; st-true			1.3126742
event-1000; subs-10000; tc-false; st-true			6.246506E-4

event = event num
subs = subscriber num
tc = if subscribers are time-consuming (sleep 10ms in the above benchmark)
st = if the event is sticky (and subscribers are added after the event was posted)

[Machine Info]
CPU: Intel(R) Core(TM) i7-4710MQ @ 2.50GHz (4C8T)
Memory: 8 + 8 = 16GB, DDR3, 1600MHz
OS: Window 10 Enterprise 64 bit version 1909
JDK: OpenJDK 17+35-2724 64 bit

License

KEvent is released under the Apache 2.0 license.

Copyright 2020-2021 RationalityFrontline

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

🎲 A powerful and simple-to-use guilded wrapper made in Kotlin.

🎲 deck [WIP] Deck is a powerful yet simple-to-use guilded wrapper made entirely in Kotlin with support to multiplatform. Implementating In case you'r

13 Jul 30, 2022

A tiny Kotlin multiplatform library that assists in saving and restoring objects to and from disk using kotlinx.coroutines, kotlinx.serialisation and okio

Store A tiny Kotlin multiplatform library that assists in saving and restoring objects to and from disk using kotlinx.coroutines, kotlinx.serialisatio

98 Jan 3, 2023

Opinionated Redux-like implementation backed by Kotlin Coroutines and Kotlin Multiplatform Mobile

CoRed CoRed is Redux-like implementation that maintains the benefits of Redux's core idea without the boilerplate. No more action types, action creato

28 Dec 10, 2022

A lightweight, simple, smart and powerful Android routing library.

RxRouter Read this in other languages: 中文, English A lightweight, simple, smart and powerful Android routing library. Getting started Setting up the d

323 Nov 10, 2022

Runtime Mobile Security (RMS) 📱🔥 - is a powerful web interface that helps you to manipulate Android and iOS Apps at Runtime

Runtime Mobile Security (RMS) 📱 🔥 by @mobilesecurity_ Runtime Mobile Security (RMS), powered by FRIDA, is a powerful web interface that helps you to

2k Dec 20, 2022

Releases(v2.2.0)

v2.2.0(Nov 23, 2022)

Update infrastructure: kotlin 1.6.20 -> 1.7.21 dokka 1.6.20 -> 1.7.20 org.javamodularity.moduleplugin 1.8.11 -> 1.8.12 coroutines 1.6.2 -> 1.6.4 kotlin-logging 2.1.23 -> 3.0.4 spek 2.0.18 -> 2.0.19 kotlin-csv-jvm 1.3.0 -> 1.6.0
Source code(tar.gz)
Source code(zip)
v2.1.2(Jul 22, 2022)

catch all Throwable when consuming event (previously only Exceptions are caught)
Source code(tar.gz)
Source code(zip)
v2.1.1(Jul 15, 2022)
change "no subscriber" log message level from warn to trace update infrastructure:

gradle 7.2 -> 7.5

kotlin 1.5.31 -> 1.6.20

javamodularity 1.8.8 -> 1.8.11

kotlin-logging 2.0.11 -> 2.1.23

spek 2.0.17 -> 2.0.18

Source code(tar.gz)
Source code(zip)
v2.1.0(Oct 3, 2021)

remove ORDERED_CONCURRENT DispatchMode update kotlin to 1.5.31 add jar META-INF content
Source code(tar.gz)
Source code(zip)
v2.0.1(Jul 29, 2021)

Update kotlin to 1.5.21
Source code(tar.gz)
Source code(zip)
v2.0.0(Feb 16, 2021)

refactor KEvent from object to class add subscribers get method migrate to Maven Central
Source code(tar.gz)
Source code(zip)
v1.0.0(Nov 30, 2020)

Source code(tar.gz)
Source code(zip)