Класс AsynchronousServerSocketChannel

java.lang.Object

java.nio.channels.AsynchronousServerSocketChannel

Все реализованные интерфейсы:: Closeable, AutoCloseable, AsynchronousChannel, Channel, NetworkChannel

public abstract class AsynchronousServerSocketChannel extends Object implements AsynchronousChannel, NetworkChannel

Асинхронный канал для сокетов потокового типа для прослушивания.

Асинхронный канал серверного сокета создается вызовом метода open этого класса. Недавно созданный асинхронный канал серверного сокета открыт, но еще не привязан. Его можно привязать к локальному адресу и настроить для прослушивания подключений, вызвав метод bind. После привязки метод accept используется для инициирования приема подключений к сокету канала. Попытка вызвать метод accept на не привязанном канале приведет к возбуждению NotYetBoundException.

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

Параметры сокета настраиваются с помощью метода setOption. Каналы этого типа поддерживают следующие параметры:

Параметры сокета

Имя параметра Описание

SO_RCVBUF Размер буфера приема сокета

SO_REUSEADDR Повторное использование адреса

Параметры сокета
Имя параметра	Описание
`SO_RCVBUF`	Размер буфера приема сокета
`SO_REUSEADDR`	Повторное использование адреса

Дополнительные (специфичные для реализации) параметры также могут быть поддерживаемы.

Пример использования:

 final AsynchronousServerSocketChannel listener =
     AsynchronousServerSocketChannel.open().bind(new InetSocketAddress(5000));

 listener.accept(null, new CompletionHandler<AsynchronousSocketChannel,Void>() {
     public void completed(AsynchronousSocketChannel ch, Void att) {
         // accept the next connection
         listener.accept(null, this);

         // handle this connection
         handle(ch);
     }
     public void failed(Throwable exc, Void att) {
         ...
     }
 });

С:: 1.7

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

AsynchronousServerSocketChannel(AsynchronousChannelProvider provider)

Модификатор	Конструктор	Описание
`protected`	Инициализирует новый экземпляр этого класса.

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

Модификатор и тип	Метод	Описание
`abstract Future<AsynchronousSocketChannel>`	`accept()`	Принимает подключение.
`abstract <A> void`	`accept(A attachment, CompletionHandler<AsynchronousSocketChannel, ? super A> handler)`	Принимает подключение.
`final AsynchronousServerSocketChannel`	`bind(SocketAddress local)`	Привязывает сокет канала к локальному адресу и настраивает сокет для прослушивания подключений.
`abstract AsynchronousServerSocketChannel`	`bind(SocketAddress local, int backlog)`	Привязывает сокет канала к локальному адресу и настраивает сокет для прослушивания подключений.
`abstract SocketAddress`	`getLocalAddress()`	Возвращает адрес сокета, к которому привязан сокет этого канала.
`static AsynchronousServerSocketChannel`	`open()`	Открывает асинхронный канал серверного сокета.
`static AsynchronousServerSocketChannel`	`open(AsynchronousChannelGroup group)`	Открывает асинхронный канал серверного сокета.
`final AsynchronousChannelProvider`	`provider()`	Возвращает поставщика, который создал этот канал.
`abstract <T> AsynchronousServerSocketChannel`	`setOption(SocketOption<T> name, T value)`	Устанавливает значение параметра сокета.

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

close

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

isOpen

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

getOption, supportedOptions

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

AsynchronousServerSocketChannel

protected AsynchronousServerSocketChannel(AsynchronousChannelProvider provider)

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

Параметры:: provider - Предоставление, создавшее этот канал

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

provider

public final AsynchronousChannelProvider provider()

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

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

open

public static AsynchronousServerSocketChannel open(AsynchronousChannelGroup group) throws IOException

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

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

Параметры:: group - Группа, к которой должен быть привязан вновь созданный канал, или null для группы по умолчанию
Возвращает:: Новый асинхронный канал серверных сокетов
Исключения:: ShutdownChannelGroupException - Если группа каналов закрыта; IOException - Если произошла ошибка ввода-вывода

open

public static AsynchronousServerSocketChannel open() throws IOException

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

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

    open((AsynchronousChannelGroup)null);

Возвращает:: Новый асинхронный канал серверных сокетов
Исключения:: IOException - Если произошла ошибка ввода-вывода

bind

public final AsynchronousServerSocketChannel bind(SocketAddress local) throws IOException

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

Вызов этого метода эквивалентен следующему:

    bind(local, 0);

Определено в:

bind в интерфейсе NetworkChannel

Параметры:

local - Локальный адрес для привязки сокета, или null для привязки к автоматически назначенному адресу сокета

Возвращает:

Этот канал

Исключения:

AlreadyBoundException - Если сокет уже привязан

UnsupportedAddressTypeException - Если тип заданного адреса не поддерживается

ClosedChannelException - Если канал закрыт

IOException - Если произошла другая ошибка ввода-вывода

См. также:

bind

public abstract AsynchronousServerSocketChannel bind(SocketAddress local, int backlog) throws IOException

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

Этот метод используется для установления ассоциации между сокетом и локальным адресом. После установления ассоциации сокет остаётся привязанным до закрытия связанного канала.

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

Параметры:: local - Локальный адрес для привязки сокета, или null для привязки к автоматически назначенному адресу сокета; backlog - Максимальное количество ожидающих подключений
Возвращает:: Этот канал
Исключения:: AlreadyBoundException - Если сокет уже привязан; UnsupportedAddressTypeException - Если тип заданного адреса не поддерживается; ClosedChannelException - Если канал закрыт; IOException - Если произошла другая ошибка ввода-вывода

setOption

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

Описание скопировано из интерфейса: NetworkChannel

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

Определено в:

setOption в интерфейсе NetworkChannel

Параметры типа:

T - Тип значения параметра сокета

Параметры:

name - Параметр сокета

value - Значение параметра сокета. Значение null может быть допустимым для некоторых параметров сокета.

Возвращает:

Этот канал

Исключения:

IllegalArgumentException - Если значение не является допустимым значением для этого параметра сокета

ClosedChannelException - Если этот канал закрыт

IOException - Если произошла ошибка ввода-вывода

См. также:

accept

public abstract <A> void accept(A attachment, CompletionHandler<AsynchronousSocketChannel, ? super A> handler)

Принимает подключение.

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

При принятии нового подключения результирующий AsynchronousSocketChannel будет привязан к той же AsynchronousChannelGroup, что и этот канал. Если группа shutdown, и подключение принято, то подключение закрывается, а операция завершается с IOException и причиной ShutdownChannelGroupException.

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

Параметры типа:: A - Тип привязки
Параметры:: attachment - Объект, привязываемый к операции ввода-вывода; может быть null; handler - Обработчик для обработки результата
Исключения:: AcceptPendingException - Если на этом канале уже выполняется операция принятия; NotYetBoundException - Если сокет этого канала ещё не привязан; ShutdownChannelGroupException - Если группа каналов завершена

accept

public abstract Future<AsynchronousSocketChannel> accept()

Принимает подключение.

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

Возвращает:: объект Future, представляющий ожидаемый результат
Исключения:: AcceptPendingException - Если на этом канале уже выполняется операция принятия; NotYetBoundException - Если сокет этого канала ещё не привязан

getLocalAddress

public abstract SocketAddress getLocalAddress() throws IOException

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

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

Определено в:: getLocalAddress в интерфейсе NetworkChannel
Возвращает:: SocketAddress, к которому привязан сокет; null если сокет канала не привязан
Исключения:: ClosedChannelException - Если канал закрыт; 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/AsynchronousServerSocketChannel.html