API marked with this annotation is internal, and it is not intended to be used outside Ktor. It could be modified or removed without any notice. Using it outside Ktor could cause undefined behaviour and/or any unexpected effects.

KtorDsl

@DslMarker

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.TYPEALIAS, AnnotationTarget.TYPE, AnnotationTarget.FUNCTION])

annotation class KtorDsl

A marker annotations for DSLs.

KtorExperimentalAPI

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.TYPEALIAS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.CONSTRUCTOR])

annotation class ~~KtorExperimentalAPI~~

API marked with this annotation is experimental and is not guaranteed to be stable.

NonceManager

interface NonceManager

Represents a nonce manager. Its responsibility is to produce nonce values and verify nonce values from untrusted sources that they are provided by this manager. This is usually required in web environment to mitigate CSRF attacks. Depending on it's underlying implementation it could be stateful or stateless. Note that there is usually some timeout for nonce values to reduce memory usage and to avoid replay attacks. Nonce length is unspecified.

PlatformUtils

expect object PlatformUtils

actual object PlatformUtils

PublicAPICandidate

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.TYPEALIAS])

annotation class PublicAPICandidate(val version: String)

API marked with this annotation is intended to become public in the future version. Usually it means that the API can't be public at the moment of development due to compatibility guarantees restrictions.

StatelessHmacNonceManager

class StatelessHmacNonceManager(val keySpec: SecretKeySpec, val algorithm: String = "HmacSHA256", val timeoutMillis: Long = 60000, val nonceGenerator: () -> String = { generateNonce() }) : NonceManager

Stateless nonce manager implementation with HMAC verification and timeout. Every nonce provided by this manager consist of a random part, timestamp and HMAC.

StringValues

interface StringValues

Provides data structure for associating a String with a List of Strings

StringValuesBuilder

interface StringValuesBuilder

StringValuesBuilderImpl

open class StringValuesBuilderImpl(val caseInsensitiveName: Boolean = false, size: Int = 8) : StringValuesBuilder

StringValuesImpl

open class StringValuesImpl(val caseInsensitiveName: Boolean = false, values: Map<String, List<String>> = emptyMap()) : StringValues

StringValuesSingleImpl

open class StringValuesSingleImpl(val caseInsensitiveName: Boolean, val name: String, val values: List<String>) : StringValues

ThreadInfo

object ThreadInfo

WorkerStacktrace

class WorkerStacktrace(val worker: String, val stacktrace: List<String>)

Functions

appendAll

fun StringValuesBuilder.appendAll(builder: StringValuesBuilder): StringValuesBuilder

Append all values from the specified builder

appendFiltered

fun StringValuesBuilder.appendFiltered(source: StringValues, keepEmpty: Boolean = false, predicate: (String, String) -> Boolean)

Append values from source filtering values by the specified predicate

appendIfNameAbsent

fun StringValuesBuilder.appendIfNameAbsent(name: String, value: String): StringValuesBuilder

Appends name pair if there are no values associated with name

appendIfNameAndValueAbsent

fun StringValuesBuilder.appendIfNameAndValueAbsent(name: String, value: String): StringValuesBuilder

Appends name pair if there is no existing name pair

asStream

fun Input.asStream(): InputStream

Convert io.ktor.utils.io Input to java InputStream

Attributes

expect fun Attributes(concurrent: Boolean = false): Attributes

Creates an attributes instance suitable for the particular platform

actual fun Attributes(concurrent: Boolean): Attributes

Create ES specific Attributes instance.

actual fun Attributes(concurrent: Boolean): Attributes

Create JVM specific attributes instance.

actual fun Attributes(concurrent: Boolean): Attributes

Create native specific attributes instance.

build

suspend fun Digest.build(bytes: ByteArray): ByteArray

Calculate digest from current state and specified bytes.

suspend fun Digest.build(string: String, charset: Charset = Charsets.UTF_8): ByteArray

Calculate digest from current state and specified string.

caseInsensitiveMap

fun <Value : Any> caseInsensitiveMap(): MutableMap<String, Value>

Create an instance of case-insensitive mutable map. For internal use only.

chomp

inline fun String.chomp(separator: String, onMissingDelimiter: () -> Pair<String, String>): Pair<String, String>

Splits the given string into two parts before and after separator.

combineSafe

fun File.combineSafe(relativePath: Path): File

fun File.combineSafe(relativePath: String): File

fun Path.combineSafe(relativePath: Path): File

Append a relativePath safely that means that adding any extra .. path elements will not let access anything out of the reference directory (unless you have symbolic or hard links or multiple mount points)

contains

operator fun LongRange.contains(other: LongRange): Boolean

Returns true if other range is fully contained inside this range

copy

fun ByteBuffer.copy(size: Int = remaining()): ByteBuffer

Moves all bytes in this buffer to a newly created buffer with the optionally specified size

fun ByteBuffer.copy(pool: ObjectPool<ByteBuffer>, size: Int = remaining()): ByteBuffer

Moves all bytes in this buffer to a newly created buffer with the optionally specified size by allocating it from the given pool

copyToBoth

fun ByteReadChannel.copyToBoth(first: ByteWriteChannel, second: ByteWriteChannel)

Copy source channel to both output channels chunk by chunk.

createFixedThreadDispatcher

fun Dispatchers.createFixedThreadDispatcher(name: String, threads: Int): CloseableCoroutineDispatcher

createLRUCache

fun <K, V> createLRUCache(supplier: (K) -> V, close: (V) -> Unit, maxSize: Int): Map<K, V>

Create a new instance of thread safe LRUCache and return it.

decodeBase64Bytes

fun ByteReadPacket.decodeBase64Bytes(): Input

Decode ByteReadPacket from base64 format

fun String.decodeBase64Bytes(): ByteArray

Decode String from base64 format

decodeBase64String

fun String.decodeBase64String(): String

Decode String from base64 format encoded in UTF-8.

decodeString

fun ByteBuffer.decodeString(charset: Charset = Charsets.UTF_8): String

Decodes a string from this buffer with the specified charset

deflated

fun ByteReadChannel.deflated(gzip: Boolean = true, pool: ObjectPool<ByteBuffer> = KtorDefaultPool, coroutineContext: CoroutineContext = Dispatchers.Unconfined): ByteReadChannel

fun ByteWriteChannel.deflated(gzip: Boolean = true, pool: ObjectPool<ByteBuffer> = KtorDefaultPool, coroutineContext: CoroutineContext = Dispatchers.Unconfined): ByteWriteChannel

Launch a coroutine on coroutineContext that does deflate compression optionally doing CRC and writing GZIP header and trailer if gzip = true

Digest

expect fun Digest(name: String): Digest

Create Digest from specified hash name.

actual fun Digest(name: String): Digest

Create Digest from specified hash name.

actual fun Digest(name: String): Digest

Create Digest from specified hash name.

actual fun Digest(name: String): Digest

Create Digest from specified hash name.

encodeBase64

fun ByteReadPacket.encodeBase64(): String

Encode ByteReadPacket in base64 format

fun ByteArray.encodeBase64(): String

Encode ByteArray in base64 format

fun String.encodeBase64(): String

Encode String in base64 format and UTF-8 character encoding.

escapeHTML

fun String.escapeHTML(): String

Escapes the characters in a String using HTML entities

filter

fun StringValues.filter(keepEmpty: Boolean = false, predicate: (String, String) -> Boolean): StringValues

Create a new instance of StringValues filtered by the specified predicate

flattenEntries

fun StringValues.flattenEntries(): List<Pair<String, String>>

Copy values to a list of pairs

flattenForEach

fun StringValues.flattenForEach(block: (String, String) -> Unit)

Invoke block function for every value pair

generateNonce

expect fun generateNonce(): String

Generates a nonce string. Could block if the system's entropy source is empty

fun generateNonce(size: Int): ByteArray

Generates a nonce bytes of size. Could block if the system's entropy source is empty

actual fun generateNonce(): String

Generates a nonce string.

actual fun generateNonce(): String

Generates a nonce string 16 characters long. Could block if the system's entropy source is empty

actual fun generateNonce(): String

Generates a nonce string 32 characters long. Could block if the system's entropy source is empty

getDigestFunction

fun getDigestFunction(algorithm: String, salt: (value: String) -> String): (String) -> ByteArray

Create a digest function with the specified algorithm and salt provider.

hex

fun hex(bytes: ByteArray): String

Encode bytes as a HEX string with no spaces, newlines and 0x prefixes.

fun hex(s: String): ByteArray

Decode bytes from HEX string. It should be no spaces and 0x prefixes.

isLowerCase

fun Char.isLowerCase(): Boolean

Check if Char is in lower case

moveTo

fun ByteBuffer.moveTo(destination: ByteBuffer, limit: Int = Int.MAX_VALUE): Int

Moves bytes from this buffer to the destination buffer

moveToByteArray

fun ByteBuffer.moveToByteArray(): ByteArray

Moves bytes from this buffer into newly created ByteArray and returns it

normalizeAndRelativize

fun File.normalizeAndRelativize(): File

fun Path.normalizeAndRelativize(): Path

Remove all redundant . and .. path elements. Leading .. are also considered redundant.

printDebugTree

fun Job.printDebugTree(offset: Int = 0)

Print Job children tree.

putAll

fun Attributes.putAll(other: Attributes)

Adds all attributes from another collection, replacing original values if any.

read

fun ReadableByteChannel.read(buffer: ChunkBuffer): Int

Read from a NIO channel into the specified buffer Could return 0 if the channel is non-blocking or buffer has no free space

readShort

fun ByteArray.readShort(offset: Int): Short

Read Short in network order(BE) with specified offset from ByteArray.

sha1

expect fun sha1(bytes: ByteArray): ByteArray

Compute SHA-1 hash for the specified bytes

actual fun sha1(bytes: ByteArray): ByteArray

Compute SHA-1 hash for the specified bytes

actual fun sha1(bytes: ByteArray): ByteArray

Compute SHA-1 hash for the specified bytes

actual fun sha1(bytes: ByteArray): ByteArray

Compute SHA-1 hash for the specified bytes

SilentSupervisor

fun SilentSupervisor(parent: Job? = null): CoroutineContext

Supervisor with empty coroutine exception handler ignoring all exceptions.

split

fun ByteReadChannel.split(coroutineScope: CoroutineScope): Pair<ByteReadChannel, ByteReadChannel>

Split source ByteReadChannel into 2 new one. Cancel of one channel in split(input or both outputs) cancels other channels.

toByteArray

suspend fun ByteReadChannel.toByteArray(): ByteArray

Read channel to byte array.

toCharArray

fun String.toCharArray(): CharArray

Convert String to CharArray

toLowerCasePreservingASCIIRules

fun String.toLowerCasePreservingASCIIRules(): String

Does the same as the regular toLowerCase except that locale-specific rules are not applied to ASCII characters so latin characters are converted by the original english rules.

toMap

fun StringValues.toMap(): Map<String, List<String>>

Copy values to a new independent map

toUpperCasePreservingASCIIRules

fun String.toUpperCasePreservingASCIIRules(): String

Does the same as the regular toUpperCase except that locale-specific rules are not applied to ASCII characters so latin characters are converted by the original english rules.

unmodifiable