ktor-http-cio/io.ktor.http.cio

Package-level declarations

Types

class CIOHeaders(headers: HttpHeadersMap) : Headers

An adapter from CIO low-level headers map to ktor Headers interface

class CIOMultipartDataBase(val coroutineContext: CoroutineContext, channel: ByteReadChannel, contentType: CharSequence, contentLength: Long?, formFieldLimit: Int = 65536, inMemoryFileUploadLimit: Int = formFieldLimit) : MultiPartData, CoroutineScope

Represents a multipart data object that does parse and convert parts to ktor's PartData

ConnectionOptions

class ConnectionOptions(val close: Boolean = false, val keepAlive: Boolean = false, val upgrade: Boolean = false, val extraOptions: List<String> = emptyList())

Represents a parsed Connection header

DecoderJob

typealias DecoderJob = WriterJob

Decoder job type

EncoderJob

typealias EncoderJob = ReaderJob

Encoder job type

HttpHeadersMap

class HttpHeadersMap

A headers map data structure used in CIO

HttpMessage

abstract class HttpMessage : Closeable

Represents a base HTTP message type for request and response

MultipartEvent

sealed class MultipartEvent

Represents a multipart content starting event. Every part need to be completely consumed or released via release

ParserException

class ParserException(message: String) : IllegalStateException

An HTTP parser exception

Request

class Request : HttpMessage

Represents an HTTP request

RequestResponseBuilder

expect class RequestResponseBuilder

Builds an HTTP request or response

actual class RequestResponseBuilder

Builds an HTTP request or response

actual class RequestResponseBuilder

Builds an HTTP request or response

actual class RequestResponseBuilder

Builds an HTTP request or response

Response

class Response : HttpMessage

Represents an HTTP response

Functions

boundary

suspend fun ~~boundary~~(boundaryPrefixed: ByteBuffer, input: ByteReadChannel): Boolean

Skip multipart boundary

decodeChunked

fun CoroutineScope.~~decodeChunked~~(input: ByteReadChannel): DecoderJob

fun CoroutineScope.decodeChunked(input: ByteReadChannel, contentLength: Long): DecoderJob

Start a chunked stream decoder coroutine

suspend fun decodeChunked(input: ByteReadChannel, out: ByteWriteChannel)

Decode chunked transfer encoding from the input channel and write the result in out.

suspend fun ~~decodeChunked~~(input: ByteReadChannel, out: ByteWriteChannel, contentLength: Long)

Chunked stream decoding loop

encodeChunked

suspend fun encodeChunked(output: ByteWriteChannel, input: ByteReadChannel)

Chunked stream encoding loop

suspend fun encodeChunked(output: ByteWriteChannel, coroutineContext: CoroutineContext): EncoderJob

Start chunked stream encoding coroutine

expectHttpBody

fun expectHttpBody(request: Request): Boolean

fun expectHttpBody(method: HttpMethod, contentLength: Long, transferEncoding: CharSequence?, connectionOptions: ConnectionOptions?, contentType: CharSequence?): Boolean

expectHttpUpgrade

fun expectHttpUpgrade(request: Request): Boolean

fun expectHttpUpgrade(method: HttpMethod, upgrade: CharSequence?, connectionOptions: ConnectionOptions?): Boolean

expectMultipart

fun ~~expectMultipart~~(headers: HttpHeadersMap): Boolean

Check if we have multipart content

parseBoundary

fun ~~parseBoundary~~(contentType: CharSequence): ByteBuffer

Parse multipart boundary encoded in contentType header value

parseHeaders

suspend fun parseHeaders(input: ByteReadChannel): HttpHeadersMap

Parse http headers. Not applicable to request and response status lines.

parseHttpBody

suspend fun parseHttpBody(headers: HttpHeadersMap, input: ByteReadChannel, out: ByteWriteChannel)

Parse HTTP request or response body using request/response's headers writing it to out. Usually doesn't fail but closing out channel with error.

suspend fun parseHttpBody(contentLength: Long, transferEncoding: CharSequence?, connectionOptions: ConnectionOptions?, input: ByteReadChannel, out: ByteWriteChannel)

Parse HTTP request or response body using contentLength, transferEncoding and connectionOptions writing it to out. Usually doesn't fail but closing out channel with error.

parseMultipart

fun CoroutineScope.parseMultipart(input: ByteReadChannel, headers: HttpHeadersMap): ReceiveChannel<MultipartEvent>

fun CoroutineScope.parseMultipart(input: ByteReadChannel, contentType: CharSequence, contentLength: Long?): ReceiveChannel<MultipartEvent>

fun CoroutineScope.~~parseMultipart~~(boundaryPrefixed: ByteBuffer, input: ByteReadChannel, totalLength: Long?): ReceiveChannel<MultipartEvent>

Starts a multipart parser coroutine producing multipart events

parsePart

suspend fun ~~parsePart~~(boundaryPrefixed: ByteBuffer, input: ByteReadChannel, output: ByteWriteChannel, limit: Long = Long.MAX_VALUE): Pair<HttpHeadersMap, Long>

Parse multipart part headers and body. Body bytes will be copied to output but up to limit bytes

parsePartBody

suspend fun ~~parsePartBody~~(boundaryPrefixed: ByteBuffer, input: ByteReadChannel, output: ByteWriteChannel, headers: HttpHeadersMap, limit: Long = Long.MAX_VALUE): Long

Parse multipart part body copying them to output channel but up to limit bytes

parsePartHeaders

suspend fun ~~parsePartHeaders~~(input: ByteReadChannel): HttpHeadersMap

Parse multipart part headers

parsePreamble

suspend fun ~~parsePreamble~~(boundaryPrefixed: ByteBuffer, input: ByteReadChannel, output: BytePacketBuilder, limit: Long = Long.MAX_VALUE): Long

Parse a multipart preamble

parseRequest

suspend fun parseRequest(input: ByteReadChannel): Request?

Parse an HTTP request line and headers

parseResponse

suspend fun parseResponse(input: ByteReadChannel): Response?

Parse an HTTP response status line and headers