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.

LookAheadSession

typealias LookAheadSession = LookAheadSuspendSession

LookAheadSuspendSession

class LookAheadSuspendSession(channel: ByteReadChannel)

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.

ReaderJob

class ReaderJob : ChannelJob

ReaderScope

class ReaderScope(val channel: ByteReadChannel, val coroutineContext: CoroutineContext) : CoroutineScope

WriterJob

class WriterJob : ChannelJob

WriterScope

class WriterScope(val channel: ByteWriteChannel, val coroutineContext: CoroutineContext) : CoroutineScope

Properties

availableForRead

val ByteReadChannel.availableForRead: Int

availableForWrite

val ByteWriteChannel.availableForWrite: Int

CHANNEL_MAX_SIZE

val CHANNEL_MAX_SIZE: Int

isCancelled

val ChannelJob.isCancelled: Boolean

isCompleted

val ChannelJob.isCompleted: Boolean

totalBytesRead

val ByteReadChannel.~~totalBytesRead~~: Long

Functions

attachJob

fun ByteChannel.attachJob(job: ChannelJob)

fun ByteChannel.attachJob(job: Job)

Ensures that when the given job is canceled, the ByteChannel is canceled with the same exception.

awaitFreeSpace

suspend fun ByteWriteChannel.awaitFreeSpace()

ByteReadChannel

fun ByteReadChannel(source: Source): ByteReadChannel

fun ByteReadChannel(text: String, charset: Charset = Charsets.UTF_8): ByteReadChannel

fun ByteReadChannel(content: ByteArray, offset: Int = 0, length: Int = content.size): ByteReadChannel

Creates a channel for reading from the specified byte array. Please note that it could use content directly or copy its bytes depending on the platform

fun ByteReadChannel(content: ByteBuffer): ByteReadChannel

Creates a channel for reading from the specified byte buffer.

ByteString

fun ByteString(buffer: ByteBuffer): ByteString

cancel

fun ByteChannel.cancel()

fun ByteReadChannel.cancel()

fun ByteWriteChannel.~~cancel~~()

fun ChannelJob.cancel()

fun ByteWriteChannel.~~close~~()

fun ByteWriteChannel.close(cause: Throwable?)

copyAndClose

suspend fun ByteReadChannel.copyAndClose(channel: ByteWriteChannel, limit: Long = Long.MAX_VALUE): Long

copyTo

suspend fun ByteReadChannel.copyTo(channel: ByteWriteChannel): Long

suspend fun ByteReadChannel.copyTo(channel: ByteWriteChannel, limit: Long): Long

suspend fun ByteReadChannel.copyTo(channel: WritableByteChannel, limit: Long = Long.MAX_VALUE): Long

Copy up to limit bytes to blocking NIO channel. Copying to a non-blocking channel requires selection and not supported. It is suspended if no data are available in a byte channel but may block if destination NIO channel blocks.

counted

fun ByteReadChannel.counted(): CountedByteReadChannel

fun ByteWriteChannel.counted(): CountedByteWriteChannel

discard

suspend fun ByteReadChannel.discard(max: Long = Long.MAX_VALUE): Long

discardExact

suspend fun ByteReadChannel.discardExact(value: Long)

flushIfNeeded

suspend fun ByteWriteChannel.flushIfNeeded()

getCancellationException

fun ChannelJob.getCancellationException(): CancellationException

invokeOnCompletion

fun ChannelJob.invokeOnCompletion(block: () -> Unit)

join

suspend fun ChannelJob.join()

lookAhead

suspend fun ByteReadChannel.lookAhead(block: suspend LookAheadSuspendSession.() -> Unit)

lookAheadSuspend

suspend fun ByteReadChannel.lookAheadSuspend(block: suspend LookAheadSuspendSession.() -> Unit)

read

inline suspend fun ByteReadChannel.read(crossinline block: suspend (ByteArray, Int, Int) -> Int): Int

inline suspend fun ByteReadChannel.read(min: Int = 1, noinline consumer: (ByteBuffer) -> Unit)

Invokes consumer when it will be possible to read at least min bytes providing byte buffer to it so lambda can read from the buffer up to ByteBuffer.remaining bytes. If there are no min bytes available then the invocation could suspend until the requirement will be met.

readAvailable

fun ByteReadChannel.readAvailable(min: Int, block: (Buffer) -> Int): Int

Invokes block if it is possible to read at least min byte providing buffer to it so lambda can read from the buffer up to Buffer.readRemaining bytes. If there are no min bytes available then the invocation returns -1.

suspend fun ByteReadChannel.readAvailable(buffer: ByteArray, offset: Int = 0, length: Int = buffer.size - offset): Int

Reads all available bytes to dst buffer and returns immediately or suspends if no bytes available

suspend fun ByteReadChannel.readAvailable(buffer: ByteBuffer): Int

Reads bytes from the channel and writes them to the buffer up to its limit. If the channel's read buffer is exhausted, it suspends until there are bytes available.

fun ByteReadChannel.readAvailable(block: (ByteBuffer) -> Int): Int

Invokes block if it is possible to read at least min byte providing byte buffer to it so lambda can read from the buffer up to ByteBuffer.available bytes. If there are no min bytes available then the invocation returns 0.

suspend fun ByteReadChannel.readAvailable(dst: CPointer<ByteVar>, offset: Int, length: Int): Int

Reads all available bytes to dst buffer and returns immediately or suspends if no bytes available

fun Input.readAvailable(cPointer: CPointer<ByteVar>, offset: Int, length: Int): Int

readBuffer

suspend fun ByteReadChannel.readBuffer(): Buffer

suspend fun ByteReadChannel.readBuffer(max: Int): Buffer

readByte

suspend fun ByteReadChannel.readByte(): Byte

readByteArray

suspend fun ByteReadChannel.readByteArray(count: Int): ByteArray

reader

fun CoroutineScope.reader(coroutineContext: CoroutineContext, channel: ByteChannel, block: suspend ReaderScope.() -> Unit): ReaderJob

fun CoroutineScope.reader(coroutineContext: CoroutineContext = EmptyCoroutineContext, autoFlush: Boolean = false, block: suspend ReaderScope.() -> Unit): ReaderJob

readFully

suspend fun ByteReadChannel.readFully(out: ByteArray)

Reads all length bytes to dst buffer or fails if channel has been closed. Suspends if not enough bytes available.

suspend fun ByteReadChannel.readFully(buffer: ByteBuffer)

readInt

suspend fun ByteReadChannel.readInt(): Int

readLong

suspend fun ByteReadChannel.readLong(): Long

readPacket

suspend fun ByteReadChannel.readPacket(packet: Int): ByteReadPacket

Reads a packet of packet bytes from the channel.

readRemaining

suspend fun ByteReadChannel.readRemaining(): ByteReadPacket

suspend fun ByteReadChannel.readRemaining(max: Long): ByteReadPacket

readShort

suspend fun ByteReadChannel.readShort(): Short

readText

fun ByteReadPacket.readText(): String

readUntilDelimiter

suspend fun ByteReadChannel.readUntilDelimiter(delimiter: ByteBuffer, out: ByteBuffer): Int

suspend fun ByteReadChannel.readUntilDelimiter(delimiter: ByteString, out: ByteBuffer): Int

readUTF8Line

suspend fun ByteReadChannel.readUTF8Line(): String?

readUTF8LineTo

suspend fun ByteReadChannel.readUTF8LineTo(out: Appendable, max: Int = Int.MAX_VALUE): Boolean

Reads a line of UTF-8 characters to the specified out buffer. It recognizes CR, LF and CRLF as a line delimiter.

release

fun BytePacketBuilder.~~release~~()

rethrowCloseCauseIfNeeded

fun ByteChannel.rethrowCloseCauseIfNeeded()

fun ByteReadChannel.rethrowCloseCauseIfNeeded()

fun ByteWriteChannel.rethrowCloseCauseIfNeeded()

skipDelimiter

suspend fun ByteReadChannel.skipDelimiter(delimiter: ByteBuffer)

suspend fun ByteReadChannel.skipDelimiter(delimiter: ByteString)

split

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

toByteArray

suspend fun ByteReadChannel.toByteArray(): ByteArray

write

suspend fun ByteWriteChannel.write(desiredSpace: Int = 1, block: (ByteArray, Int, Int) -> Int): Int

Await for desiredSpace will be available for write and invoke block function providing Memory instance and the corresponding range suitable for wiring in the memory. The block function should return number of bytes were written, possibly 0.

suspend fun ByteWriteChannel.write(min: Int = 1, block: (buffer: ByteBuffer) -> Unit)

writeAvailable

fun ByteWriteChannel.writeAvailable(buffer: ByteBuffer)

fun ByteWriteChannel.writeAvailable(min: Int = 1, block: (ByteBuffer) -> Unit): Int

Invokes block if it is possible to write at least min byte providing byte buffer to it so lambda can write to the buffer up to ByteBuffer.remaining bytes. If there are no min bytes spaces available then the invocation returns 0.

writeBuffer

suspend fun ByteWriteChannel.writeBuffer(value: Source)

writeByte

suspend fun ByteWriteChannel.writeByte(value: Byte)

writeByteArray

suspend fun ByteWriteChannel.writeByteArray(array: ByteArray)

writeByteBuffer

suspend fun ByteWriteChannel.writeByteBuffer(value: ByteBuffer)

writeFully

suspend fun ByteWriteChannel.writeFully(value: ByteArray, startIndex: Int = 0, endIndex: Int = value.size)

suspend fun ByteWriteChannel.writeFully(value: ByteBuffer)

suspend fun ByteWriteChannel.writeFully(value: CPointer<ByteVar>, offset: Int, length: Int)

suspend fun ByteWriteChannel.writeFully(src: CPointer<ByteVar>, offset: Long, length: Long)

writeInt

suspend fun ByteWriteChannel.writeInt(value: Int)

writeLong

suspend fun ByteWriteChannel.writeLong(value: Long)

writePacket

suspend fun ByteWriteChannel.writePacket(copy: Buffer)

suspend fun ByteWriteChannel.writePacket(copy: Source)

writer

fun CoroutineScope.writer(coroutineContext: CoroutineContext = EmptyCoroutineContext, channel: ByteChannel, block: suspend WriterScope.() -> Unit): WriterJob

fun CoroutineScope.writer(coroutineContext: CoroutineContext = EmptyCoroutineContext, autoFlush: Boolean = false, block: suspend WriterScope.() -> Unit): WriterJob

writeShort

suspend fun ByteWriteChannel.writeShort(value: Short)

writeSource

suspend fun ByteWriteChannel.writeSource(source: Source)

writeString

suspend fun ByteWriteChannel.writeString(value: String)

writeStringUtf8

suspend fun ByteWriteChannel.writeStringUtf8(value: String)