ktor-server-core/io.ktor.server.routing/Routing

Routing

class Routing(application: Application) : Route

A root routing node of an Application. You can learn more about routing in Ktor from Routing.

Parameters

application

is an instance of Application for this routing node.

Constructors

fun Routing(application: Application)

Types

object Plugin : BaseApplicationPlugin<Application, Routing, Routing>

An installation object of the Routing plugin.

Functions

afterIntercepted

open fun afterIntercepted()

fun createChild(selector: RouteSelector): Route

Creates a child node in this node with a given selector or returns an existing one with the same selector.

fun handle(handler: <ERROR CLASS><Unit, ApplicationCall>)

Installs a handler into this route which is called when the route is selected for a call.

suspend fun interceptor(context: <ERROR CLASS><Unit, ApplicationCall>)

operator fun invoke(body: Route.() -> Unit)

Allows using a route instance for building additional routes.

open override fun toString(): String

fun trace(block: (RoutingResolveTrace) -> Unit)

Registers a function used to trace route resolution. Might be useful if you need to understand why a route isn't executed. To learn more, see Tracing routes.

Properties

val application: Application

val children: List<Route>

List of child routes for this node.

developmentMode

val developmentMode: Boolean = false

open val environment: ApplicationEnvironment? = null

val parent: Route?

receivePipeline

val receivePipeline: ApplicationReceivePipeline

Pipeline for receiving content

val selector: RouteSelector

val sendPipeline: ApplicationSendPipeline

Pipeline for sending content