Package-level declarations

Represents configured and running web application, capable of handling requests. It is also the application coroutine scope that is cancelled immediately at application stop so useful for launching background coroutines.

A single act of communication between a client and server.

Pipeline configuration for executing PipelineCall instances.

Represents an environment in which Application runs

Represents an environment in which Application runs

Provides events for Application lifecycle.

Defines a Plugin that is installed into Application.

An application config with which the application is running.

A builder for ApplicationProperties.

Defines a Plugin that is installed into Application.

Defines a Plugin that can be installed into a RouteNode.

The context associated with the call that is currently being processed by server. Every call handler (PluginBuilder.onCall, PluginBuilder.onCallReceive, PluginBuilder.onCallRespond, and so on) of your plugin has a derivative of CallContext as a receiver.

Thrown on an attempt to install the plugin with the same key as for the already installed plugin.

Thrown on an attempt to install the plugin with the same key as for the already installed plugin.

Definition of an event. Event is used as a key so both hashCode and equals need to be implemented properly. Inheriting of this class is an experimental plugin. Instantiate directly if inheritance not necessary.

Specifies signature for the event handler.

A hook that can be registered in PluginBuilder.

An exception that is thrown when the current body in the HTTP pipeline is invalid.

Thrown on an attempt to access the plugin that is not yet installed.

A context associated with the call handling by your application. OnCallContext is a receiver for PluginBuilder.onCall handler of your PluginBuilder.

A context associated with the call.receive() action. Allows you to transform the received body. OnCallReceiveContext is a receiver for PluginBuilder.onCallReceive handler of your PluginBuilder.

A context associated with the call.respond() action. Allows you to transform the response body. OnCallRespondContext is a receiver for PluginBuilder.onCallRespond handler of your PluginBuilder.

A single act of communication between a client and server.

Defines an installable Plugin.

A utility class to build an ApplicationPlugin instance.

An instance of the plugin installed to your application.

Defines a Plugin that can be installed into RouteNode

Utility class to build a RouteScopedPlugin instance.

Contains type information about the current request or response body when performing a transformation.

Current application for the context

Event definition for Application Started event

Event definition for Application Starting event

Event definition for Application Stopped event

Event definition for Application Stopping event

Event definition for an event that is fired when the application is going to stop

Current call for the context

The host address of the currently running application, as defined by the configuration at start-up.

Indicates if a response is sent.

Convenience property to access log from application

Returns the existing plugin registry or registers and returns a new one.

The port the current application is running on, as defined by the configuration at start-up.

The TypeInfo recorded from the last call.receive() call.

Fired when the server is ready to accept connections

Creates an ApplicationProperties instance.

Creates an ApplicationPlugin that can be installed into an Application.

Creates a RouteScopedPlugin that can be installed into a io.ktor.server.routing.RouteNode.

Finds the plugin F in the current RouteNode. If not found, search in the parent RouteNode.

Installs a plugin into this pipeline, if it is not yet installed.

Gets a plugin instance for this pipeline, or fails with MissingApplicationPluginException if the plugin is not installed.

Returns a plugin instance for this pipeline, or null if the plugin is not installed.

Uninstalls a plugin from the pipeline.

Uninstalls all plugins from the pipeline.

Uninstalls a plugin specified by key from the pipeline.