Класс 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 , это эквивалентно указанию адреса как адреса AnyLocal (см. 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

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

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

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

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.

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

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

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

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

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

public OutputStream getOutputStream() throws IOException

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

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

Закрытие возвращаемого 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 и перед любыми будущими записями в поток вывода.

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-окна приема, которое объявляется удалённому узлу. Как правило, размер окна можно изменять в любое время, когда сокет подключен. Однако, если требуется окно приема больше 64 Кб, это необходимо запросить **до** подключения сокета к удалённому узлу. Есть два случая:

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.

Примечания:

Для Internet Protocol v4 значение состоит из 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 после подключения.

Для Internet Protocol v6 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) позволяет привязать сокет, даже если предыдущее соединение находится в состоянии таймаута.

При создании сокета начальное значение 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()

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