DefaultGateway

The default Gateway implementation of Kord, using an HttpClient for the underlying webSocket

Constructors

constructor(data: DefaultGatewayData)

open override val events: SharedFlow<Event>

The incoming events of the Gateway.

open override val ping: StateFlow<Duration?>

The duration between the last Heartbeat and HeartbeatACK.

open suspend override fun detach()

Close gateway and releases resources.

inline fun <T : Event> Gateway.on(scope: CoroutineScope = this, crossinline consumer: suspend T.() -> Unit): Job

Convenience method that will invoke the consumer on every event T created by Gateway.events.

Executes the request on this gateway, returning a flow of GuildMembersChunk responses.

Executes a RequestGuildMembers command configured by the builder for the given guildId on this gateway, returning a flow of GuildMembersChunk responses.

open suspend override fun send(command: Command)

Sends a Command to the gateway, suspending until the message has been sent.

open suspend override fun start(configuration: GatewayConfiguration)

Starts a reconnection gateway connection with the given configuration. This function will suspend until the lifecycle of the gateway has ended.

inline suspend fun Gateway.start(token: String, config: GatewayConfigurationBuilder.() -> Unit = {})

Starts a reconnecting gateway connection with the given parameters. This function will suspend until the lifecycle of the gateway has ended.

open suspend override fun stop()

Closes the Gateway and ends the current session, suspending until the underlying webSocket is closed.