Package io.ktor.server.engine
Types
An engine which runs an application.
Represents an environment in which engine runs.
Engine environment configuration builder
Engine environment configuration builder
Engine environment configuration builder
Implements ApplicationEngineEnvironment by loading an Application from a folder or jar.
Factory interface for creating ApplicationEngine instances
Base class for implementing an ApplicationCall.
Base class for implementing ApplicationEngine
Base class for implementing ApplicationRequest
Base class for implementing an ApplicationResponse
Base class for implementing an ApplicationResponse
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.
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 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 engine. 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.
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 ApplicationEngineEnvironment using ApplicationEngineEnvironmentBuilder.
Creates an ApplicationEngineEnvironment instance from command line arguments
Creates an ApplicationEngineEnvironment 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
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.
Load engine's configuration suitable for all engines from deploymentConfig
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