Package-level declarations
Types
An engine which runs an application.
Factory interface for creating ApplicationEngine instances.
Engine environment configuration builder
Engine environment configuration builder
Builder for configuring the environment of the Ktor application.
Engine environment configuration builder
Base class for implementing an PipelineCall.
Base class for implementing ApplicationEngine
Base class for implementing PipelineRequest
Represents a type of a connector, e.g HTTP or HTTPS.
Handles all uncaught exceptions and logs errors with the specified logger ignoring CancellationException and IOException.
Represents an embedded server that hosts an application. It's an entry point to the application and handles the lifecycle of the application engine.
Mutable implementation of EngineConnectorConfig for building connectors programmatically
Represents a connector configuration.
Application engine pipeline. One usually don't need to install interceptors here unless your are writing your own engine implementation
Mutable implementation of EngineSSLConnectorConfig for building connectors programmatically
Represents an SSL connector configuration.
A plugin that allows you to configure a URL used to shut down the server. There are two ways to enable this plugin:
Functions
Adds automatic application shutdown hooks management. Should be used before starting the server. Once application termination noticed, stop block will be executed. Please note that a shutdown hook only registered when the application is running. If the application is already stopped then there will be no hook and no stop function invocation possible. So stop block will be called once or never.
Adds automatic application shutdown hooks management. Should be used before starting the engine. Once application termination noticed, stop block will be executed. Please note that a shutdown hook only registered when the application is running. If the application is already stopped then there will be no hook and no stop function invocation possible. So stop block will be called once or never.
Adds automatic application shutdown hooks management. Should be used before starting the server. Once application termination noticed, stop block will be executed. Please note that a shutdown hook only registered when the application is running. If the application is already stopped then there will be no hook and no stop function invocation possible. So stop block will be called once or never.
Adds automatic application shutdown hooks management. Should be used before starting the engine. Once application termination noticed, stop block will be executed. Please note that a shutdown hook only registered when the application is running. If the application is already stopped then there will be no hook and no stop function invocation possible. So stop block will be called once or never.
Adds automatic JVM shutdown hooks management. Should be used before starting the server. Once JVM termination noticed, stop block will be executed. Please note that a shutdown hook only registered when the application is running. If the application is already stopped then there will be no hook and no stop function invocation possible. So stop block will be called once or never.
Configures automatic management of JVM shutdown hooks for terminating an application. This function should be invoked before starting the application engine. Once the JVM termination is detected, the stop block will be executed. Please note that a shutdown hook is registered only while the application is running. If the application has already stopped, the hook won't be registered, and invoking stop will have no effect. Therefore, the stop block will be called either once or not at all.
Adds automatic application shutdown hooks management. Should be used before starting the server. Once application termination noticed, stop block will be executed. Please note that a shutdown hook only registered when the application is running. If the application is already stopped then there will be no hook and no stop function invocation possible. So stop block will be called once or never.
Adds automatic application shutdown hooks management. Should be used before starting the engine. Once application termination noticed, stop block will be executed. Please note that a shutdown hook only registered when the application is running. If the application is already stopped then there will be no hook and no stop function invocation possible. So stop block will be called once or never.
Creates an ApplicationEnvironment instance from command line arguments
Adds a non-secure connector to this engine environment
Default engine pipeline for all engines. Use it only if you are writing your own application engine implementation.
Creates an embedded server with the given factory, environment and configure script.
Creates an embedded server with the given factory, listening on given connectors.
Logs the error and responds with an appropriate error status code.
Default receive transformation
Default send transformation
Launch a coroutine with block body when the parent job is cancelled or a returned deferred is cancelled. It is important to complete or cancel returned deferred otherwise the parent job will be unable to complete successfully.
Loads common engine configuration parameters applicable to all engine types from the specified ApplicationConfig.
Logs the error with MDC setup.
Adds a secure connector to this engine environment
Stops this ApplicationEngine
Stop server on job cancellation. The returned deferred need to be completed or cancelled.
Returns new instance of EngineConnectorConfig based on this with modified port
Returns new instance of EngineConnectorConfig based on this with modified port
Returns new instance of EngineConnectorConfig based on this with modified port
Returns new instance of EngineConnectorConfig based on this with modified port