Класс AsynchronousSocketChannel

protected AsynchronousSocketChannel(AsynchronousChannelProvider provider)

Инициализирует новый экземпляр этого класса.

public final AsynchronousChannelProvider provider()

Возвращает поставщика, который создал этот канал.

public static AsynchronousSocketChannel open(AsynchronousChannelGroup group) throws IOException

Открывает асинхронный сокет-канал.

Новый канал создаётся путём вызова метода openAsynchronousSocketChannel в поставщике AsynchronousChannelProvider, который создал группу. Если параметр группы null , то результирующий канал создаётся системным поставщиком по умолчанию и привязан к группе по умолчанию.

public static AsynchronousSocketChannel open() throws IOException

Открывает асинхронный сокет-канал.

Этот метод возвращает асинхронный сокет-канал, который привязан к группе по умолчанию. Этот метод эквивалентен вычислению выражения:

 open((AsynchronousChannelGroup)null);
 

public abstract AsynchronousSocketChannel bind(SocketAddress local) throws IOException

Привязывает сокет канала к локальному адресу.

Этот метод используется для установления связи между сокетом и локальным адресом. После установления связи сокет остаётся привязанным до закрытия канала. Если параметр local имеет значение null, то сокет будет привязан к автоматически назначенному адресу.

public abstract <T> AsynchronousSocketChannel setOption(SocketOption<T> name, T value) throws IOException

Устанавливает значение параметра сокета.

public abstract AsynchronousSocketChannel shutdownInput() throws IOException

Закрывает подключение для чтения без закрытия канала.

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

public abstract AsynchronousSocketChannel shutdownOutput() throws IOException

Закрывает подключение для записи без закрытия канала.

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

public abstract SocketAddress getRemoteAddress() throws IOException

Возвращает удалённый адрес, к которому подключен сокет этого канала.

Если канал привязан и подключен к адресу сокета интернет-протокола, то значение, возвращаемое этим методом, имеет тип InetSocketAddress.

public abstract <A> void connect(SocketAddress remote, A attachment, CompletionHandler<Void,? super A> handler)

Подключает этот канал.

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

Этот метод выполняет точно такие же проверки безопасности, как и класс Socket. То есть, если установлен менеджер безопасности, этот метод проверяет, позволяет ли его метод checkConnect подключиться к адресу и номеру порта указанного удаленного узла.

public abstract Future<Void> connect(SocketAddress remote)

Подключает этот канал.

Этот метод инициирует операцию подключения к этому каналу. Этот метод ведет себя точно так же, как метод connect(SocketAddress, Object, CompletionHandler), за исключением того, что вместо указания обработчика завершения этот метод возвращает объект Future, представляющий ожидаемый результат. Метод get объекта Future возвращает null при успешном завершении.

public abstract <A> void read(ByteBuffer dst, long timeout, TimeUnit unit, A attachment, CompletionHandler<Integer,? super A> handler)

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

Этот метод инициирует асинхронную операцию чтения последовательности байтов из этого канала в заданный буфер. Параметр handler — это обработчик завершения, который вызывается при завершении (или ошибке) операции чтения. Результат, переданный обработчику завершения, — это количество считанных байтов или -1 , если байты не могли быть прочитаны из-за достижения конца потока канала.

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

В противном случае этот метод работает аналогично методу AsynchronousByteChannel.read(ByteBuffer,Object,CompletionHandler).

public final <A> void read(ByteBuffer dst, A attachment, CompletionHandler<Integer,? super A> handler)

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

Этот метод инициирует асинхронную операцию чтения последовательности байтов из этого канала в заданный буфер. Параметр handler — это обработчик завершения, который вызывается при завершении (или ошибке) операции чтения. Результат, передаваемый обработчику завершения, — это количество считанных байтов или -1 , если байты не могли быть прочитаны из-за достижения конца потока канала.

Операция чтения может прочитать до r байтов из канала, где r — количество байтов, оставшихся в буфере, то есть dst.remaining() в момент попытки чтения. Если r равно 0, операция чтения завершается немедленно с результатом 0 без запуска операции ввода-вывода.

Предположим, что прочитана последовательность байтов длиной n, где 0 < n <= r. Эта последовательность байтов будет перенесена в буфер таким образом, что первый байт в последовательности будет по индексу p, а последний — по индексу p + n - 1, где p — позиция буфера в момент выполнения чтения. После завершения позиция буфера будет равна p + n; его предел не изменится.

Буферы не предназначены для одновременного использования несколькими потоками, поэтому следует позаботиться о том, чтобы не обращаться к буферу до завершения операции.

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

public abstract Future<Integer> read(ByteBuffer dst)

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

Этот метод инициирует асинхронную операцию чтения последовательности байтов из этого канала в заданный буфер. Метод работает точно так же, как метод read(ByteBuffer,Object,CompletionHandler), за исключением того, что вместо указания обработчика завершения этот метод возвращает Future , представляющий ожидаемый результат. Метод get Future возвращает количество считанных байтов или -1 , если байты не могли быть прочитаны из-за достижения конца потока канала.

public abstract <A> void read(ByteBuffer[] dsts, int offset, int length, long timeout, TimeUnit unit, A attachment, CompletionHandler<Long,? super A> handler)

Считывает последовательность байтов из этого канала в подпоследовательность заданных буферов. Эта операция, иногда называемая рассеивающим чтением, часто полезна при реализации сетевых протоколов, группирующих данные в сегменты, состоящие из одного или нескольких заголовков фиксированной длины и тела переменной длины. Параметр handler — это обработчик завершения, который вызывается при завершении (или ошибке) операции чтения. Результат, передаваемый обработчику завершения, — это количество считанных байтов или -1 , если байты не могли быть прочитаны из-за достижения конца потока канала.

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

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

в момент попытки чтения.

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

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

public abstract <A> void write(ByteBuffer src, long timeout, TimeUnit unit, A attachment, CompletionHandler<Integer,? super A> handler)

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

Этот метод инициирует асинхронную операцию записи, чтобы записать последовательность байтов в этот канал из заданного буфера. Параметр handler — обработчик завершения, который вызывается при завершении (или ошибке) операции записи. Результат, передаваемый обработчику завершения, — количество записанных байтов.

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

В противном случае этот метод работает аналогично методу AsynchronousByteChannel.write(ByteBuffer,Object,CompletionHandler).

public final <A> void write(ByteBuffer src, A attachment, CompletionHandler<Integer,? super A> handler)

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

Этот метод инициирует асинхронную операцию записи, чтобы записать последовательность байтов в этот канал из заданного буфера. Параметр handler — обработчик завершения, который вызывается при завершении (или ошибке) операции записи. Результат, передаваемый обработчику завершения, — количество записанных байтов.

Операция записи может записать до r байтов в канал, где r — количество оставшихся байтов в буфере, то есть, src.remaining() в момент попытки записи. Если r равно 0, операция записи завершается немедленно с результатом 0 без запуска операции ввода-вывода.

Предположим, что записана последовательность байтов длиной n, где 0 < n <= r. Эта последовательность байтов будет передана из буфера, начиная с индекса p, где p — положение буфера в момент выполнения записи; индекс последнего записанного байта будет p + n - 1. После завершения положение буфера будет равно p + n; его предел не изменится.

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

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

public abstract Future<Integer> write(ByteBuffer src)

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

Этот метод инициирует асинхронную операцию записи, чтобы записать последовательность байтов в этот канал из заданного буфера. Метод ведет себя точно так же, как метод write(ByteBuffer,Object,CompletionHandler), за исключением того, что вместо указания обработчика завершения этот метод возвращает Future, представляющий ожидаемый результат. Метод get Future возвращает количество записанных байтов.

public abstract <A> void write(ByteBuffer[] srcs, int offset, int length, long timeout, TimeUnit unit, A attachment, CompletionHandler<Long,? super A> handler)

Записывает последовательность байтов в этот канал из подпоследовательности заданных буферов. Эта операция, иногда называемая «сборной записью», часто полезна при реализации сетевых протоколов, которые группируют данные в сегменты, состоящие из одного или нескольких заголовков фиксированной длины, за которыми следует тело переменной длины. Параметр handler — обработчик завершения, который вызывается при завершении (или ошибке) операции записи. Результат, передаваемый обработчику завершения, — количество записанных байтов.

Этот метод инициирует запись до 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], и так далее, пока вся последовательность не будет записана. Максимальное количество байтов записывается из каждого буфера, следовательно, окончательное положение каждого обновлённого буфера, кроме последнего обновлённого буфера, гарантируется равным пределу этого буфера. Подлежащая операционная система может накладывать ограничение на количество буферов, которые могут быть использованы в операции ввода-вывода. Если количество буферов (с оставшимися байтами) превышает это ограничение, то операция ввода-вывода выполняется с максимальным количеством буферов, разрешённым операционной системой.

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

public abstract SocketAddress getLocalAddress() throws IOException

Возвращает адрес сокета, к которому привязан сокет данного канала.

Если канал bound к адресу сокета Интернет-протокола, то возвращаемое значение этого метода имеет тип InetSocketAddress.

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