kiscord-gateway/kiscord.gateway

Package-level declarations

Gateway and WS interaction building blocks.

Types

GatewayBenchmark

class GatewayBenchmark

interface GatewayCall : KiscordCall

Gateway scope, passed through GatewayIncomingPipeline, GatewayOutgoingPipeline and GatewayRequestPipeline

GatewayCompression

class GatewayCompression(val compressor: GatewayCompression.Compressor)

Provides zlib-stream transport compression support for the Gateway feature.

GatewayConnection

class GatewayConnection : CoroutineScope, DisposableHandle

GatewayIncomingPipeline

class GatewayIncomingPipeline(val developmentMode: Boolean = false) : Pipeline<Any, GatewayCall>

GatewayOutgoingPipeline

class GatewayOutgoingPipeline(val developmentMode: Boolean = false) : Pipeline<Any, GatewayCall>

interface GatewayRequest

GatewayRequestPipeline

class GatewayRequestPipeline(val developmentMode: Boolean = false) : Pipeline<GatewayRequest, GatewayCall>

sealed class Shard : CoroutineScope

interface Sharding

Client-side initial sharding configuration

class Shards : Collection<Shard>

Functions

suspend fun Kiscord.connect(waitForReady: Boolean = false, join: Boolean = false)

gatewayCompression

fun Kiscord.Builder.gatewayCompression(block: GatewayCompression.Config.() -> Unit = {})

fun Kiscord.Builder.intent(intent: Identify.Intent)

fun Kiscord.Builder.intents(vararg intents: Identify.Intent)

fun Kiscord.Builder.intents(intents: Iterable<Identify.Intent>)

interceptConnect

inline fun GatewayRequestPipeline.interceptConnect(crossinline block: suspend PipelineContext<GatewayRequest, GatewayCall>.(Url) -> Url)

interceptIdentify

inline fun GatewayRequestPipeline.interceptIdentify(crossinline block: suspend PipelineContext<GatewayRequest, GatewayCall>.(Identify) -> Identify)

suspend fun Kiscord.join()

suspend fun GatewayConnection.join()

Waits for GatewayConnection to complete

fun PluggableBuilder<Kiscord>.logging(config: Logging.Config.() -> Unit = {})

inline fun Kiscord.Builder.presence(block: UpdatePresence.Builder.() -> Unit)

fun GatewayCompression.Config.raw()

Configures gateway connection to use no compression

requestGuildMembers

suspend fun GatewayConnection.requestGuildMembers(requestGuildMembers: RequestGuildMembers)

inline suspend fun GatewayConnection.requestGuildMembers(block: RequestGuildMembers.Builder.() -> Unit)

suspend fun GatewayConnection.updatePresence(updatePresence: UpdatePresence)

inline suspend fun GatewayConnection.updatePresence(block: UpdatePresence.Builder.() -> Unit)

updateVoiceState

suspend fun GatewayConnection.updateVoiceState(updateVoiceState: UpdateVoiceState)

inline suspend fun GatewayConnection.updateVoiceState(block: UpdateVoiceState.Builder.() -> Unit)

waitForReadiness

suspend fun Kiscord.waitForReadiness()

fun GatewayCompression.Config.zlib()

Configures gateway connection to use payload-level zlib compression

fun GatewayCompression.Config.zlibStream()

Configures gateway connection to use transport-level zlib compression

Properties

var Kiscord.Builder.intents: Set<Identify.Intent>

val Kiscord.intents: Set<Identify.Intent>

var Kiscord.Builder.largeThreshold: Int

val Kiscord.largeThreshold: Int

var Kiscord.Builder.presence: UpdatePresence?

var Kiscord.presence: UpdatePresence?

var Kiscord.Builder.sharding: Sharding

val Kiscord.sharding: Sharding

val Kiscord.shards: Shards