Project Gunfire

Project Gunfire is a lightweight event bus framework which is built in and for the Kotlin Programming Language.
This can be used to fire bullets with guns!

Requirements

• Kotlin/JVM 1.1.1+ (including coroutines)
• Java Runtime for Java 8

Dependencies

• Kotlinx-Coroutines for Kotlin 1.1.1+
• Kotlin std-jre8 1.1.1+

Recommended IDE: Intellij IDEA 2017.1

Getting Started

To create an EventBus for your project you have to choose your Gun:

• Gun
  The generic Gun which executes on the calling thread
• Sniper
  Extension of a simple Gun which synchronizes each bullet shot
• Revolver
  Extension of a simple Gun which can fire up to 6 bullets at once
• Uzi
  Fully automatic Gun which uses kotlin coroutines for each bullet shot

Every Gun implementation inherits from the Gun class and iterates over all registered targets.

Setup Target

import club.minnced.gunfire.core.Gun
import club.minnced.gunfire.core.impl.Sniper
import club.minnced.gunfire.core.target

val gun: Gun = Sniper()

fun main(args: Array<String>) {
    gun.target<Backfire> {
        it.error.printStackTrace()
    }
    gun.target<LogBullet> {
        println(it.message)
    }
}

Note: Here we register a target that will print every Throwable that is caught by the Gun!
Using the Backfire bullet specification!

Fire Gun

import club.minnced.gunfire.core.Gun
import club.minnced.gunfire.core.impl.Sniper
import club.minnced.gunfire.core.fire

class LogBullet(val message: String)

fun logMessage(message: String) {
    gun.fire {
        LogBullet(message)
    }
}

Note: Here we fire a LogBullet which holds a message for the targets!

Setup

JitPack Version:

Gradle

respositories {
    jcenter()
    maven {
        name 'jitpack.io'
        url 'https://jitpack.io'
    }
    // ...
}

dependencies {
    compile 'org.jetbrains.kotlin:kotlin-stdlib-jre8:1.1.1'
    compile 'org.jetbrains.kotlinx:kotlinx-coroutines-core:0.14'
    compile 'com.github.MinnDevelopment.Gunfire:core:master-SNAPSHOT'
    compile 'com.github.MinnDevelopment.Gunfire:commons:master-SNAPSHOT'
    // ...
}

Maven

<repository>
    <url>https://jitpack.io</url>
</repository>
<!-- 
Add other repositories for Kotlin 1.1.1 and Kotlinx-Coroutines
This may require jcenter as repository listing!
-->
<dependencies>
    <dependency>
        <groupid>com.github.MinnDevelopment.Gunfire</groupid>
        <artifactId>core</artifactId>
        <version>master-SNAPSHOT</version>
    </dependency>
    <dependency>
        <groupid>com.github.MinnDevelopment.Gunfire</groupid>
        <artifactId>commons</artifactId>
        <version>master-SNAPSHOT</version>
    </dependency>
</dependencies>

Examples

There is a Step-by-Step guide and an example which uses bullets to print messages to the console in the Examples Directories!