ktor-server-status-pages/io.ktor.server.plugins.statuspages/StatusPagesConfig

StatusPagesConfig

class StatusPagesConfig

A StatusPages plugin configuration.

Constructors

StatusPagesConfig

constructor()

Types

class StatusContext(val call: ApplicationCall, val content: OutgoingContent)

A context for status config method.

Properties

val exceptions: MutableMap<KClass<*>, HandlerFunction>

Provides access to exception handlers of the exception class.

val statuses: MutableMap<HttpStatusCode, suspend (call: ApplicationCall, content: OutgoingContent, code: HttpStatusCode) -> Unit>

Provides access to status handlers based on a status code.

Functions

inline fun <T : Throwable> exception(noinline handler: suspend (call: ApplicationCall, cause: T) -> Unit)

Register an exception handler for the exception type T and its children.

fun <T : Throwable> exception(klass: KClass<T>, handler: suspend (call: ApplicationCall, T) -> Unit)

Register an exception handler for the exception class klass and its children.

fun <T : Throwable> StatusPagesConfig.exception(klass: Class<T>, handler: suspend PipelineContext<Unit, PipelineCall>.(T) -> Unit)

Register an exception handler for the exception class klass and its children

fun status(vararg status: HttpStatusCode, handler: suspend (ApplicationCall, HttpStatusCode) -> Unit)

@JvmName(name = "statusWithContext")

fun status(vararg status: HttpStatusCode, handler: suspend StatusPagesConfig.StatusContext.(HttpStatusCode) -> Unit)

Register a status handler for the status code.

fun StatusPagesConfig.statusFile(vararg code: HttpStatusCode, filePattern: String)

Register a status page file(s) using filePattern for multiple status code list

fun unhandled(handler: suspend (ApplicationCall) -> Unit)

Register a handler for the unhandled calls.