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

BaseRouteScopedPlugin

interface BaseRouteScopedPlugin<TConfiguration : Any, TPlugin : Any> : Plugin<ApplicationCallPipeline, TConfiguration, TPlugin>

Defines a Plugin that can be installed into a Route.

Parameters

TConfiguration

is the configuration object type for this Plugin

TPlugin

is the instance type of the Plugin object

Functions

Link copied to clipboard
abstract fun install(pipeline: ApplicationCallPipeline, configure: TConfiguration.() -> Unit): TPlugin

A plugin's installation script.

Properties

Link copied to clipboard
abstract val key: AttributeKey<TPlugin>

A unique key that identifies a plugin.

Inheritors

Link copied to clipboard