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

ShutDownUrl

class ShutDownUrl(val url: String, val exitCode: <Error class: unknown class>.() -> Int)

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.

Constructors

Link copied to clipboard
constructor(url: String, exitCode: <Error class: unknown class>.() -> Int)

Types

Link copied to clipboard
object Companion
Link copied to clipboard
class Config

A configuration for the ShutDownUrl plugin.

Link copied to clipboard
object EnginePlugin

A plugin to install into an engine pipeline.

Properties

Link copied to clipboard
val exitCode: <Error class: unknown class>.() -> Int

is a function to compute a process exit code

Link copied to clipboard
val url: String

to handle

Functions

Link copied to clipboard
suspend fun doShutdown(call: <Error class: unknown class>)

Shuts down an application using the specified call.