data class AndRouteSelector : RouteSelector
Evaluates a route as a result of the AND operation using two other selectors |
|
data class ConstantParameterRouteSelector : RouteSelector
Evaluates a route against a constant query parameter value |
|
data class HostRouteSelector : RouteSelector
Evaluates a route against a request's host and port |
|
data class HttpAcceptRouteSelector : RouteSelector
Evaluates a route against a content-type in the HttpHeaders.Accept header in the request |
|
data class HttpHeaderRouteSelector : RouteSelector
Evaluates a route against a header in the request |
|
data class HttpMethodRouteSelector : RouteSelector
Evaluates a route against an HttpMethod |
|
data class LocalPortRouteSelector : RouteSelector
Evaluate a route against the port on which the call was received. |
|
data class OptionalParameterRouteSelector : RouteSelector
Evaluates a route against an optional query parameter value and captures its value, if found |
|
data class OrRouteSelector : RouteSelector
Evaluates a route as a result of the OR operation using two other selectors |
|
data class ParameterRouteSelector : RouteSelector
Evaluates a route against a query parameter value and captures its value |
|
data class PathSegmentConstantRouteSelector : RouteSelector
Evaluates a route against a constant path segment |
|
data class PathSegmentOptionalParameterRouteSelector : RouteSelector
Evaluates a route against an optional parameter path segment and captures its value, if any |
|
data class PathSegmentParameterRouteSelector : RouteSelector
Evaluates a route against a parameter path segment and captures its value |
|
object PathSegmentSelectorBuilder
Helper object for building instances of RouteSelector from path segments |
|
data class PathSegmentTailcardRouteSelector : RouteSelector
Evaluates a route against any number of trailing path segments, and captures their values |
|
object PathSegmentWildcardRouteSelector : RouteSelector
Evaluates a route against any single path segment |
|
class RootRouteSelector : RouteSelector
The selector for routing root. |
|
open class Route : ApplicationCallPipeline
Describes a node in a routing tree. |
|
abstract class RouteSelector
Base type for all routing selectors |
|
data class RouteSelectorEvaluation
Represents a result of a route evaluation against a call |
|
class Routing : Route
Root routing node for an Application |
|
class RoutingApplicationCall : ApplicationCall
Represents an application call being handled by Routing |
|
class RoutingApplicationRequest : ApplicationRequest
Represents an application request being handled by Routing |
|
class RoutingApplicationResponse : ApplicationResponse
Represents an application response being handled by Routing |
|
class RoutingPath
Represents a parsed routing path. Consist of number of segments parts |
|
data class RoutingPathSegment
Represent a single routing path segment |
|
enum class RoutingPathSegmentKind
Possible routing path segment kinds |
|
class RoutingResolveContext
Represents a context in which routing resolution is being performed |
|
sealed class RoutingResolveResult
Represents a result of routing resolution. |
|
class RoutingResolveTrace
Represents the trace of routing resolution process for diagnostics. |
|
open class RoutingResolveTraceEntry
Represents a single entry in the RoutingResolveTrace. |
val Route.application: Application
Gets an Application for this Route by scanning the hierarchy to the root |
fun Route.accept(contentType: ContentType, build: Route.() -> Unit): Route
Builds a route to match requests with HttpHeaders.Accept header matching specified contentType |
|
fun Route.contentType(contentType: ContentType, build: Route.() -> Unit): Route
Builds a route to match requests with HttpHeaders.ContentType header matching specified contentType |
|
fun Route.createRouteFromPath(path: String): Route
Create a routing entry for specified path |
|
fun Route.delete(path: String, body: <ERROR CLASS><Unit, ApplicationCall>): Route
Builds a route to match fun Route.delete(body: <ERROR CLASS><Unit, ApplicationCall>): Route
Builds a route to match |
|
fun Route.get(path: String, body: <ERROR CLASS><Unit, ApplicationCall>): Route
Builds a route to match fun Route.get(body: <ERROR CLASS><Unit, ApplicationCall>): Route
Builds a route to match |
|
fun Route.head(path: String, body: <ERROR CLASS><Unit, ApplicationCall>): Route
Builds a route to match fun Route.head(body: <ERROR CLASS><Unit, ApplicationCall>): Route
Builds a route to match |
|
fun Route.header(name: String, value: String, build: Route.() -> Unit): Route
Builds a route to match header with specified name and value |
|
fun Route.host(host: String, port: Int = 0, build: Route.() -> Unit): Route fun Route.host(hostPattern: Regex, port: Int = 0, build: Route.() -> Unit): Route fun Route.host(hosts: List<String>, ports: List<Int> = emptyList(), build: Route.() -> Unit): Route fun Route.host(hosts: List<String>, hostPatterns: List<Regex>, ports: List<Int> = emptyList(), build: Route.() -> Unit): Route
Create a route to match request host and port. There are no any host resolutions/transformations applied to a host: a request host is treated as a string. |
|
fun Route.localPort(port: Int, build: Route.() -> Unit): Route
Create a route to match the port on which the call was received. |
|
fun Route.method(method: HttpMethod, body: Route.() -> Unit): Route
Builds a route to match specified method |
|
fun Route.optionalParam(name: String, build: Route.() -> Unit): Route
Builds a route to optionally capture parameter with specified name, if it exists |
|
fun Route.options(path: String, body: <ERROR CLASS><Unit, ApplicationCall>): Route
Builds a route to match fun Route.options(body: <ERROR CLASS><Unit, ApplicationCall>): Route
Builds a route to match |
|
fun Route.param(name: String, value: String, build: Route.() -> Unit): Route
Builds a route to match parameter with specified name and value fun Route.param(name: String, build: Route.() -> Unit): Route
Builds a route to match parameter with specified name and capture its value |
|
fun Route.patch(path: String, body: <ERROR CLASS><Unit, ApplicationCall>): Route
Builds a route to match fun Route.patch(body: <ERROR CLASS><Unit, ApplicationCall>): Route
Builds a route to match |
|
fun Route.port(vararg ports: Int, build: Route.() -> Unit): Route
Create a route to match request port. |
|
fun Route.post(path: String, body: <ERROR CLASS><Unit, ApplicationCall>): Route
Builds a route to match fun <R : Any> Route.post(path: String, body: suspend PipelineContext<Unit, ApplicationCall>.(R) -> Unit): Route
Builds a route to match fun Route.post(body: <ERROR CLASS><Unit, ApplicationCall>): Route
Builds a route to match |
|
fun Route.put(path: String, body: <ERROR CLASS><Unit, ApplicationCall>): Route
Builds a route to match fun Route.put(body: <ERROR CLASS><Unit, ApplicationCall>): Route
Builds a route to match |
|
fun Route.route(path: String, build: Route.() -> Unit): Route
Builds a route to match specified path fun Route.route(path: String, method: HttpMethod, build: Route.() -> Unit): Route
|
|
fun Application.routing(configuration: Routing.() -> Unit): Routing
Gets or installs a Routing feature for the this Application and runs a configuration script on it |