io.ktor.routing

Class Route

ApplicationCallPipeline

io.ktor.routing.Route

Direct Known Subclasses:

Routing

public class Route
extends ApplicationCallPipeline

Describes a node in a routing tree

Nested Class Summary

Nested classes/interfaces inherited from class io.ktor.application.ApplicationCallPipeline

ApplicationCallPipeline.ApplicationPhase

Field Summary

Fields inherited from class io.ktor.application.ApplicationCallPipeline

ApplicationPhase

Constructor Summary

Constructors

Constructor and Description
Route(Route parent, RouteSelector selector) Describes a node in a routing tree

Method Summary

Modifier and Type	Method and Description
Route	createChild(RouteSelector selector) Creates a child node in this node with a given selector or returns an existing one with the same selector
java.util.List<io.ktor.routing.Route>	getChildren() List of child routes for this node
Route	getParent()
RouteSelector	getSelector()
void	handle(kotlin.jvm.functions.Function3<? super io.ktor.pipeline.PipelineContext<kotlin.Unit,? extends io.ktor.application.ApplicationCall>,? super kotlin.Unit,? super kotlin.coroutines.experimental.Continuation<? super kotlin.Unit>,? extends java.lang.Object> handler) Installs a handler into this route which will be called when the route is selected for a call
void	intercept(io.ktor.pipeline.PipelinePhase phase, kotlin.jvm.functions.Function3<? super io.ktor.pipeline.PipelineContext<kotlin.Unit,? extends io.ktor.application.ApplicationCall>,? super kotlin.Unit,? super kotlin.coroutines.experimental.Continuation<? super kotlin.Unit>,? extends java.lang.Object> block) Installs an interceptor into this route which will be called when this or a child route is selected for a call
void	invoke(kotlin.jvm.functions.Function1<? super io.ktor.routing.Route,kotlin.Unit> body) Allows using route instance for building additional routes
java.lang.String	toString()

Methods inherited from class io.ktor.application.ApplicationCallPipeline

getReceivePipeline, getSendPipeline

Constructor Detail

Route

public Route(Route parent,
             RouteSelector selector)

Describes a node in a routing tree

Parameters:

parent - is a parent node in the tree, or null for root node

selector - is an instance of class RouteSelector for this node

Method Detail

getChildren

public java.util.List<io.ktor.routing.Route> getChildren()

List of child routes for this node

createChild

public Route createChild(RouteSelector selector)

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

invoke

public void invoke(kotlin.jvm.functions.Function1<? super io.ktor.routing.Route,kotlin.Unit> body)

Allows using route instance for building additional routes

handle

public void handle(kotlin.jvm.functions.Function3<? super io.ktor.pipeline.PipelineContext<kotlin.Unit,? extends io.ktor.application.ApplicationCall>,? super kotlin.Unit,? super kotlin.coroutines.experimental.Continuation<? super kotlin.Unit>,? extends java.lang.Object> handler)

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

intercept

public void intercept(io.ktor.pipeline.PipelinePhase phase,
                      kotlin.jvm.functions.Function3<? super io.ktor.pipeline.PipelineContext<kotlin.Unit,? extends io.ktor.application.ApplicationCall>,? super kotlin.Unit,? super kotlin.coroutines.experimental.Continuation<? super kotlin.Unit>,? extends java.lang.Object> block)

Installs an interceptor into this route which will be called when this or a child route is selected for a call

toString

public java.lang.String toString()

getParent

public Route getParent()

getSelector

public RouteSelector getSelector()