PipelineRequest
A client's request that is used in ApplicationPlugin. To learn how to handle incoming requests, see Handling requests.
See also
Inheritors
Properties
An PipelineCall instance this PipelineRequest is attached to.
Provides access to cookies for this request.
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.
Gets a request HTTP method possibly overridden using the X-Http-Method-Override
header.
Gets a request's HTTP version.
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.
Represents request and connection parameters possibly overridden via https headers. By default, it fallbacks to ApplicationRequest.local
A pipeline for receiving content.
Provides access to decoded parameters of a URL query string.
Provides access to parameters of a URL query string.
Gets a request's URI, including a query string.
Functions
Get a request's Accept
header value.
Gets a request's Accept-Charset
header value.
Gets the Accept-Charset
header charsets sorted according to their qualities.
Gets a request's Accept-Encoding
header value.
Gets the Accept-Encoding
header encoding types sorted according to their qualities.
Gets the Accept
header content types sorted according to their qualities.
Gets a request's Accept-Language
header value.
Gets the Accept-Language
header languages sorted according to their qualities.
Get a request's Authorization
header value.
Gets a request's Cache-Control
header value.
Gets a request's charset.
Gets a request's Content-Length
header value.
Gets a request's content type or returns ContentType.Any
.
A document name is a substring after the last slash but before a query string.
Internal helper function to encode raw parameters. Should not be used directly.
Gets a request's host value without a port.
Checks whether a request's body is chunk-encoded.
Checks whether a request body is multipart-encoded.
Get a request's Location
header value.
Get a request's URL path without a query string.
Gets a request's port extracted from the Host
header value.
Gets a request's query string or returns an empty string if missing.
Gets ranges parsed from a request's Range
header value.
Receives a raw body payload as a channel.
Overrides request body. It's a caller responsibility to close the original channel if it's not needed.
Generates a string representing this ApplicationRequest suitable for logging
Gets a request's User-Agent
header value.