Класс SctpServerChannel

com.sun.nio.sctp.SctpServerChannel

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

public abstract class SctpServerChannel extends AbstractSelectableChannel

Канальный объект для сокетов SCTP, ориентированных на обмен сообщениями.

Объект SCTPServerChannel создаётся с помощью вызова метода open этого класса. Созданный серверный SCTP-канал открыт, но ещё не привязан. Попытка вызвать метод accept на непривязанном канале приведёт к исключению NotYetBoundException. Привязать серверный SCTP-канал можно, вызвав один из методов bind этого класса.

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

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

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

SCTP_INIT_MAXSTREAMS Максимальное количество потоков, запрашиваемое локальным узлом во время инициализации соединения

Параметры сокета
Имя параметра	Описание
`SCTP_INIT_MAXSTREAMS`	Максимальное количество потоков, запрашиваемое локальным узлом во время инициализации соединения

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

Серверные SCTP-каналы безопасны для одновременного использования в нескольких потоках.

Since:: 1.7

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

SctpServerChannel(SelectorProvider provider)

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

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

Модификатор и тип	Метод	Описание
`abstract SctpChannel`	`accept()`	Принимает соединение (ассоциацию) на сокете этого канала.
`final SctpServerChannel`	`bind(SocketAddress local)`	Привязывает сокет канала к локальному адресу и настраивает его на прослушивание соединений.
`abstract SctpServerChannel`	`bind(SocketAddress local, int backlog)`	Привязывает сокет канала к локальному адресу и настраивает его на прослушивание соединений.
`abstract SctpServerChannel`	`bindAddress(InetAddress address)`	Добавляет указанный адрес к связанным адресам для сокета канала.
`abstract Set<SocketAddress>`	`getAllLocalAddresses()`	Возвращает все адреса сокетов, к которым привязан сокет этого канала.
`abstract <T> T`	`getOption(SctpSocketOption<T> name)`	Возвращает значение параметра сокета.
`static SctpServerChannel`	`open()`	Открывает серверный SCTP-канал.
`abstract <T> SctpServerChannel`	`setOption(SctpSocketOption<T> name, T value)`	Устанавливает значение параметра сокета.
`abstract Set<SctpSocketOption<?>>`	`supportedOptions()`	Возвращает набор параметров сокета, поддерживаемых этим каналом.
`abstract SctpServerChannel`	`unbindAddress(InetAddress address)`	Удаляет указанный адрес из связанных адресов для сокета канала.
`final int`	`validOps()`	Возвращает набор операций, идентифицирующий поддерживаемые этим каналом операции.

Методы, унаследованные от класса java.nio.channels.spi.AbstractSelectableChannel

blockingLock, configureBlocking, implCloseChannel, implCloseSelectableChannel, implConfigureBlocking, isBlocking, isRegistered, keyFor, provider, register

Методы, унаследованные от класса java.nio.channels.SelectableChannel

register

Методы, унаследованные от класса java.nio.channels.spi.AbstractInterruptibleChannel

begin, close, end, isOpen

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

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

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

isOpen

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

SctpServerChannel

protected SctpServerChannel(SelectorProvider provider)

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

Параметры:: provider - Провайдер селектора для этого канала

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

open

public static SctpServerChannel open() throws IOException

Открывает канал сервера SCTP.

Сокет нового канала первоначально не привязан; он должен быть привязан к определённому адресу с помощью одного из методов сокета bind перед тем, как можно будет принимать ассоциации.

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

accept

public abstract SctpChannel accept() throws IOException

Принимает ассоциацию на сокете этого канала.

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

SCTPChannel возвращаемый этим методом, если таковой имеется, будет в режиме блокировки независимо от режима блокировки этого канала.

Возвращает:: Канал SCTP для новой ассоциации или null, если этот канал находится в режиме без блокировки и ассоциация недоступна для принятия
Исключения:: ClosedChannelException - Если этот канал закрыт; AsynchronousCloseException - Если другой поток закрывает этот канал во время выполнения операции accept; ClosedByInterruptException - Если другой поток прерывает текущий поток во время выполнения операции accept, тем самым закрывая канал и устанавливая статус прерывания текущего потока; NotYetBoundException - Если сокет этого канала ещё не привязан; IOException - Если произошла какая-либо другая ошибка ввода-вывода

bind

public final SctpServerChannel bind(SocketAddress local) throws IOException

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

Этот метод работает так, как будто вызов эквивалентен вычислению выражения:

 bind(local, 0);

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

bind

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

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

Этот метод используется для установления связи между сокетом и локальным адресом. После установления связи сокет остаётся привязанным до закрытия канала. Эта связь не обязательно должна быть с адресом local, поскольку она может быть удалена с помощью unbindAddress, но всегда будет хотя бы один локальный адрес, привязанный к сокету канала после успешного завершения вызова этого метода.

После успешной привязки сокета канала к определённому адресу, который не назначается автоматически, к нему могут быть привязаны дополнительные адреса с помощью bindAddress или удалены с помощью unbindAddress.

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

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

bindAddress

public abstract SctpServerChannel bindAddress(InetAddress address) throws IOException

Добавляет заданный адрес к привязанным адресам для сокета канала.

Заданный адрес не должен быть адресом wildcard. Канал должен быть предварительно привязан с помощью bind перед вызовом этого метода, в противном случае будет брошено исключение NotYetBoundException. Метод bind принимает в качестве аргумента SocketAddress, который обычно содержит номер порта и адрес. Адреса, привязанные позднее с помощью этого метода, представляют собой просто адреса, так как номер порта SCTP остаётся неизменным в течение всего срока существования канала.

Новые ассоциации, принятые после успешного завершения этого метода, будут связаны с заданным адресом.

Параметры:: address - Адрес для добавления к привязанным адресам сокета
Возвращает:: Этот канал
Исключения:: ClosedChannelException - Если этот канал закрыт; NotYetBoundException - Если этот канал ещё не привязан; AlreadyBoundException - Если этот канал уже привязан к заданному адресу; IllegalArgumentException - Если адрес является null или адресом wildcard; IOException - Если произошла какая-либо другая ошибка ввода-вывода

unbindAddress

public abstract SctpServerChannel unbindAddress(InetAddress address) throws IOException

Удаляет заданный адрес из привязанных адресов для сокета канала.

Заданный адрес не должен быть адресом wildcard. Канал должен быть предварительно привязан с помощью bind перед вызовом этого метода, в противном случае будет брошено исключение NotYetBoundException. Если этот метод вызывается для канала, который не имеет address в качестве одного из привязанных адресов, или у которого привязано только одно локальное адрес, то этот метод выбрасывает исключение IllegalUnbindException. Начальный адрес, к которому привязан сокет канала с помощью bind, может быть удалён из привязанных адресов для сокета канала.

Новые ассоциации, принятые после успешного завершения этого метода, не будут связаны с заданным адресом.

Параметры:: address - Адрес для удаления из привязанных адресов сокета
Возвращает:: Этот канал
Исключения:: ClosedChannelException - Если этот канал закрыт; NotYetBoundException - Если этот канал ещё не привязан; IllegalArgumentException - Если адрес является null или адресом wildcard; IllegalUnbindException - Если реализация не поддерживает удаление адресов из прослушивающего сокета, address не привязан к сокету канала или у канала привязан только один адрес; IOException - Если произошла какая-либо другая ошибка ввода-вывода

getAllLocalAddresses

public abstract Set<SocketAddress> getAllLocalAddresses() throws IOException

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

Возвращает:: Все адреса сокета, к которым привязан сокет этого канала, или пустой Set, если сокет канала не привязан
Исключения:: ClosedChannelException - Если канал закрыт; IOException - Если произошла ошибка ввода-вывода

getOption

public abstract <T> T getOption(SctpSocketOption<T> name) throws IOException

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

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

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

Параметры:

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

Возвращает:

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

Исключения:

UnsupportedOperationException - Если опция сокета не поддерживается этим каналом

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

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

См. также:

setOption

public abstract <T> SctpServerChannel setOption(SctpSocketOption<T> name, T value) throws IOException

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

Type Parameters:

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

Parameters:

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

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

Returns:

Этот канал

Throws:

UnsupportedOperationException - Если параметр сокета не поддерживается этим каналом

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

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

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

See Also:

supportedOptions

public abstract Set<SctpSocketOption<?>> supportedOptions()

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

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

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

validOps

public final int validOps()

Возвращает набор операций, определяющий поддерживаемые операции этого канала.

Каналы сервера SCTP поддерживают только принятие новых ассоциаций, поэтому этот метод возвращает SelectionKey.OP_ACCEPT.

Specified by:: validOps в классе SelectableChannel
Returns:: Набор допустимых операций

© 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/jdk.sctp/com/sun/nio/sctp/SctpServerChannel.html