ByteChannel

autoFlush

Returns true if channel flushes automatically all pending bytes after every write function call. If false then flush only happens at manual flush invocation or when the buffer is full.

availableForRead

Returns number of bytes that can be read without suspension. Read operations do no suspend and return immediately when this number is at least the number of bytes requested for read.

availableForWrite

Returns number of bytes that can be written without suspension. Write operations do no suspend and return immediately when this number is at least the number of bytes requested for write.

closedCause

An closure cause exception or null if closed successfully or not yet closed

isClosedForRead

Returns true if the channel is closed and no remaining bytes are available for read. It implies that availableForRead is zero.

isClosedForWrite

readByteOrder

Byte order that is used for multi-byte read operations (such as readShort, readInt, readLong, readFloat, and readDouble).

totalBytesRead

Number of bytes read from the channel. It is not guaranteed to be atomic so could be updated in the middle of long running read operation.

totalBytesWritten

Number of bytes written to the channel. It is not guaranteed to be atomic so could be updated in the middle of write operation.

writeByteOrder

Byte order that is used for multi-byte write operations (such as writeShort, writeInt, writeLong, writeFloat, and writeDouble).

attachJob

awaitFreeSpace

Invokes block when at least 1 byte is available for write.

cancel

Close channel with optional cause cancellation. Unlike ByteWriteChannel.close that could close channel normally, cancel does always close with error so any operations on this channel will always fail and all suspensions will be resumed with exception.

close

Closes this channel with an optional exceptional cause. It flushes all pending write bytes (via flush). This is an idempotent operation – repeated invocations of this function have no effect and return false.

consumeEachBufferRange

For every available bytes range invokes visitor function until it return false or end of stream encountered

discard

Discard up to max bytes

flush

Flushes all pending write bytes making them available for read.

lookAhead

lookAheadSuspend

peekTo

Try to copy at least min but up to max bytes to the specified destination buffer from this input skipping offset bytes. If there are not enough bytes available to provide min bytes after skipping offset bytes then it will trigger the underlying source reading first and after that will simply copy available bytes even if EOF encountered so min is not a requirement but a desired number of bytes. It is safe to specify max greater than the destination free space. min shouldn’t be bigger than the destination free space. This function could trigger the underlying source suspending reading. It is allowed to specify too big offset so in this case this function will always return 0 after prefetching all underlying bytes but note that it may lead to significant memory consumption. This function usually copy more bytes than min (unless max = min) but it is not guaranteed. When 0 is returned with offset = 0 then it makes sense to check isClosedForRead.

read

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

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

readBoolean

Reads a boolean value (suspending if no bytes available yet) or fails if channel has been closed and not enough bytes.

readByte

Reads a byte (suspending if no bytes available yet) or fails if channel has been closed and not enough bytes.

readDouble

Reads double number (suspending if not enough bytes available) or fails if channel has been closed and not enough bytes.

readFloat

Reads float number (suspending if not enough bytes available) or fails if channel has been closed and not enough bytes.

readFully

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

readInt

Reads an int number (suspending if not enough bytes available) or fails if channel has been closed and not enough bytes.

readLong

Reads a long number (suspending if not enough bytes available) or fails if channel has been closed and not enough bytes.

readPacket

Reads the specified amount of bytes and makes a byte packet from them. Fails if channel has been closed and not enough bytes available. Accepts headerSizeHint to be provided, see BytePacketBuilder.

readRemaining

Reads up to limit bytes and makes a byte packet or until end of stream encountered. Accepts headerSizeHint to be provided, see BytePacketBuilder.

readSession

Starts non-suspendable read session. After channel preparation consumer lambda will be invoked immediately event if there are no bytes available for read yet.

readShort

Reads a short number (suspending if not enough bytes available) or fails if channel has been closed and not enough bytes.

readSuspendableSession

Starts a suspendable read session. After channel preparation consumer lambda will be invoked immediately even if there are no bytes available for read yet. consumer lambda could suspend as much as needed.

readUTF8Line

Reads a line of UTF-8 characters up to limit characters. Supports both CR-LF and LF line endings. Throws an exception if the specified limit has been exceeded.

readUTF8LineTo

Reads a line of UTF-8 characters to the specified out buffer up to limit characters. Supports both CR-LF and LF line endings. No line ending characters will be appended to out buffer. Throws an exception if the specified limit has been exceeded.

write

Invokes block when it will be possible to write at least min bytes 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 could suspend until the requirement will be met.

writeAvailable

Writes as much as possible and only suspends if buffer is full

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.

writeByte

Writes byte and suspends until written. Crashes if channel get closed while writing.

writeDouble

Writes double number and suspends until written. Crashes if channel get closed while writing.

writeFloat

Writes float number and suspends until written. Crashes if channel get closed while writing.

writeFully

Writes all src bytes and suspends until all bytes written. Causes flush if buffer filled up or when autoFlush Crashes if channel get closed while writing.

writeInt

Writes int number and suspends until written. Crashes if channel get closed while writing.

writeLong

Writes long number and suspends until written. Crashes if channel get closed while writing.

writePacket

Writes a packet fully or fails if channel get closed before the whole packet has been written

writeShort

Writes short number and suspends until written. Crashes if channel get closed while writing.

writeSuspendSession

writeWhile

Invokes block for every free buffer until it return false. It will also suspend every time when no free space available for write.

bufferedWriter

Open a buffered writer to the channel

cancel

close

Closes this channel with no failure (successfully)

consumeEachBufferRange

For every available bytes range invokes visitor function until it return false or end of stream encountered. The provided buffer should be never captured outside of the visitor block otherwise resource leaks, crashes and data corruptions may occur. The visitor block may be invoked multiple times, once or never.

copyAndClose

Reads all the bytes from receiver channel and writes them to dst channel and then closes it. Closes dst channel if fails to read or write with cause exception.

copyTo

Copies up to limit bytes from this byte channel to out stream suspending on read channel and blocking on output

copyTo

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

Copy up to limit bytes to blocking pipe. A shortcut to copyTo function with NIO channel destination

copyToBoth

Copy source channel to both output channels chunk by chunk.

deflated

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

discard

Discards all bytes in the channel and suspends until end of stream.

discardExact

Discards exactly n bytes or fails if not enough bytes in the channel

pass

Read data chunks from ByteReadChannel using buffer

read

Await until at least desiredSize is available for read or EOF and invoke block function. The block function should never capture a provided Memory instance outside otherwise an undefined behaviour may occur including accidental crash or data corruption. Block function should return number of bytes consumed or 0.

readAvailable

readDouble

readDoubleLittleEndian

readFloat

readFloatLittleEndian

readFully

readInt

readIntLittleEndian

readLong

readLongLittleEndian

readPacket

Reads the specified amount of bytes and makes a byte packet from them. Fails if channel has been closed and not enough bytes available.

readRemaining

Reads up to limit bytes and makes a byte packet or until end of stream encountered.

Reads all remaining bytes and makes a byte packet

readShort

readShortLittleEndian

readUTF8Line

readUTF8LineTo

readUntilDelimiter

Reads from the channel to the specified dst byte buffer until one of the following:

skipDelimiter

split

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

toByteArray

Read channel to byte array.

toByteArray

Convert ByteReadChannel to ByteArray

toInputStream

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

toOutputStream

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

use

Executes block on ByteWriteChannel and close it down correctly whether an exception

write

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.

write

Write a string in the specified charset

writeAvailable

writeBoolean

writeByte

writeChar

Writes UTF16 character

writeDouble

writeDoubleLittleEndian

writeFloat

writeFloatLittleEndian

writeFully

writeInt

writeIntLittleEndian

writeLong

writeLongLittleEndian

writePacket

writePacketSuspend

writeShort

writeShortLittleEndian

writeStringUtf8

writer

Open a writer to the channel

ByteChannelSequentialBase

Sequential (non-concurrent) byte channel implementation