Класс Socket

public Socket()

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

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

public Socket(Proxy proxy)

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

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

Примеры:

• Socket s = new Socket(Proxy.NO_PROXY); создаст обычный сокет, игнорируя другие настройки прокси.
• Socket s = new Socket(new Proxy(Proxy.Type.SOCKS, new InetSocketAddress("socks.mydom.com", 1080))); создаст сокет, подключающийся через указанный прокси-сервер SOCKS.

protected Socket(SocketImpl impl) throws SocketException

Создаёт неподключённый сокет с заданным SocketImpl.

public Socket(String host, int port) throws UnknownHostException, IOException

Создаёт и подключает сокет к указанному порту на указанном узле.

Если указанный узел — null, это эквивалентно указанию адреса как InetAddress.getByName(null). Другими словами, это эквивалентно указанию адреса локального интерфейса.

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

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

public Socket(InetAddress address, int port) throws IOException

Создаёт и подключает сокет к указанному порту на указанном IP-адресе.

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

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

public Socket(String host, int port, InetAddress localAddr, int localPort) throws IOException

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

Если указанный узел — null, это эквивалентно указанию адреса как InetAddress.getByName(null). Другими словами, это эквивалентно указанию адреса локального интерфейса.

Локальный номер порта zero позволит системе выбрать свободный порт в ходе операции bind.

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

public Socket(InetAddress address, int port, InetAddress localAddr, int localPort) throws IOException

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

Если указанный локальный адрес — null, это эквивалентно указанию адреса как любого локального адреса (см. InetAddress.isAnyLocalAddress()).

Локальный номер порта zero позволит системе выбрать свободный порт в ходе операции bind.

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

@Deprecated public Socket(String host, int port, boolean stream) throws IOException

Создаёт сокет потокового типа и подключает его к указанному номеру порта на указанном узле.

Если указанный узел является null, это эквивалентно указанию адреса как InetAddress.getByName(null). Другими словами, это эквивалентно указанию адреса локального интерфейса.

Если аргумент stream является true, это создаёт сокет потокового типа. Если аргумент stream является false, это создаёт сокет дейтаграммного типа.

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

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

Если используется сокет UDP, параметры сокета, относящиеся к TCP/IP, не будут применяться.

@Deprecated public Socket(InetAddress host, int port, boolean stream) throws IOException

Создаёт сокет и подключает его к указанному номеру порта по указанному IP-адресу.

Если аргумент stream является true, это создаёт сокет потокового типа. Если аргумент stream является false, это создаёт сокет дейтаграммного типа.

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

Если установлен менеджер безопасности, его метод checkConnect вызывается с host.getHostAddress() и port в качестве аргументов. Это может привести к исключению SecurityException.

Если используется сокет UDP, параметры сокета, относящиеся к TCP/IP, не будут применяться.

public void connect(SocketAddress endpoint) throws IOException

Подключает этот сокет к серверу.

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

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

public void connect(SocketAddress endpoint, int timeout) throws IOException

Подключает этот сокет к серверу со значением таймаута. Значение таймаута 0 интерпретируется как бесконечный таймаут. Подключение будет блокироваться до тех пор, пока не будет установлено или не произойдёт ошибка.

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

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

public void bind(SocketAddress bindpoint) throws IOException

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

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

public InetAddress getInetAddress()

Возвращает адрес, к которому подключен сокет.

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

public InetAddress getLocalAddress()

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

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

public int getPort()

Возвращает удалённый номер порта, к которому подключен этот сокет.

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

public int getLocalPort()

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

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

public SocketAddress getRemoteSocketAddress()

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

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

public SocketAddress getLocalSocketAddress()

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

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

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

public SocketChannel getChannel()

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

У сокета будет канал, если и только если сам канал был создан с помощью методов SocketChannel.open или ServerSocketChannel.accept.

public InputStream getInputStream() throws IOException

Возвращает поток ввода для этого сокета.

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

Чтение из потока ввода может быть прервано в следующих случаях:

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

В аномальных условиях подлежащее соединение может быть разорвано удалённым хостом или сетевым программным обеспечением (например, сброс соединения в случае TCP-соединений). Когда сетевое программное обеспечение обнаруживает разорванное соединение, для возвращаемого потока ввода применимо следующее:

• Сетевое программное обеспечение может отбросить байты, которые буферизируются сокетом. Байты, которые не отбрасываются сетевым программным обеспечением, могут быть прочитаны с помощью read.

• Если байты не буферизированы в сокете или все буферизованные байты были извлечены с помощью read, все последующие вызовы read сгенерируют IOException.

• Если байты не буферизированы в сокете, и сокет не был закрыт с помощью close, то available вернёт 0.

Закрытие возвращаемого InputStream закроет ассоциированный сокет.

public OutputStream getOutputStream() throws IOException

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

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

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

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

Закрытие возвращаемого OutputStream закроет ассоциированный сокет.

public void setTcpNoDelay(boolean on) throws SocketException

Включает/выключает TCP_NODELAY (отключает/включает алгоритм Нагла).

public boolean getTcpNoDelay() throws SocketException

Проверяет, включен ли TCP_NODELAY.

public void setSoLinger(boolean on, int linger) throws SocketException

Включает/выключает SO_LINGER с указанным временем ожидания в секундах. Максимальное значение времени ожидания зависит от платформы. Настройка влияет только на закрытие сокета.

public int getSoLinger() throws SocketException

Возвращает настройку для SO_LINGER. -1 означает, что опция отключена. Настройка влияет только на закрытие сокета.

public void sendUrgentData(int data) throws IOException

Отправка одного байта срочных данных по сокету. Байтом, который будет отправлен, являются нижние восемь бит параметра data. Срочный байт отправляется после любых предшествующих записей в OutputStream сокета и перед любыми будущими записями в OutputStream.

public void setOOBInline(boolean on) throws SocketException

Включение/выключение SO_OOBINLINE (приём срочных данных TCP). По умолчанию этот параметр выключен, и срочные данные TCP, полученные по сокету, игнорируются. Если пользователь хочет получать срочные данные, то этот параметр должен быть включён. При включении срочные данные принимаются вместе с обычными данными.

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

public boolean getOOBInline() throws SocketException

Проверка, включен ли SO_OOBINLINE.

public void setSoTimeout(int timeout) throws SocketException

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

public int getSoTimeout() throws SocketException

Возвращает значение для SO_TIMEOUT. Возвращаемое значение 0 подразумевает, что параметр отключён (т. е. таймаут бесконечен).

public void setSendBufferSize(int size) throws SocketException

Устанавливает параметр SO_SNDBUF для данного Socket со значением указанного значения. Параметр SO_SNDBUF используется кодом сетевого стека платформы в качестве подсказки для размера буфера сети.

Поскольку SO_SNDBUF — это подсказка, приложения, которые хотят проверить, какой размер был установлен для буферов, должны вызвать getSendBufferSize().

public int getSendBufferSize() throws SocketException

Получение значения параметра SO_SNDBUF для этого Socket, то есть размер буфера, используемого платформой для вывода в этот Socket.

public void setReceiveBufferSize(int size) throws SocketException

Устанавливает параметр SO_RCVBUF для данного Socket со значением указанного значения. Параметр SO_RCVBUF используется кодом сетевого стека платформы в качестве подсказки для размера буфера сети.

Увеличение размера буфера приёма может повысить производительность сетевого ввода-вывода для высоконагруженных соединений, а уменьшение — помочь уменьшить очередь входящих данных.

Поскольку SO_RCVBUF — это подсказка, приложения, которые хотят проверить, какой размер был установлен для буферов, должны вызвать getReceiveBufferSize().

Значение SO_RCVBUF также используется для установки TCP-окна приёма, которое объявляется удалённому узлу. Обычно размер окна можно изменять в любое время, когда сокет подключён. Однако, если требуется окно приёма, большее 64K, то это должно быть запрошено **до** подключения сокета к удалённому узлу. Есть два случая, о которых следует помнить:

1. Для сокетов, принятых от ServerSocket, это необходимо сделать, вызвав ServerSocket.setReceiveBufferSize(int) перед привязкой ServerSocket к локальному адресу.
2. Для клиентских сокетов, setReceiveBufferSize() необходимо вызвать перед подключением сокета к его удалённому узлу.

public int getReceiveBufferSize() throws SocketException

Получение значения параметра SO_RCVBUF для этого Socket, то есть размер буфера, используемого платформой для ввода в этот Socket.

public void setKeepAlive(boolean on) throws SocketException

Включение/выключение SO_KEEPALIVE.

public boolean getKeepAlive() throws SocketException

Проверка, включен ли SO_KEEPALIVE.

public void setTrafficClass(int tc) throws SocketException

Устанавливает класс трафика или байт типа службы в заголовке IP для пакетов, отправляемых из этого сокета. Поскольку реализация базовой сети может игнорировать это значение, приложения должны рассматривать его как подсказку.

Значение tc должно находиться в диапазоне 0 <= tc <= 255, иначе будет брошено исключение IllegalArgumentException.

Примечания:

Для протокола Интернета версии 4 значение состоит из integer, наименее значащие 8 бит которого представляют значение байта TOS в пакетах IP, отправляемых сокетом. RFC 1349 определяет значения TOS следующим образом:

• IPTOS_LOWCOST (0x02)
• IPTOS_RELIABILITY (0x04)
• IPTOS_THROUGHPUT (0x08)
• IPTOS_LOWDELAY (0x10)

Последний бит младшего порядка всегда игнорируется, так как это соответствует биту MBZ (должен быть ноль).

Установка битов в поле приоритета может привести к исключению SocketException, указывающему, что операция не разрешена.

Как указывает RFC 1122, раздел 4.2.4.2, совместимая реализация TCP должна, но не обязана, позволять приложению изменять поле TOS в течение срока действия соединения. Таким образом, может ли поле типа службы быть изменено после установления TCP-соединения, зависит от реализации на базовой платформе. Приложения не должны предполагать, что они могут изменить поле TOS после подключения.

Для протокола Интернета версии 6 tc — это значение, которое будет помещено в поле sin6_flowinfo заголовка IP.

public int getTrafficClass() throws SocketException

Получает класс трафика или байт типа службы в заголовке IP для пакетов, отправляемых из этого сокета

Поскольку реализация базовой сети может игнорировать класс трафика или тип службы, установленный с помощью setTrafficClass(int), этот метод может вернуть значение, отличное от ранее установленного с помощью метода setTrafficClass(int) в этом сокете.

public void setReuseAddress(boolean on) throws SocketException

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

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

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

При создании Socket начальное значение SO_REUSEADDR отключено.

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

public boolean getReuseAddress() throws SocketException

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

public void close() throws IOException

Закрывает этот сокет.

Любой поток, который в данный момент заблокирован в операции ввода-вывода над этим сокетом, сгенерирует исключение SocketException.

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

Закрытие этого сокета также закроет сокетные InputStream и OutputStream.

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

public void shutdownInput() throws IOException

Устанавливает входной поток этого сокета в "конец потока". Любые данные, отправленные на входную сторону сокета, подтверждаются, а затем молча отбрасываются.

Если вы считываете данные из входного потока сокета после вызова этого метода для сокета, метод available потока вернет 0, а методы read вернут -1 (конец потока).

public void shutdownOutput() throws IOException

Отключает выходной поток для этого сокета. Для TCP-сокета любые предварительно записанные данные будут отправлены, за которыми следует обычная последовательность завершения соединения TCP. Если вы записываете данные в выходной поток сокета после вызова shutdownOutput() для сокета, поток сгенерирует исключение IOException.

public String toString()

Преобразует этот сокет в String.

public boolean isConnected()

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

Примечание: закрытие сокета не очищает его состояние соединения, что означает, что этот метод вернет true для закрытого сокета (см. isClosed()), если он был успешно подключен до закрытия.

public boolean isBound()

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

Примечание: закрытие сокета не очищает его состояние привязки, что означает, что этот метод вернет true для закрытого сокета (см. isClosed()), если он был успешно привязан до закрытия.

public boolean isClosed()

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

public boolean isInputShutdown()

Возвращает, закрыта ли сторона чтения соединения сокета.

public boolean isOutputShutdown()

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

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

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

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

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

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

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

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

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

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

Вызов этого метода после подключения данного сокета не окажет никакого влияния.

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

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

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

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

public Set<SocketOption<?>> supportedOptions()

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