Класс ServerSocket

protected ServerSocket(SocketImpl impl)

Создаёт сокет сервера с указанным SocketImpl.

public ServerSocket() throws IOException

Создаёт незакреплённый сокет сервера.

public ServerSocket(int port) throws IOException

Создаёт сокет сервера, привязанный к указанному порту. Номер порта 0 означает, что номер порта будет автоматически назначен, обычно из диапазона временных портов. Этот номер порта можно затем получить, вызвав getLocalPort.

Максимальная длина очереди для входящих соединений (запрос на подключение) установлена в 50. Если входящее соединение поступает, когда очередь заполнена, соединение отклоняется.

Если приложение указало фабрику реализации сокета сервера, метод createSocketImpl этой фабрики вызывается для создания фактической реализации сокета. В противном случае создаётся реализация сокета по умолчанию.

Если существует менеджер безопасности, его метод checkListen вызывается с аргументом port для обеспечения разрешения операции. Это может привести к исключению SecurityException.

public ServerSocket(int port, int backlog) throws IOException

Создаёт сокет сервера и привязывает его к указанному номеру локального порта с заданной очередью ожидающих подключений. Номер порта 0 означает, что номер порта будет автоматически назначен, обычно из диапазона временных портов. Этот номер порта можно затем получить, вызвав getLocalPort.

Максимальная длина очереди для входящих соединений (запрос на подключение) установлена в параметре backlog. Если входящее соединение поступает, когда очередь заполнена, соединение отклоняется.

Если приложение указало фабрику реализации сокета сервера, метод createSocketImpl этой фабрики вызывается для создания фактической реализации сокета. В противном случае создаётся реализация сокета по умолчанию.

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

public ServerSocket(int port, int backlog, InetAddress bindAddr) throws IOException

Создаёт сервер с указанным портом, очередью ожидающих подключений и локальным IP-адресом для привязки. Аргумент bindAddr можно использовать на хосте с несколькими адресами для ServerSocket, который будет принимать запросы на подключение только к одному из его адресов. Если bindAddr равен null, сокет будет принимать соединения по всем локальным адресам. Порт должен быть в диапазоне от 0 до 65535 включительно. Номер порта 0 означает, что номер порта будет автоматически назначен, обычно из диапазона временных портов. Этот номер порта можно затем получить, вызвав getLocalPort.

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

public void bind(SocketAddress endpoint) throws IOException

Привязывает ServerSocket к определённому адресу (IP-адрес и номер порта).

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

public void bind(SocketAddress endpoint, int backlog) throws IOException

Привязывает ServerSocket к определённому адресу (IP-адрес и номер порта).

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

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

public InetAddress getInetAddress()

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

Если сокет был привязан до вызова closed, этот метод продолжит возвращать локальный адрес после закрытия сокета.

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

public int getLocalPort()

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

Если сокет был связан до вызова closed, то этот метод продолжит возвращать номер порта после закрытия сокета.

public SocketAddress getLocalSocketAddress()

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

Если сокет был связан до вызова closed, то этот метод продолжит возвращать адрес конечной точки после закрытия сокета.

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

public Socket accept() throws IOException

Ожидает подключение к этому сокету и принимает его. Метод блокируется, пока не будет установлено подключение.

Этот метод может быть прерван в следующих ситуациях:

1. Сокет связан с ассоциированным ServerSocketChannel. В этом случае прерывание потока, принимающего подключение, закроет базовый канал и вызовет исключение ClosedByInterruptException со статусом прерывания.
2. Сокет использует системную реализацию сокета и виртуальный поток принимает подключение. В этом случае прерывание виртуального потока вызовет его пробуждение и закрытие сокета. Затем этот метод выбросит SocketException со статусом прерывания.

Создается новый сокет s, и если менеджер безопасности существует, вызывается метод checkAccept менеджера безопасности с s.getInetAddress().getHostAddress() и s.getPort() в качестве аргументов для проверки разрешения операции. Это может привести к исключению SecurityException.

protected final void implAccept(Socket s) throws IOException

Подклассы ServerSocket используют этот метод для переопределения accept(), чтобы вернуть свой собственный подкласс сокета. Таким образом, FooServerSocket обычно передаёт в этот метод новый, не связанный FooSocket. После возврата из implAccept FooSocket будет подключен к клиенту.

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

public void close() throws IOException

Закрывает этот сокет. Любой поток, который в данный момент заблокирован в accept(), выбросит исключение SocketException.

Если у этого сокета есть связанный канал, то канал также закрывается.

public ServerSocketChannel getChannel()

Возвращает уникальный объект ServerSocketChannel, связанный с этим сокетом, если таковой есть.

Серверный сокет будет иметь канал только в том случае, если сам канал был создан методом ServerSocketChannel.open.

public boolean isBound()

Возвращает состояние привязки ServerSocket.

Если сокет был связан до закрытия, этот метод продолжит возвращать true после закрытия сокета.

public boolean isClosed()

Возвращает состояние закрытия ServerSocket.

public void setSoTimeout(int timeout) throws SocketException

Включает/выключает SO_TIMEOUT с заданным таймаутом в миллисекундах. При положительном значении таймаута вызов accept() для этого ServerSocket будет блокироваться только на это время. Если таймаут истечёт, генерируется исключение java.net.SocketTimeoutException, хотя ServerSocket всё ещё валиден. Таймаут 0 интерпретируется как бесконечный таймаут. Параметр должен быть включён перед входом в блокирующую операцию, чтобы иметь эффект.

public int getSoTimeout() throws IOException

Получает значение SO_TIMEOUT. 0 означает, что параметр отключен (т.е., таймаут бесконечен).

public void setReuseAddress(boolean on) throws SocketException

Включает/выключает опцию сокета SO_REUSEADDR.

После закрытия TCP-соединения соединение может оставаться в состоянии таймаута в течение некоторого времени после закрытия соединения (обычно это состояние TIME_WAIT или состояние ожидания 2MSL). Для приложений, использующих известный адрес сокета или порт, может быть невозможно привязать сокет к нужному SocketAddress если существует соединение в состоянии таймаута, связанное с адресом сокета или портом.

Включение SO_REUSEADDR перед привязкой сокета с помощью bind(SocketAddress) позволяет привязать сокет даже если предыдущее соединение находится в состоянии таймаута.

При создании ServerSocket начальное значение SO_REUSEADDR не определено. Приложения могут использовать getReuseAddress() для определения начального значения SO_REUSEADDR.

Поведение при включении или выключении SO_REUSEADDR после привязки сокета (см. isBound()) не определено.

public boolean getReuseAddress() throws SocketException

Проверяет, включена ли опция SO_REUSEADDR.

public String toString()

Возвращает адрес и порт реализации сокета в виде String.

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

@Deprecated(since="17") public static void setSocketFactory(SocketImplFactory fac) throws IOException

Устанавливает фабрику реализации серверного сокета для приложения. Фабрику можно задать только один раз.

Когда приложение создаёт новый серверный сокет, вызывается метод createSocketImpl фабрики реализации сокетов для создания фактической реализации сокета.

Передача null в метод — это пустая операция, если фабрика ещё не была установлена.

Если установлен менеджер безопасности, этот метод сначала вызывает метод checkSetFactory менеджера безопасности, чтобы убедиться, что операция разрешена. Это может привести к SecurityException.

public void setReceiveBufferSize(int size) throws SocketException

Устанавливает предлагаемое значение по умолчанию для опции SO_RCVBUF для сокетов, принятых от этого ServerSocket. Фактическое значение, установленное в принятом сокете, должно определяться вызовом Socket.getReceiveBufferSize() после возвращения сокета методом accept().

Значение SO_RCVBUF используется как для установки размера внутреннего буфера приема сокета, так и для установки размера TCP-окна приема, которое рекламируется удалённому узлу.

Можно изменить это значение впоследствии, вызвав Socket.setReceiveBufferSize(int). Однако, если приложение хочет разрешить окно приема больше 64КБ, как определено в RFC1323, то предложенное значение должно быть установлено в ServerSocket до привязки к локальному адресу. Это подразумевает, что ServerSocket должен быть создан с конструктором без аргументов, затем вызван setReceiveBufferSize(), а затем ServerSocket привязывается к адресу с помощью bind().

Отказ от этого не вызовет ошибки, и размер буфера может быть установлен в запрошенное значение, но размер TCP-окна приема в сокетах, принятых от этого ServerSocket, не будет больше 64КБ.

public int getReceiveBufferSize() throws SocketException

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

Обратите внимание, что фактическое значение, установленное в принятом сокете, определяется вызовом Socket.getReceiveBufferSize().

public void setPerformancePreferences(int connectionTime, int latency, int bandwidth)

Устанавливает предпочтения производительности для этого ServerSocket.

Сокеты по умолчанию используют протокол TCP/IP. Некоторые реализации могут предложить альтернативные протоколы, которые имеют разные характеристики производительности по сравнению с TCP/IP. Этот метод позволяет приложению выразить свои предпочтения относительно того, как следует рассматривать эти компромиссы, когда реализация выбирает из доступных протоколов.

Предпочтения производительности описываются тремя целыми числами, значения которых указывают на относительную важность короткого времени подключения, низкой задержки и высокой пропускной способности. Абсолютные значения целых чисел несущественны; для выбора протокола значения просто сравниваются, причём большие значения указывают на более сильные предпочтения. Например, если приложение предпочитает короткое время подключения по сравнению с низкой задержкой и высокой пропускной способностью, то оно может вызвать этот метод со значениями (1, 0, 0). Если приложение предпочитает высокую пропускную способность выше низкой задержки, а низкую задержку выше короткого времени подключения, то оно может вызвать этот метод со значениями (0, 1, 2).

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

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

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

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

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

public Set<SocketOption<?>> supportedOptions()

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