AsyncServletApplicationRequest
class AsyncServletApplicationRequest :
ServletApplicationRequest,
CoroutineScope
Constructors
AsyncServletApplicationRequest( |
Properties
val coroutineContext: <ERROR CLASS> |
Inherited Properties
open val cookies: RequestCookies Cookies for this request |
|
open val headers: Headers Headers for this request |
|
open val local: RequestConnectionPoint Contains http request and connection details such as a host name used to connect, port, scheme and so on. No proxy headers could affect it. Use ApplicationRequest.origin if you need override headers support |
|
open val queryParameters: Parameters Parameters provided in an URL |
|
val servletRequest: HttpServletRequest |
Functions
fun receiveChannel(): ByteReadChannel Request’s body channel (for content only) |
Extension Properties
val ApplicationRequest.httpMethod: HttpMethod Returns request HTTP method possibly overridden via header X-Http-Method-Override |
|
val ApplicationRequest.httpVersion: String Request’s HTTP version |
|
val ApplicationRequest.javaSecurityPrincipal: Principal? Returns Java’s JAAS Principal |
|
val ApplicationRequest.origin: RequestConnectionPoint Represents request and connection parameters possibly overridden via https headers. By default it fallbacks to ApplicationRequest.local |
|
val ApplicationRequest.uri: String Request’s URI (including query string) |
Extension Functions
fun ApplicationRequest.accept(): String? Request’s |
|
fun ApplicationRequest.acceptCharset(): String? Request’s |
|
fun ApplicationRequest.acceptCharsetItems(): List<HeaderValue> Parsed and sorted request’s |
|
fun ApplicationRequest.acceptEncoding(): String? Request’s |
|
fun ApplicationRequest.acceptEncodingItems(): List<HeaderValue> Parsed and sorted request’s |
|
fun ApplicationRequest.acceptItems(): List<HeaderValue> Parsed request’s |
|
fun ApplicationRequest.acceptLanguage(): String? Request’s |
|
fun ApplicationRequest.acceptLanguageItems(): List<HeaderValue> Parsed and sorted request’s |
|
fun ApplicationRequest.authorization(): String? Request authorization header value |
|
fun ApplicationRequest.basicAuthenticationCredentials( Retrieves Basic authentication credentials for this ApplicationRequest |
|
fun ApplicationRequest.cacheControl(): String? Request’s |
|
fun ApplicationRequest.contentCharset(): Charset? Request’s charset |
|
fun ApplicationRequest.contentType(): ContentType Request’s content type or |
|
fun CoroutineScope. fun CoroutineScope.decodeChunked( Start a chunked stream decoder coroutine |
|
fun ApplicationRequest.document(): String Request’s document name (substring after the last slash but before query string) |
|
fun <TEngine : ApplicationEngine, TConfiguration : Configuration> CoroutineScope.embeddedServer( Creates an embedded server with the given factory, listening on host:port |
|
fun ApplicationRequest.header(name: String): String? First header value for header with name or |
|
fun ApplicationRequest.host(): String Request’s host without port |
|
fun CoroutineScope.httpServer( Start an http server with settings invoking handler for every request |
|
fun CoroutineScope. Start an http server with settings invoking handler for every request |
|
fun ApplicationRequest.isChunked(): Boolean Check if request’s body is chunk-encoded |
|
fun ApplicationRequest.isMultipart(): Boolean Check if request body is multipart-encoded |
|
fun ApplicationRequest.location(): String? Request’s |
|
fun CoroutineScope.mapEngineExceptions( Returns ByteReadChannel with ByteChannel.close handler that returns SocketTimeoutException instead of SocketTimeoutException. fun CoroutineScope.mapEngineExceptions( Returns ByteWriteChannel with ByteChannel.close handler that returns SocketTimeoutException instead of SocketTimeoutException. |
|
fun ApplicationRequest.parseAuthorizationHeader(): HttpAuthHeader? Parses an authorization header from a ApplicationRequest returning a HttpAuthHeader. |
|
fun CoroutineScope.parseMultipart( fun CoroutineScope.parseMultipart( fun CoroutineScope.parseMultipart( Starts a multipart parser coroutine producing multipart events |
|
fun ApplicationRequest.path(): String Request’s path without query string |
|
fun CoroutineScope.pinger( Launch pinger coroutine on CoroutineScope that is sending ping every specified period to outgoing channel, waiting for and verifying client’s pong frames. It is also handling timeout and sending timeout close frame fun CoroutineScope.pinger( Launch pinger coroutine on CoroutineScope that is sending ping every specified periodMillis to outgoing channel, waiting for and verifying client’s pong frames. It is also handling timeoutMillis and sending timeout close frame |
|
fun CoroutineScope.pinger( Launch pinger coroutine on CoroutineScope that is sending ping every specified period to outgoing channel, waiting for and verifying client’s pong frames. It is also handling timeout and sending timeout close frame |
|
fun CoroutineScope.ponger( Launch a ponger actor job on the CoroutineScope sending pongs to outgoing channel. It is acting for every client’s ping frame and replying with corresponding pong |
|
fun ApplicationRequest.port(): Int Request’s port extracted from |
|
fun ApplicationRequest.queryString(): String Request’s query string or empty string if missing |
|
fun ApplicationRequest.ranges(): RangesSpecifier? Parsed request’s |
|
fun CoroutineScope.reader( fun CoroutineScope.reader( |
|
fun CoroutineScope. Start connection HTTP pipeline invoking handler for every request. Note that handler could be invoked multiple times concurrently due to HTTP pipeline nature |
|
fun CoroutineScope.startServerConnectionPipeline( Start connection HTTP pipeline invoking handler for every request. Note that handler could be invoked multiple times concurrently due to HTTP pipeline nature |
|
fun ApplicationRequest.toLogString(): String Generates a string representing this ApplicationRequest suitable for logging |
|
fun ApplicationRequest.userAgent(): String? Request’s |
|
fun CoroutineScope.writeMultipleRanges( Start multirange response writer coroutine |
|
fun CoroutineScope.writer( fun CoroutineScope.writer( |