Интерфейс GatheringByteChannel

Все суперинтерфейсы:: AutoCloseable, Channel, Closeable, WritableByteChannel

Все известные реализующие классы:: DatagramChannel, FileChannel, Pipe.SinkChannel, SocketChannel

public interface GatheringByteChannel extends WritableByteChannel

Канал, который может записывать байты из последовательности буферов.

Операция записи собирания записывает, в одном вызове, последовательность байтов из одного или нескольких буферов из заданной последовательности. Собирающие записи часто полезны при реализации сетевых протоколов или форматов файлов, которые, например, группируют данные в сегменты, состоящие из одного или нескольких заголовков фиксированной длины, за которыми следует тело переменной длины. Аналогичные операции чтения разброса определены в интерфейсе ScatteringByteChannel.

С:: 1.4

Краткое описание методов

Модификатор и тип	Метод	Описание
`long`	`write(ByteBuffer[] srcs)`	Записывает последовательность байтов в этот канал из заданных буферов.
`long`	`write(ByteBuffer[] srcs, int offset, int length)`	Записывает последовательность байтов в этот канал из подпоследовательности заданных буферов.

Методы, объявленные в интерфейсе java.nio.channels.Channel

close, isOpen

Методы, объявленные в интерфейсе java.nio.channels.WritableByteChannel

write

Подробное описание методов

write

long write(ByteBuffer[] srcs, int offset, int length) throws IOException

Записывает последовательность байтов в этот канал из подпоследовательности заданных буферов.

Производится попытка записать до r байтов в этот канал, где r — общее количество оставшихся байтов в указанной подпоследовательности массива буферов, то есть,

    srcs[offset].remaining()
        + srcs[offset+1].remaining()
        + ... + srcs[offset+length-1].remaining()

в момент вызова этого метода.

Предположим, что записана последовательность байтов длиной n, где 0 <= n <= r. До первых srcs[offset].remaining() байтов этой последовательности записываются из буфера srcs[offset], до последующих srcs[offset+1].remaining() байтов записываются из буфера srcs[offset+1] и так далее, пока вся последовательность байтов не будет записана. Максимальное количество байтов записывается из каждого буфера, поэтому конечная позиция каждого обновлённого буфера, кроме последнего обновлённого буфера, гарантированно равна пределу этого буфера.

Если не указано иное, операция записи завершится только после записи всех запрошенных r байтов. Некоторые типы каналов в зависимости от своего состояния могут записать только некоторые байты или, возможно, вообще не запишут. Например, сокет-канал в режиме, не блокирующем, не может записать больше байтов, чем свободно в выходном буфере сокета.

Этот метод может быть вызван в любое время. Однако, если другой поток уже инициировал операцию записи в этот канал, вызов этого метода заблокируется до завершения первой операции.

Параметры:: srcs - Буферы, из которых необходимо извлечь байты; offset - Смещение в массиве буферов первого буфера, из которого необходимо извлечь байты; должно быть неотрицательным и не больше srcs.length; length - Максимальное количество доступных буферов; должно быть неотрицательным и не больше srcs.length - offset
Возвращает:: Количество записанных байтов, возможно ноль
Исключения:: IndexOutOfBoundsException - Если условия на offset и length параметры не соблюдаются; NonWritableChannelException - Если этот канал не был открыт для записи; ClosedChannelException - Если этот канал закрыт; AsynchronousCloseException - Если другой поток закрывает этот канал во время выполнения операции записи; ClosedByInterruptException - Если другой поток прерывает текущий поток во время выполнения операции записи, тем самым закрывая канал и устанавливая состояние прерывания текущего потока; IOException - Если произошла другая ошибка ввода-вывода

write

long write(ByteBuffer[] srcs) throws IOException

Записывает последовательность байтов в этот канал из заданных буферов.

Вызов этого метода в форме c.write(srcs) ведет себя точно так же, как вызов

    c.write(srcs, 0, srcs.length);

Параметры:: srcs - Буферы, из которых необходимо извлечь байты
Возвращает:: Количество записанных байтов, возможно ноль
Исключения:: NonWritableChannelException - Если этот канал не был открыт для записи; ClosedChannelException - Если этот канал закрыт; AsynchronousCloseException - Если другой поток закрывает этот канал во время выполнения операции записи; ClosedByInterruptException - Если другой поток прерывает текущий поток во время выполнения операции записи, тем самым закрывая канал и устанавливая состояние прерывания текущего потока; IOException - Если произошла другая ошибка ввода-вывода

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://download.java.net/java/early_access/jdk24/docs/api/java.base/java/nio/channels/GatheringByteChannel.html