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).

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

read

Invokes block 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 WritePacket.

readShort

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

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. 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

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.

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

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.

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

joinTo

readASCIILine

readLine

readRemaining

Reads all the bytes from receiver channel and builds a packet that is returned unless the specified limit exceeded. It will simply stop reading and return packet of size limit in this case

readUTF8Line

readUntilDelimiter

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

skipDelimiter

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

write

See java.io.DataOutput.write

writeBoolean

writeByte

writeBytes

See java.io.DataOutput.writeBytes

writeChar

Writes UTF16 character

writeChars

See java.io.DataOutput.writeChars

writeInt

writePacket

writePacketSuspend

writeShort

writeStringUtf8

writeUTF

See java.io.DataOutput.writeUTF