ByteChannel
Deprecated
We're migrating to the new kotlinx-io library. This declaration is deprecated and will be removed in Ktor 4.0.0 If you have any problems with migration, please contact us in https://youtrack.jetbrains.com/issue/KTOR-6030/Migrate-to-new-kotlinx.io-library
Channel for asynchronous reading and writing of sequences of bytes. This is a buffered single-reader single-writer channel.
Read operations can be invoked concurrently with write operations, but multiple reads or multiple writes cannot be invoked concurrently with themselves. Exceptions are close and flush which can be invoked concurrently with any other operations and between themselves at any time.
Inheritors
Properties
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.
Functions
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 no failure (successfully)
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.
Reads up to limit bytes from receiver channel and writes them to dst channel. Closes dst channel if fails to read or write with cause exception.
Copies up to limit bytes from this byte channel to out stream suspending on read channel and blocking on output
Discards all bytes in the channel and suspends until end of stream.
Discards exactly n bytes or fails if not enough bytes in the channel
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.
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.
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 double 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.
Reads all remaining bytes and makes a byte packet
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 from the channel to the specified dst byte buffer until one of the following:
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
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
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.
Writes as much as possible and only suspends if buffer is full
Writes UTF16 character
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 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.