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

RoutingPipelineRequest

class RoutingPipelineRequest(val call: RoutingPipelineCall, val pipeline: ApplicationReceivePipeline, val engineRequest: PipelineRequest) : PipelineRequest

An application request handled by RoutingRoot.

Constructors

RoutingPipelineRequest

constructor(call: RoutingPipelineCall, pipeline: ApplicationReceivePipeline, engineRequest: PipelineRequest)

Properties

open override val call: RoutingPipelineCall

An PipelineCall instance this PipelineRequest is attached to.

open override val cookies: RequestCookies

Provides access to cookies for this request.

val engineRequest: PipelineRequest

open override val headers: Headers

Provides access to headers for the current request. You can also get access to specific headers using dedicated extension functions, such as acceptEncoding, contentType, cacheControl, and so on.

val ApplicationRequest.httpMethod: HttpMethod

Gets a request HTTP method possibly overridden using the X-Http-Method-Override header.

val ApplicationRequest.httpVersion: String

Gets a request's HTTP version.

open override val local: RequestConnectionPoint

Provides access to connection details such as a host name, port, scheme, etc. To get information about a request passed through an HTTP proxy or a load balancer, install the ForwardedHeaders/XForwardedHeader plugin and use the origin property.

val ApplicationRequest.origin: RequestConnectionPoint

Represents request and connection parameters possibly overridden via https headers. By default, it fallbacks to ApplicationRequest.local

open override val pipeline: ApplicationReceivePipeline

A pipeline for receiving content.

queryParameters

open override val queryParameters: Parameters

Provides access to decoded parameters of a URL query string.

rawQueryParameters

open override val rawQueryParameters: Parameters

Provides access to parameters of a URL query string.

val ApplicationRequest.uri: String

Gets a request's URI, including a query string.

Functions

fun ApplicationRequest.accept(): String?

Get a request's Accept header value.

fun ApplicationRequest.acceptCharset(): String?

Gets a request's Accept-Charset header value.

acceptCharsetItems

fun ApplicationRequest.acceptCharsetItems(): List<HeaderValue>

Gets the Accept-Charset header charsets sorted according to their qualities.

fun ApplicationRequest.acceptEncoding(): String?

Gets a request's Accept-Encoding header value.

acceptEncodingItems

fun ApplicationRequest.acceptEncodingItems(): List<HeaderValue>

Gets the Accept-Encoding header encoding types sorted according to their qualities.

fun ApplicationRequest.acceptItems(): List<HeaderValue>

Gets the Accept header content types sorted according to their qualities.

fun ApplicationRequest.acceptLanguage(): String?

Gets a request's Accept-Language header value.

acceptLanguageItems

fun ApplicationRequest.acceptLanguageItems(): List<HeaderValue>

Gets the Accept-Language header languages sorted according to their qualities.

fun ApplicationRequest.authorization(): String?

Get a request's Authorization header value.

fun ApplicationRequest.cacheControl(): String?

Gets a request's Cache-Control header value.

fun ApplicationRequest.contentCharset(): Charset?

Gets a request's charset.

fun ApplicationRequest.contentLength(): Long?

Gets a request's Content-Length header value.

fun ApplicationRequest.contentType(): ContentType

Gets a request's content type or returns ContentType.Any.

fun ApplicationRequest.document(): String

A document name is a substring after the last slash but before a query string.

encodeParameters

fun ApplicationRequest.encodeParameters(parameters: Parameters): Parameters

Internal helper function to encode raw parameters. Should not be used directly.

fun ApplicationRequest.header(name: String): String?

Gets the first value of a name header or returns null if missing.

fun ApplicationRequest.host(): String

Gets a request's host value without a port.

fun ApplicationRequest.isChunked(): Boolean

Checks whether a request's body is chunk-encoded.

fun ApplicationRequest.isMultipart(): Boolean

Checks whether a request body is multipart-encoded.

fun ApplicationRequest.location(): String?

Get a request's Location header value.

fun ApplicationRequest.path(): String

Get a request's URL path without a query string.

fun ApplicationRequest.port(): Int

Gets a request's port extracted from the Host header value.

fun ApplicationRequest.queryString(): String

Gets a request's query string or returns an empty string if missing.

fun ApplicationRequest.ranges(): RangesSpecifier?

Gets ranges parsed from a request's Range header value.

open override fun receiveChannel(): ByteReadChannel

Receives a raw body payload as a channel.

open override fun setHeader(name: String, values: List<String>?)

Overrides request headers. Will remove header name if passed values is null or set values otherwise.

setReceiveChannel

open override fun setReceiveChannel(channel: ByteReadChannel)

Overrides request body. It's a caller responsibility to close the original channel if it's not needed.

fun ApplicationRequest.toLogString(): String

Generates a string representing this ApplicationRequest suitable for logging

fun ApplicationRequest.userAgent(): String?

Gets a request's User-Agent header value.