ktor-server-core/io.ktor.server.request

Package-level declarations

Types

ApplicationReceivePipeline

open class ApplicationReceivePipeline(val developmentMode: Boolean = false) : Pipeline<Any, PipelineCall>

A pipeline for processing incoming content. When executed, this pipeline starts with an instance of ByteReadChannel.

ApplicationRequest

interface ApplicationRequest

A client's request. To learn how to handle incoming requests, see Handling requests.

ContentTransformationException

typealias ContentTransformationException = io.ktor.server.plugins.ContentTransformationException

Thrown when content cannot be transformed to the desired type.

PipelineRequest

interface PipelineRequest : ApplicationRequest

A client's request that is used in ApplicationPlugin. To learn how to handle incoming requests, see Handling requests.

RequestAlreadyConsumedException

class RequestAlreadyConsumedException : IllegalStateException

Thrown when a request body has already been received. Usually it is caused by double ApplicationCall.receive invocation.

RequestCookies

open class RequestCookies(request: ApplicationRequest)

Server request's cookies.

Properties

formFieldLimit

var ApplicationCall.formFieldLimit: Long

Represents the limit for form field size in bytes for an ApplicationCall. This limit determines the maximum size allowed for form field data in a request.

httpMethod

val ApplicationRequest.httpMethod: HttpMethod

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

httpVersion

val ApplicationRequest.httpVersion: String

Gets a request's HTTP version.

uri

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.

acceptCharset

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.

acceptEncoding

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.

acceptItems

fun ApplicationRequest.acceptItems(): List<HeaderValue>

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

acceptLanguage

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.

authorization

fun ApplicationRequest.authorization(): String?

Get a request's Authorization header value.

cacheControl

fun ApplicationRequest.cacheControl(): String?

Gets a request's Cache-Control header value.

contentCharset

fun ApplicationRequest.contentCharset(): Charset?

Gets a request's charset.

contentLength

fun ApplicationRequest.contentLength(): Long?

Gets a request's Content-Length header value.

contentType

fun ApplicationRequest.contentType(): ContentType

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

document

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.

header

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

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

host

fun ApplicationRequest.host(): String

Gets a request's host value without a port.

isChunked

fun ApplicationRequest.isChunked(): Boolean

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

isMultipart

fun ApplicationRequest.isMultipart(): Boolean

Checks whether a request body is multipart-encoded.

location

fun ApplicationRequest.location(): String?

Get a request's Location header value.

path

fun ApplicationRequest.path(): String

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

port

fun ApplicationRequest.port(): Int

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

queryString

fun ApplicationRequest.queryString(): String

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

ranges

fun ApplicationRequest.ranges(): RangesSpecifier?

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

receive

inline suspend fun <T : Any> ApplicationCall.receive(): T

suspend fun <T> ApplicationCall.receive(typeInfo: TypeInfo): T

suspend fun <T : Any> ApplicationCall.receive(type: KClass<T>): T

Receives content for this request.

receiveChannel

inline suspend fun ApplicationCall.receiveChannel(): ByteReadChannel

Receives channel content for this call.

receiveMultipart

inline suspend fun ApplicationCall.receiveMultipart(formFieldLimit: Long = DEFAULT_FORM_FIELD_MAX_SIZE): MultiPartData

Receives multipart data for this call.

receiveNullable

inline suspend fun <T> ApplicationCall.receiveNullable(): T?

Receives content for this request.

receiveOrNull

inline suspend fun <T : Any> ApplicationCall.~~receiveOrNull~~(): T?

suspend fun <T : Any> ApplicationCall.~~receiveOrNull~~(typeInfo: TypeInfo): T?

suspend fun <T : Any> ApplicationCall.~~receiveOrNull~~(type: KClass<T>): T?

Receives content for this request.

receiveParameters

inline suspend fun ApplicationCall.receiveParameters(): Parameters

Receives form parameters for this call.

receiveStream

inline suspend fun <Error class: unknown class>.receiveStream(): InputStream

Receives stream content for this call.

receiveText

inline suspend fun ApplicationCall.receiveText(): String

Receives incoming content for this call as String.

userAgent

fun ApplicationRequest.userAgent(): String?

Gets a request's User-Agent header value.