ktor-server-core/io.ktor.server.application/ApplicationCall

ApplicationCall

interface ApplicationCall
Content copied to clipboard

Represents a single act of communication between a client and server.

Functions

Link copied to clipboard
abstract fun afterFinish(handler: (cause: Throwable?) -> Unit)
Content copied to clipboard

Allows you to execute a handler after the current call is finished.

Properties

Link copied to clipboard
abstract val application: Application
Content copied to clipboard

Application being called

Link copied to clipboard
abstract val attributes: <ERROR CLASS>
Content copied to clipboard

Attributes attached to this call.

Link copied to clipboard
abstract val parameters: <ERROR CLASS>
Content copied to clipboard

Parameters associated with this call.

Link copied to clipboard
abstract val request: ApplicationRequest
Content copied to clipboard

ApplicationRequest that represents a client request.

Link copied to clipboard
abstract val response: ApplicationResponse
Content copied to clipboard

ApplicationRequest that represents a server response.

Inheritors

Link copied to clipboard

Extensions

Link copied to clipboard
fun ApplicationCall.defaultTextContentType(contentType: <ERROR CLASS>?): <ERROR CLASS>
Content copied to clipboard

Creates a default ContentType based on the given contentType and current call

Link copied to clipboard
val ApplicationCall.isHandled: Boolean
Content copied to clipboard

Indicates if the response was sent.

Link copied to clipboard
val ApplicationCall.mutableOriginConnectionPoint: MutableOriginConnectionPoint
Content copied to clipboard

Returns MutableOriginConnectionPoint associated with this call

Link copied to clipboard
fun ApplicationCall.push(pathAndQuery: String)
Content copied to clipboard
fun ApplicationCall.push(encodedPath: String, encodedParameters: <ERROR CLASS>)
Content copied to clipboard

Produces HTTP/2 push from server to client or sets HTTP/1.x hint header or does nothing. Exact behaviour is up to engine implementation.

fun ApplicationCall.push(block: ResponsePushBuilder.() -> Unit)
Content copied to clipboard

Produces HTTP/2 push from server to client or sets HTTP/1.x hint header or does nothing (may call or not call block). Exact behaviour is up to engine implementation.

Link copied to clipboard
inline suspend fun <T : Any> ApplicationCall.receive(): T
Content copied to clipboard
suspend fun <T : Any> ApplicationCall.receive(type: KClass<T>): T
Content copied to clipboard
suspend fun <T : Any> ApplicationCall.receive(typeInfo: <ERROR CLASS>): T
Content copied to clipboard

Receives content for this request.

Link copied to clipboard
inline suspend fun ApplicationCall.receiveChannel(): <ERROR CLASS>
Content copied to clipboard

Receives channel content for this call.

Link copied to clipboard
inline suspend fun ApplicationCall.receiveMultipart(): <ERROR CLASS>
Content copied to clipboard

Receives multipart data for this call.

Link copied to clipboard
inline suspend fun <T : Any> ApplicationCall.receiveOrNull(): T?
Content copied to clipboard
suspend fun <T : Any> ApplicationCall.receiveOrNull(typeInfo: <ERROR CLASS>): T?
Content copied to clipboard
suspend fun <T : Any> ApplicationCall.receiveOrNull(type: KClass<T>): T?
Content copied to clipboard

Receives content for this request.

Link copied to clipboard
inline suspend fun ApplicationCall.receiveParameters(): <ERROR CLASS>
Content copied to clipboard

Receives form parameters for this call.

Link copied to clipboard
inline suspend fun ApplicationCall.receiveStream(): InputStream
Content copied to clipboard

Receives stream content for this call.

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

Receives incoming content for this call as String.

Link copied to clipboard
fun ApplicationCall.resolveResource(path: String, resourcePackage: String? = null, classLoader: ClassLoader = application.environment.classLoader, mimeResolve: (String) -> ContentType = { ContentType.defaultForFileExtension(it) }): OutgoingContent?
Content copied to clipboard
Link copied to clipboard
@JvmName(name = "respondWithType")
inline suspend fun <T : Any> ApplicationCall.respond(message: T)
Content copied to clipboard

Sends a message as a response

@JvmName(name = "respondWithType")
inline suspend fun <T : Any> ApplicationCall.respond(status: <ERROR CLASS>, message: T)
Content copied to clipboard

Sets status and sends a message as a response

Link copied to clipboard
suspend fun ApplicationCall.respondBytes(contentType: <ERROR CLASS>? = null, status: <ERROR CLASS>? = null, provider: suspend () -> ByteArray)
Content copied to clipboard

Responds to a client with a raw bytes response, using specified provider to build a byte array

suspend fun ApplicationCall.respondBytes(bytes: ByteArray, contentType: <ERROR CLASS>? = null, status: <ERROR CLASS>? = null, configure: <ERROR CLASS>.() -> Unit = {})
Content copied to clipboard

Responds to a client with a raw bytes response, using specified bytes

Link copied to clipboard
suspend fun ApplicationCall.respondBytesWriter(contentType: <ERROR CLASS>? = null, status: <ERROR CLASS>? = null, contentLength: Long? = null, producer: suspend <ERROR CLASS>.() -> Unit)
Content copied to clipboard

Respond with binary content producer.

Link copied to clipboard
suspend fun ApplicationCall.respondFile(baseDir: File, fileName: String, configure: OutgoingContent.() -> Unit = {})
Content copied to clipboard

Responds to a client with a contents of a file with the name fileName in the baseDir folder

suspend fun ApplicationCall.respondFile(file: File, configure: OutgoingContent.() -> Unit = {})
Content copied to clipboard

Responds to a client with a contents of a file

Link copied to clipboard
suspend fun ApplicationCall.respondOutputStream(contentType: ContentType? = null, status: HttpStatusCode? = null, producer: suspend OutputStream.() -> Unit)
Content copied to clipboard
suspend fun ApplicationCall.respondOutputStream(contentType: ContentType? = null, status: HttpStatusCode? = null, contentLength: Long? = null, producer: suspend OutputStream.() -> Unit)
Content copied to clipboard

Respond with binary content producer.

Link copied to clipboard
suspend fun ApplicationCall.respondRedirect(url: String, permanent: Boolean = false)
Content copied to clipboard

Responds to a client with a 301 Moved Permanently or 302 Found redirect

inline suspend fun ApplicationCall.respondRedirect(permanent: Boolean = false, block: <ERROR CLASS>.() -> Unit)
Content copied to clipboard

Responds to a client with a 301 Moved Permanently or 302 Found redirect. Unlike the other respondRedirect it provides a way to build URL based on current call using block function

Link copied to clipboard
suspend fun ApplicationCall.respondText(text: String, contentType: <ERROR CLASS>? = null, status: <ERROR CLASS>? = null, configure: <ERROR CLASS>.() -> Unit = {})
Content copied to clipboard

Responds to a client with a plain text response, using specified text

suspend fun ApplicationCall.respondText(contentType: <ERROR CLASS>? = null, status: <ERROR CLASS>? = null, provider: suspend () -> String)
Content copied to clipboard

Responds to a client with a plain text response, using specified provider to build a text

Link copied to clipboard
suspend fun ApplicationCall.respondTextWriter(contentType: ContentType? = null, status: HttpStatusCode? = null, writer: suspend Writer.() -> Unit)
Content copied to clipboard
suspend fun ApplicationCall.respondTextWriter(contentType: ContentType? = null, status: HttpStatusCode? = null, contentLength: Long? = null, writer: suspend Writer.() -> Unit)
Content copied to clipboard

Respond with text content writer.

Link copied to clipboard
inline fun ApplicationCall.url(block: <ERROR CLASS>.() -> Unit = {}): String
Content copied to clipboard

Creates an url using current call's schema, path and parameters as initial and then invokes block function on the url builder so amend parameters