tegral-web-controllers/guru.zoroark.tegral.web.controllers/KtorModule

KtorModule

abstract class KtorModule(val moduleInstallationPriority: Int = DEFAULT_MODULE_PRIORITY, val restrictToAppName: String? = null)

A Ktor module that will be automatically installed to a corresponding KtorApplication with a matching app name.

If you wish to add a controller (a module that only calls routing and adds routes), consider using KtorController instead.

Constructors

KtorModule

fun KtorModule(moduleInstallationPriority: Int = DEFAULT_MODULE_PRIORITY, restrictToAppName: String? = null)

Types

Companion

object Companion

Functions

install

abstract fun Application.install()

Install this module on the given application.

Properties

moduleInstallationPriority

val moduleInstallationPriority: Int

The installation priority of this module within the application. Modules are installed from largest to smallest priority. The default value is available in the DEFAULT_*_PRIORITY constants.

restrictToAppName

val restrictToAppName: String? = null

The application name that this module should be installed in. This should correspond to the application name specified in KtorApplication.appName

Inheritors

KtorController