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

ShutDownUrl

class ShutDownUrl(val url: String, val exitCode: ApplicationCall.() -> Int, val exit: (Int) -> Unit = ::exitProcess)(source)

A plugin that allows you to configure a URL used to shut down the server. There are two ways to enable this plugin:

In a HOCON configuration file.
By installing the plugin. You can learn more from Shutdown URL.

Report a problem

Constructors

constructor(url: String, exitCode: ApplicationCall.() -> Int, exit: (Int) -> Unit = ::exitProcess)

Types

object Companion

class Config

A configuration for the ShutDownUrl plugin.

object EnginePlugin : BaseApplicationPlugin<EnginePipeline, ShutDownUrl.Config, ShutDownUrl>

A plugin to install into an engine pipeline.

Properties

val exit: (Int) -> Unit

the function for exiting the process; defaults to the system function exitProcess

val exitCode: ApplicationCall.() -> Int

is a function to compute a process exit code

val url: String

to handle

Functions

suspend fun doShutdown(call: ApplicationCall)

Shuts down an application using the specified call.