ktor-server-core/io.ktor.server.engine/EmbeddedServer

EmbeddedServer

expect class EmbeddedServer<TEngine : ApplicationEngine, TConfiguration : ApplicationEngine.Configuration>(rootConfig: ServerConfig, engineFactory: ApplicationEngineFactory<TEngine, TConfiguration>, engineConfigBlock: TConfiguration.() -> Unit = {})(source)

Represents an embedded server that hosts an application. It's an entry point to the application and handles the lifecycle of the application engine.

Report a problem

Type Parameters

TEngine

The type of the application engine used by the server.

TConfiguration

The type of the configuration used by the engine.

actual class EmbeddedServer<TEngine : ApplicationEngine, TConfiguration : ApplicationEngine.Configuration>(rootConfig: ServerConfig, engineFactory: ApplicationEngineFactory<TEngine, TConfiguration>, engineConfigBlock: TConfiguration.() -> Unit)(source)

Represents an embedded server that hosts an application. It's an entry point to the application and handles the lifecycle of the application engine.

Report a problem

Type Parameters

TEngine

The type of the application engine used by the server.

TConfiguration

The type of the configuration used by the engine.

actual class EmbeddedServer<TEngine : ApplicationEngine, TConfiguration : ApplicationEngine.Configuration>(rootConfig: ServerConfig, engineFactory: ApplicationEngineFactory<TEngine, TConfiguration>, engineConfigBlock: TConfiguration.() -> Unit)(source)

Represents an embedded server that hosts an application. It's an entry point to the application and handles the lifecycle of the application engine.

Report a problem

Type Parameters

TEngine

The type of the application engine used by the server.

TConfiguration

The type of the configuration used by the engine.

actual class EmbeddedServer<TEngine : ApplicationEngine, TConfiguration : ApplicationEngine.Configuration>(rootConfig: ServerConfig, engineFactory: ApplicationEngineFactory<TEngine, TConfiguration>, engineConfigBlock: TConfiguration.() -> Unit)(source)

Represents an embedded server that hosts an application. It's an entry point to the application and handles the lifecycle of the application engine.

Report a problem

Type Parameters

TEngine

The type of the application engine used by the server.

TConfiguration

The type of the configuration used by the engine.

Constructors

expect constructor(rootConfig: ServerConfig, engineFactory: ApplicationEngineFactory<TEngine, TConfiguration>, engineConfigBlock: TConfiguration.() -> Unit = {})

actual constructor(rootConfig: ServerConfig, engineFactory: ApplicationEngineFactory<TEngine, TConfiguration>, engineConfigBlock: TConfiguration.() -> Unit)

actual constructor(rootConfig: ServerConfig, engineFactory: ApplicationEngineFactory<TEngine, TConfiguration>, engineConfigBlock: TConfiguration.() -> Unit)

actual constructor(rootConfig: ServerConfig, engineFactory: ApplicationEngineFactory<TEngine, TConfiguration>, engineConfigBlock: TConfiguration.() -> Unit)

Properties

expect val application: Application

actual val application: Application

actual val application: Application

actual val application: Application

expect val engine: TEngine

actual val engine: TEngine

actual val engine: TEngine

actual val engine: TEngine

expect val engineConfig: TConfiguration

actual val engineConfig: TConfiguration

actual val engineConfig: TConfiguration

actual val engineConfig: TConfiguration

expect val environment: ApplicationEnvironment

actual val environment: ApplicationEnvironment

actual val environment: ApplicationEnvironment

actual val environment: ApplicationEnvironment

expect val monitor: Events

Provides events on Application lifecycle

actual val monitor: Events

Provides events on Application lifecycle

actual val monitor: Events

Provides events on Application lifecycle

actual val monitor: Events

Provides events on Application lifecycle

Functions

addShutdownHook

fun EmbeddedServer<*, *>.addShutdownHook(stop: () -> Unit)

Registers a stop block that runs when the process receives a termination signal (JVM shutdown hook on JVM, POSIX signal on Native, process event on JS). Should be called before starting the server.

fun reload()

Reload application: stop the current instance first, then create a replacement.

expect fun start(wait: Boolean = false): EmbeddedServer<TEngine, TConfiguration>

actual fun start(wait: Boolean): EmbeddedServer<TEngine, TConfiguration>

actual fun start(wait: Boolean): EmbeddedServer<TEngine, TConfiguration>

actual fun ~~start~~(wait: Boolean): EmbeddedServer<TEngine, TConfiguration>

expect suspend fun startSuspend(wait: Boolean = false): EmbeddedServer<TEngine, TConfiguration>

actual suspend fun startSuspend(wait: Boolean): EmbeddedServer<TEngine, TConfiguration>

actual suspend fun startSuspend(wait: Boolean): EmbeddedServer<TEngine, TConfiguration>

actual suspend fun startSuspend(wait: Boolean): EmbeddedServer<TEngine, TConfiguration>

expect fun stop(gracePeriodMillis: Long = engineConfig.shutdownGracePeriod, timeoutMillis: Long = engineConfig.shutdownTimeout)

actual fun stop(gracePeriodMillis: Long, timeoutMillis: Long)

fun stop(shutdownGracePeriod: Long, shutdownTimeout: Long, timeUnit: TimeUnit)

actual fun stop(gracePeriodMillis: Long, timeoutMillis: Long)

actual fun stop(gracePeriodMillis: Long, timeoutMillis: Long)

expect suspend fun stopSuspend(gracePeriodMillis: Long = engineConfig.shutdownGracePeriod, timeoutMillis: Long = engineConfig.shutdownTimeout)

actual suspend fun stopSuspend(gracePeriodMillis: Long, timeoutMillis: Long)

actual suspend fun stopSuspend(gracePeriodMillis: Long, timeoutMillis: Long)

actual suspend fun stopSuspend(gracePeriodMillis: Long, timeoutMillis: Long)