KtorApplicationSettings

class KtorApplicationSettings<TEngine : ApplicationEngine, TConfiguration : ApplicationEngine.Configuration>(val engine: ApplicationEngineFactory<TEngine, TConfiguration>, val port: Int = 80, val host: String = "0.0.0.0", val watchPaths: List<String> = listOf(File(".").canonicalPath), configure: TConfiguration.() -> Unit = {})

Application settings for the Ktor application. Identical to the parameters of the embeddedServer function from Ktor.

Constructors

Link copied to clipboard
constructor(engine: ApplicationEngineFactory<TEngine, TConfiguration>, port: Int = 80, host: String = "0.0.0.0", watchPaths: List<String> = listOf(File(".").canonicalPath), configure: TConfiguration.() -> Unit = {})

Properties

Link copied to clipboard
val engine: ApplicationEngineFactory<TEngine, TConfiguration>

The engine to use for the Ktor application.

Link copied to clipboard

The host on which to listen for HTTP connections. 0.0.0.0 by default.

Link copied to clipboard
val port: Int = 80

The port on which to listen for HTTP connections. 80 by default.

Link copied to clipboard

Paths which are listened to for changes to reload classes in dev mode.

Functions

Link copied to clipboard
fun embeddedServerFromSettings(block: Application.() -> Unit): TEngine

Equivalent to embeddedServer but uses this object's information as the parameters.