ByteChannelSequentialJVM
Functions
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.
For every available bytes range invokes visitor function until it return false or end of stream encountered
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 endOfInput.
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.
Invokes block if it is possible to read at least min byte providing byte buffer to it so lambda can read from the buffer up to ByteBuffer.available bytes. If there are no min bytes available then the invocation returns 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. Accepts headerSizeHint to be provided, see WritePacket.
Reads up to limit bytes and makes a byte packet or until end of stream encountered. Accepts headerSizeHint to be provided, see BytePacketBuilder.
Starts non-suspendable read session. After channel preparation consumer lambda will be invoked immediately even if there are no bytes available for read yet.
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.
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.
Writes as much as possible and only suspends if buffer is full
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.
Invokes block for every free buffer until it return false
. It will also suspend every time when no free space available for write.
Properties
Returns true
if the channel is closed and no remaining bytes are available for read. It implies that availableForRead is zero.
Byte order that is used for multi-byte read operations (such as readShort, readInt, readLong, readFloat, and readDouble).
Byte order that is used for multi-byte write operations (such as writeShort, writeInt, writeLong, writeFloat, and writeDouble).