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

Plugin

interface Plugin<in TPipeline : Pipeline<*, PipelineCall>, out TConfiguration : Any, TPlugin : Any>

Defines an installable Plugin.

Parameters

TPipeline

is the type of the pipeline this plugin is compatible with

TConfiguration

is the configuration object type for this Plugin

TPlugin

is the instance type of the Plugin object

Inheritors

Properties

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

A unique key that identifies a plugin.

Functions

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

A plugin's installation script.