Package io.ktor.utils.io.nio

Functions

fun ReadableByteChannel.asInput(pool: ObjectPool<ChunkBuffer> = ChunkBuffer.Pool): Input

fun WritableByteChannel.asOutput(pool: ObjectPool<ChunkBuffer> = ChunkBuffer.Pool): Output

~~fun~~ ReadableByteChannel.~~read~~(~~buffer~~: Buffer): Int

Does the same as ReadableByteChannel.read but to a Buffer instance

fun ReadableByteChannel.read(destination: Memory, destinationOffset: Int = 0, maxLength: Int = destination.size32 - destinationOffset): Int

Does the same as ReadableByteChannel.read but to a Memory instance

readPacketAtLeast

fun ReadableByteChannel.readPacketAtLeast(n: Long): ByteReadPacket

Read a packet of at least n bytes or all remaining. Does fail if not enough bytes remaining. . This function is useless with non-blocking channels

readPacketAtMost

fun ReadableByteChannel.readPacketAtMost(n: Long): ByteReadPacket

Read a packet of at most n bytes. Resulting packet could be empty however this function always reads as much bytes as possible. You also can use it with non-blocking channels

readPacketExact

fun ReadableByteChannel.readPacketExact(n: Long): ByteReadPacket

Read a packet of exactly n bytes. This function is useless with non-blocking channels

write

~~fun~~ WritableByteChannel.~~write~~(~~buffer~~: Buffer): Int

Does the same as WritableByteChannel.write but from a Buffer instance

fun WritableByteChannel.write(source: Memory, sourceOffset: Int = 0, maxLength: Int = source.size32 - sourceOffset): Int

Does the same as WritableByteChannel.write but from a Memory instance

writePacket

fun WritableByteChannel.writePacket(p: ByteReadPacket): Boolean

Writes packet to a NIO channel. May block if the channel is configured as blocking or may write packet only partially if the channel is non-blocking and there is not enough buffer space.

fun WritableByteChannel.writePacket(builder: BytePacketBuilder.() -> Unit): ByteReadPacket?

Builds packet and write it to a NIO channel. May block if the channel is configured as blocking or may write packet partially so this function returns remaining packet. So for blocking channel this function always returns null.