ktor-io/io.ktor.utils.io/CountedByteWriteChannel

CountedByteWriteChannel

class CountedByteWriteChannel(delegate: ByteWriteChannel) : ByteWriteChannel

Constructors

CountedByteWriteChannel

constructor(delegate: ByteWriteChannel)

Properties

availableForWrite

val ByteWriteChannel.availableForWrite: Int

open override val closedCause: Throwable?

isClosedForWrite

open override val isClosedForWrite: Boolean

totalBytesWritten

val totalBytesWritten: Long

open override val writeBuffer: Sink

Functions

suspend fun ByteWriteChannel.awaitFreeSpace()

open override fun cancel(cause: Throwable?)

fun ByteWriteChannel.~~cancel~~()

fun ByteWriteChannel.~~close~~()

fun ByteWriteChannel.close(cause: Throwable?)

fun ByteWriteChannel.counted(): CountedByteWriteChannel

open suspend override fun flush()

open suspend override fun flushAndClose()

suspend fun ByteWriteChannel.flushIfNeeded()

rethrowCloseCauseIfNeeded

fun ByteWriteChannel.rethrowCloseCauseIfNeeded()

fun ByteWriteChannel.toOutputStream(): OutputStream

Create blocking java.io.OutputStream for this channel that does block every time the channel suspends at write Similar to do reading in runBlocking however you can pass it to regular blocking API

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)

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.

suspend fun ByteWriteChannel.writeBuffer(value: Source)

suspend fun ByteWriteChannel.writeByte(value: Byte)

suspend fun ByteWriteChannel.writeByteArray(array: ByteArray)

writeByteBuffer

suspend fun ByteWriteChannel.writeByteBuffer(value: ByteBuffer)

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)

suspend fun ByteWriteChannel.writeInt(value: Int)

suspend fun ByteWriteChannel.writeLong(value: Long)

suspend fun ByteWriteChannel.writePacket(copy: Buffer)

suspend fun ByteWriteChannel.writePacket(copy: Source)

suspend fun ByteWriteChannel.writeShort(value: Short)

suspend fun ByteWriteChannel.writeSource(source: Source)

suspend fun ByteWriteChannel.writeString(value: String)

writeStringUtf8

suspend fun ByteWriteChannel.writeStringUtf8(value: String)

writeSuspendSession

suspend fun ByteWriteChannel.~~writeSuspendSession~~(block: suspend WriteSuspendSession.() -> Unit)

inline suspend fun ByteWriteChannel.writeWhile(crossinline block: (ByteBuffer) -> Boolean)