Spec-Zone.ru › OpenJDK 8

Интерфейс NetworkChannel

Все суперинтерфейсы:
AutoCloseable, Channel, Closeable
Все известные подинтерфейсы:
MulticastChannel
Все известные реализующие классы:
AsynchronousServerSocketChannel, AsynchronousSocketChannel, DatagramChannel, ServerSocketChannel, SocketChannel

public interface NetworkChannel
extends Channel

Канал к сетевому сокету.

Канал, реализующий этот интерфейс, представляет собой канал к сетевому сокету. Метод bind используется для привязки сокета к локальному address, метод getLocalAddress возвращает адрес, к которому привязан сокет, а методы setOption и getOption используются для установки и запроса параметров сокета. Реализация этого интерфейса должна указать поддерживаемые параметры сокета.

Методы bind и setOption, которые не возвращают значение по умолчанию, возвращают сетевой канал, на котором они вызываются. Это позволяет объединять вызовы методов. Реализации этого интерфейса должны специализировать тип возвращаемого значения, чтобы вызовы методов в реализации класса можно было объединять.

С тех пор:
1.7

Методы

Модификатор и тип Метод и описание
NetworkChannel bind(SocketAddress local)

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

SocketAddress getLocalAddress()

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

<T> T getOption(SocketOption<T> name)

Возвращает значение параметра сокета.

<T> NetworkChannel setOption(SocketOption<T> name, T value)

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

Set<SocketOption<?>> supportedOptions()

Возвращает набор поддерживаемых параметром сокета для этого канала.

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

close, isOpen

Методы

bind

NetworkChannel bind(SocketAddress local)
             throws IOException

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

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

Параметры:
local - Адрес для привязки сокета, или null для привязки сокета к автоматически назначенному адресу сокета
Возвращает:
Этот канал
Выбрасывает:
AlreadyBoundException - Если сокет уже привязан
UnsupportedAddressTypeException - Если тип заданного адреса не поддерживается
ClosedChannelException - Если канал закрыт
IOException - Если произошла другая ошибка ввода-вывода
SecurityException - Если установлен менеджер безопасности и он запрещает неопределенное разрешение. Реализация этого интерфейса должна указать необходимые разрешения.
См. также:
getLocalAddress()

getLocalAddress

SocketAddress getLocalAddress()
                       throws IOException

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

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

Возвращает:
Адрес сокета, к которому привязан сокет, или null если сокет канала не привязан
Выбрасывает:
ClosedChannelException - Если канал закрыт
IOException - Если произошла ошибка ввода-вывода

setOption

<T> NetworkChannel setOption(SocketOption<T> name,
                             T value)
                      throws IOException

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

Параметры типа:
T - Тип значения параметра сокета
Параметры:
name - Параметр сокета
value - Значение параметра сокета. Значение null может быть допустимым значением для некоторых параметров сокета.
Возвращает:
Этот канал
Выбрасывает:
UnsupportedOperationException - Если параметр сокета не поддерживается этим каналом
IllegalArgumentException - Если значение не является допустимым значением для этого параметра сокета
ClosedChannelException - Если этот канал закрыт
IOException - Если произошла ошибка ввода-вывода
См. также:
StandardSocketOptions

getOption

<T> T getOption(SocketOption<T> name)
         throws IOException

Возвращает значение параметра сокета.

Параметры типа:
T - Тип значения параметра сокета
Параметры:
name - Параметр сокета
Возвращает:
Значение параметра сокета. Значение null может быть допустимым значением для некоторых параметров сокета.
Выбрасывает:
UnsupportedOperationException - Если параметр сокета не поддерживается этим каналом
ClosedChannelException - Если этот канал закрыт
IOException - Если произошла ошибка ввода-вывода
См. также:
StandardSocketOptions

supportedOptions

Set<SocketOption<?>> supportedOptions()

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

Этот метод будет продолжать возвращать набор параметров даже после закрытия канала.

Возвращает:
Набор параметров сокета, поддерживаемых этим каналом

© 1993, 2020, 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.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API