Класс ServerSocketChannel

java.nio.channels.ServerSocketChannel

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

public abstract class ServerSocketChannel extends AbstractSelectableChannel implements NetworkChannel

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

Серверный сокет-канал создается путём вызова одного из методов open этого класса. Метод open без аргументов открывает серверный сокет-канал для сокета протокола Интернета. Метод open(ProtocolFamily) используется для открытия серверного сокета-канала для сокета указанной семейства протоколов. Невозможно создать канал для произвольного, предварительно существующего сокета. Недавно созданный серверный сокет-канал открыт, но ещё не привязан. Попытка вызвать метод accept не привязанного серверного сокета-канала приведёт к выбрасыванию исключения NotYetBoundException. Серверный сокет-канал можно привязать, вызвав один из методов bind, определённых в этом классе.

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

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

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

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

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

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

Серверные сокет-каналы для сокетов домен Unix поддерживают:

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

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

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

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

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

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

С момента:: 1.4

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

ServerSocketChannel(SelectorProvider provider)

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

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

Модификатор и тип	Метод	Описание
`abstract SocketChannel`	`accept()`	Принимает подключение, выполненное к сокету этого канала.
`final ServerSocketChannel`	`bind(SocketAddress local)`	Привязывает сокет канала к локальному адресу и настраивает сокет для прослушивания подключений.
`abstract ServerSocketChannel`	`bind(SocketAddress local, int backlog)`	Привязывает сокет канала к локальному адресу и настраивает сокет для прослушивания подключений.
`abstract SocketAddress`	`getLocalAddress()`	Возвращает адрес сокета, к которому привязан сокет этого канала.
`static ServerSocketChannel`	`open()`	Открывает серверный сокет-канал для сокета протокола Интернета.
`static ServerSocketChannel`	`open(ProtocolFamily family)`	Открывает серверный сокет-канал.
`abstract <T> ServerSocketChannel`	`setOption(SocketOption<T> name, T value)`	Устанавливает значение параметра сокета.
`abstract ServerSocket`	`socket()`	Возвращает серверный сокет, связанный с этим каналом.
`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

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

getOption, supportedOptions

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

ServerSocketChannel

protected ServerSocketChannel(SelectorProvider provider)

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

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

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

open

public static ServerSocketChannel open() throws IOException

Открывает канал серверного сокета для сокета протокола Интернет.

Новый канал создается вызовом метода openServerSocketChannel системного провайдера SelectorProvider.

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

Возвращает:

Новый канал сокета

Исключения:

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

См. также:

open

public static ServerSocketChannel open(ProtocolFamily family) throws IOException

Открывает канал серверного сокета. Параметр family определяет protocol family сокета канала.

Новый канал создается вызовом метода openServerSocketChannel(ProtocolFamily) системного провайдера SelectorProvider.

Параметры:

family - Семейство протоколов

Возвращает:

Новый канал сокета

Исключения:

UnsupportedOperationException - Если указанное семейство протоколов не поддерживается. Например, если параметр задан как StandardProtocolFamily.INET6, но IPv6 не включен на платформе.

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

С:

См. также:

validOps

public final int validOps()

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

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

Задано в:: validOps в классе SelectableChannel
Возвращает:: Набор допустимых операций

bind

public final ServerSocketChannel bind(SocketAddress local) throws IOException

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

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

    bind(local, 0);

Задано в:

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

Параметры:

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

Возвращает:

Этот канал

Исключения:

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

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

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

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

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

С:

1.7

См. также:

bind

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

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

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

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

Примечание API:: Привязка канала серверного сокета для сокета Unix Domain создает файл, соответствующий пути к файлу в UnixDomainSocketAddress. Этот файл сохраняется после закрытия канала и должен быть удален, прежде чем другой сокет сможет привязаться к тому же имени. Привязка к адресу null приводит к тому, что сокет автоматически привязывается к уникальному временному файлу в системе. Сопутствующий файл сокета также сохраняется после закрытия канала. Его имя можно получить из локального адреса сокета канала.
Примечание реализации:: Каждая платформа применяет максимальную длину имени сокета Unix Domain, зависящую от реализации. Это ограничение применяется при привязке канала. Максимальная длина обычно близка к 100 байтам и не меньше. Это ограничение также применяется к каналам серверных сокетов с автоматической привязкой. См. свойства Unix domain сети, которые могут быть использованы для выбора временной директории, в которой создаются эти сокеты.
Параметры:: local - Адрес для привязки сокета, или null для привязки к автоматически назначенному адресу сокета; backlog - Максимальное количество ожидающих подключений
Возвращает:: Этот канал
Исключения:: AlreadyBoundException - Если сокет уже привязан; UnsupportedAddressTypeException - Если тип заданного адреса не поддерживается; ClosedChannelException - Если этот канал закрыт; IOException - Если произошла другая ошибка ввода-вывода; SecurityException - Если установлен менеджер безопасности и его метод checkListen запрещает операцию для адреса сокета протокола Интернета или для адреса сокета Unix domain, если он запрещает NetPermission("accessUnixDomainSocket").
С:: 1.7

setOption

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

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

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

Задано в:

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

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

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

Параметры:

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

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

Возвращает:

Этот канал

Исключения:

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

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

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

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

С:

1.7

См. также:

socket

public abstract ServerSocket socket()

Извлекает серверный сокет, связанный с этим каналом.

Возвращаемый объект не будет объявлять никаких публичных методов, которые не объявлены в классе ServerSocket.

Возвращает:: Серверный сокет, связанный с этим каналом
Исключения:: UnsupportedOperationException - Если сокет канала не является сокетом протокола Интернет

accept

public abstract SocketChannel accept() throws IOException

Принимает подключение, установленное к сокету этого канала.

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

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

Если связан с адресом сокета протокола Интернета, этот метод выполняет точно такие же проверки безопасности, как метод accept класса ServerSocket. То есть, если установлено управление безопасностью, то для каждого нового подключения этот метод проверяет, разрешены ли адрес и номер порта удалённого конца подключения посредством метода checkAccept управления безопасностью. Если связан с адресом сокета домен Unix, этот метод проверяет NetPermission("accessUnixDomainSocket").

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

getLocalAddress

public abstract SocketAddress getLocalAddress() throws IOException

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

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

Если канал привязан к адресу сокета домена Unix, адрес сокета — это UnixDomainSocketAddress. Если установлено управление безопасностью, его метод checkPermission вызывается с NetPermission("accessUnixDomainSocket"). Если операция не разрешена, возвращается безымянный UnixDomainSocketAddress.

Определено в:: getLocalAddress в интерфейсе NetworkChannel
Возвращает:: Адрес, к которому привязан сокет, или SocketAddress, представляющий адрес обратной связи или пустой путь, если доступ запрещён управлением безопасностью, или null если сокет канала не привязан
Выбрасывает:: ClosedChannelException - Если канал закрыт; IOException - Если произошла ошибка ввода-вывода

© 1993, 2023, 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://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/channels/ServerSocketChannel.html