java.nio.channels

Класс AsynchronousServerSocketChannel

java.lang. Объект

java.nio.channels.AsynchronousServerSocketChannel

Все Реализованные Интерфейсы:

Closeable, AutoCloseable, AsynchronousChannel, Канал, NetworkChannel

public abstract class AsynchronousServerSocketChannel
extends Object
implements AsynchronousChannel, NetworkChannel

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

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

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

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

Имя опции	Описание
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

Сводка конструктора

Конструкторы

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

Сводка метода

Методы

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

Методы java.lang унаследованный от класса. Объект

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

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

близко

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

getLocalAddress, getOption, supportedOptions

Методы, наследованные от интерфейса java.nio.channels. Канал

isOpen

Деталь конструктора

AsynchronousServerSocketChannel

protected AsynchronousServerSocketChannel(AsynchronousChannelProvider provider)

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

Деталь метода

провайдер

public final AsynchronousChannelProvider provider()

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

открытый

public static AsynchronousServerSocketChannel open(AsynchronousChannelGroup group)
                                            throws IOException

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

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

Параметры:

group - Группа, с которой недавно созданный канал должен быть связан, или null для группы по умолчанию

Возвраты:

Новый асинхронный сервер снабжает канал сокетом

Броски:

ShutdownChannelGroupException - Если группа канала является завершением работы

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

открытый

public static AsynchronousServerSocketChannel open()
                                            throws IOException

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

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

 open((AsynchronousChannelGroup)null);
 

Возвраты:

Новый асинхронный сервер снабжает канал сокетом

Броски:

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

связать

public final AsynchronousServerSocketChannel bind(SocketAddress local)
                                           throws IOException

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

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

 bind(local, 0);
 

Определенный:

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

Параметры:

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

Возвраты:

Этот канал

Броски:

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

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

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

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

IOException - Если некоторая другая ошибка ввода-вывода происходит

См. Также:

NetworkChannel.getLocalAddress()

связать

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

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

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

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

Параметры:

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

backlog - Максимальное количество соединений на ожидании

Возвраты:

Этот канал

Броски:

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

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

SecurityException - Если менеджер безопасности был установлен и checkListen метод отрицает работу

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

IOException - Если некоторая другая ошибка ввода-вывода происходит

setOption

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

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

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

Определенный:

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

Параметры:

name - Опция сокета

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

Возвраты:

Этот канал

Броски:

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

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

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

См. Также:

StandardSocketOptions

принять

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

Принимает соединение.

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

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

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

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

Параметры:

attachment - Объект присоединить к работе ввода-вывода; может быть null

handler - Обработчик для того, чтобы использовать результат

Броски:

AcceptPendingException - Если принять работа уже происходит на этом канале

NotYetBoundException - Если сокет этого канала еще не был связан

ShutdownChannelGroupException - Если группа канала завершилась

принять

public abstract Future<AsynchronousSocketChannel> accept()

Принимает соединение.

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

Возвраты:

a Future объект, представляющий результат на ожидании

Броски:

AcceptPendingException - Если принять работа уже происходит на этом канале

NotYetBoundException - Если сокет этого канала еще не был связан