ktor-server-core/io.ktor.server.application/RouteScopedPluginBuilder

RouteScopedPluginBuilder

abstract class RouteScopedPluginBuilder<PluginConfig : Any>(key: AttributeKey<PluginInstance>) : PluginBuilder<PluginConfig>

Utility class to build a RouteScopedPlugin instance.

Constructors

Link copied to clipboard
constructor(key: AttributeKey<PluginInstance>)

Properties

Link copied to clipboard
abstract val application: Application

A reference to the Application where the plugin is installed.

Link copied to clipboard
val applicationConfig: ApplicationConfig?

A configuration of your current application (incl. host, port and anything else you can define in application.conf).

Link copied to clipboard
val environment: ApplicationEnvironment?

Allows you to access the environment of the currently running application where the plugin is installed.

Link copied to clipboard
abstract val pluginConfig: PluginConfig

A configuration of the current plugin.

Link copied to clipboard
abstract val route: RouteNode?

A RouteNode to which this plugin was installed. Can be null if plugin in installed into Application.

Functions

Link copied to clipboard
fun <HookHandler> on(hook: Hook<HookHandler>, handler: HookHandler)

Specifies a handler for a specific hook. A hook can be a specific place in time or event during the request processing like application shutdown, an exception during call processing, etc.

Link copied to clipboard
fun onCall(block: suspend OnCallContext<PluginConfig>.(call: PipelineCall) -> Unit)

Specifies the block handler for every incoming PipelineCall.

Link copied to clipboard
fun onCallReceive(block: suspend OnCallReceiveContext<PluginConfig>.(call: PipelineCall) -> Unit)
fun onCallReceive(block: suspend OnCallReceiveContext<PluginConfig>.(call: PipelineCall, body: Any) -> Unit)

Specifies the block handler that allows you to obtain and transform data received from the client. This block is invoked for every attempt to receive the request body.

Link copied to clipboard
fun onCallRespond(block: suspend OnCallRespondContext<PluginConfig>.(call: PipelineCall) -> Unit)
fun onCallRespond(block: suspend OnCallRespondContext<PluginConfig>.(call: PipelineCall, body: Any) -> Unit)

Specifies the block handler that allows you to transform data before sending it to the client. This handler is executed when the call.respond function is invoked in a route handler.