Класс 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, то ServerSocket будет принимать подключения ко всем локальным адресам. Порт должен быть в диапазоне от 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

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

Создается новый сокет 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 в качестве аргументов, чтобы проверить, разрешена ли операция. Если операция не разрешена, возвращается InetAddress, представляющий 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()

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