Package-level declarations

Types

Link copied to clipboard
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.

Link copied to clipboard

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

Link copied to clipboard

Thrown when content cannot be transformed to the desired type.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
open class RequestCookies(request: ApplicationRequest)

Server request's cookies.

Properties

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Gets a request's HTTP version.

Link copied to clipboard

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

Functions

Link copied to clipboard

Get a request's Accept header value.

Link copied to clipboard

Gets a request's Accept-Charset header value.

Link copied to clipboard

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

Link copied to clipboard

Gets a request's Accept-Encoding header value.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Gets a request's Accept-Language header value.

Link copied to clipboard

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

Link copied to clipboard

Get a request's Authorization header value.

Link copied to clipboard

Gets a request's Cache-Control header value.

Link copied to clipboard

Gets a request's charset.

Link copied to clipboard

Gets a request's Content-Length header value.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Gets a request's host value without a port.

Link copied to clipboard

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

Link copied to clipboard

Checks whether a request body is multipart-encoded.

Link copied to clipboard

Get a request's Location header value.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
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.

Link copied to clipboard

Receives channel content for this call.

Link copied to clipboard
inline suspend fun ApplicationCall.receiveMultipart(formFieldLimit: Long = DEFAULT_FORM_FIELD_MAX_SIZE): MultiPartData

Receives multipart data for this call.

Link copied to clipboard
inline suspend fun <T> ApplicationCall.receiveNullable(): T?

Receives content for this request.

Link copied to clipboard
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.

Link copied to clipboard

Receives form parameters for this call.

Link copied to clipboard

Receives stream content for this call.

Link copied to clipboard
inline suspend fun ApplicationCall.receiveText(): String

Receives incoming content for this call as String.

Link copied to clipboard

Gets a request's User-Agent header value.