kiscord-gateway-events/kiscord.gateway.events

Package-level declarations

API and models for subscribing events from kiscord-gateway module.

Types

GatewayDispatchEvent

interface GatewayDispatchEvent<out T : Any> : GatewayPayloadEvent<T>

GatewayEventBus

interface GatewayEventBus : GatewayEventSink

GatewayEventCall

interface GatewayEventCall<out Event : GatewayPayloadEvent<Data>, out Data : Any> : GatewayCall

GatewayEventDefinition

abstract class GatewayEventDefinition<out Event : GatewayPayloadEvent<Data>, out Data : Any>

GatewayEventDsl

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.CLASS, AnnotationTarget.TYPE, AnnotationTarget.PROPERTY])

annotation class GatewayEventDsl

Dsl marker for GatewayEventBus dsl.

GatewayEventHandler

fun interface GatewayEventHandler<in Event : GatewayPayloadEvent<@UnsafeVariance Data>, in Data : Any>

class GatewayEvents : GatewayEventSink

GatewayEventSink

interface GatewayEventSink

General-purpose coroutine-based event sink. Can be subscribed for full event flow or select events based on types

GatewayPayloadEvent

interface GatewayPayloadEvent<out T : Any>

LockFreeGatewayEventBus

class LockFreeGatewayEventBus : GatewayEventBus

SharedFlowEventBus

class SharedFlowEventBus : GatewayEventBus

GatewayEventBus implementation which uses SharedFlow as backend.

Functions

inline fun Kiscord.gatewayEvents(block: GatewayEvents.() -> Unit)

fun PluggableBuilder<Kiscord>.gatewayEvents(block: GatewayEvents.Config.() -> Unit = {})

Properties

val Kiscord.gatewayEvents: GatewayEvents