ByteChannel

Suspend until the channel has bytes to read or gets closed. Throws exception if the channel was closed with an error.

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

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.

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.

Discard up to max bytes

Flushes all pending write bytes making them available for read.

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.

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

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

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

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

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

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

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

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

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

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

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

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

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.

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.

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.

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

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

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

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

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.

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

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

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

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

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.

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.

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.

A closure causes exception or null if closed successfully or not yet closed

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

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.

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