Класс Socket

public Socket()

Начиная с версии:

1.1

public Socket(Proxy proxy)

Параметры:

proxy — объект Proxy, указывающий, какой тип прокси-сервера следует использовать.

Исключения:

IllegalArgumentException — если прокси-сервер имеет недопустимый тип или null.

Начиная с версии:

1.5

См. также:

• ProxySelector
• Proxy

protected Socket(SocketImpl impl) throws SocketException

Параметры:

impl — экземпляр SocketImpl, который подкласс намерен использовать для сокета.

Исключения:

SocketException — если произошла ошибка нижележащего протокола, например ошибка TCP.

Начиная с версии:

1.1

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

Параметры:

host — имя узла или null для адреса обратной связи.

port — номер порта.

Исключения:

UnknownHostException — если IP-адрес узла не удалось определить.

IOException — если при создании сокета произошла ошибка ввода-вывода.

IllegalArgumentException — если значение параметра порта выходит за указанный допустимый диапазон от 0 до 65535 включительно.

public Socket(InetAddress address, int port) throws IOException

Параметры:

address — IP-адрес.

port — номер порта.

Исключения:

IOException — если при создании сокета произошла ошибка ввода-вывода.

IllegalArgumentException — если значение параметра порта выходит за указанный допустимый диапазон от 0 до 65535 включительно.

NullPointerException — если address имеет значение null.

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

Параметры:

host — имя удаленного узла или null для адреса обратной связи.

port — удаленный порт

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

localPort — локальный порт, к которому привязан сокет, или zero для свободного порта, выбранного системой.

Исключения:

IOException — если при создании сокета произошла ошибка ввода-вывода.

IllegalArgumentException — если значение параметра порта или localPort выходит за указанный допустимый диапазон от 0 до 65535 включительно.

Начиная с версии:

1.1

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

Параметры:

address — удаленный адрес

port — удаленный порт

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

localPort — локальный порт, к которому привязан сокет, или zero для свободного порта, выбранного системой.

Исключения:

IOException — если при создании сокета произошла ошибка ввода-вывода.

IllegalArgumentException — если значение параметра порта или localPort выходит за указанный допустимый диапазон от 0 до 65535 включительно.

NullPointerException — если address имеет значение null.

Начиная с версии:

1.1

@Deprecated(forRemoval=true, since="1.1") public Socket(String host, int port, boolean stream) throws IOException

Параметры:

host — имя узла или null для адреса обратной связи.

port — номер порта.

stream — должно иметь значение true; значение false не допускается.

Исключения:

IOException — если при создании сокета произошла ошибка ввода-вывода.

IllegalArgumentException — если параметр stream имеет значение false или значение параметра порта выходит за указанный допустимый диапазон от 0 до 65535 включительно.

@Deprecated(forRemoval=true, since="1.1") public Socket(InetAddress host, int port, boolean stream) throws IOException

Параметры:

host — IP-адрес.

port — номер порта.

stream — должно иметь значение true; значение false не допускается.

Исключения:

IOException — если при создании сокета произошла ошибка ввода-вывода.

IllegalArgumentException — если параметр stream имеет значение false или значение параметра порта выходит за указанный допустимый диапазон от 0 до 65535 включительно.

NullPointerException — если host имеет значение null.

public void connect(SocketAddress endpoint) throws IOException

Параметры:

endpoint — SocketAddress

Исключения:

IOException — если во время подключения произошла ошибка, сокет уже подключен или сокет закрыт

UnknownHostException — если соединение не удалось установить, поскольку конечная точка представляет собой неразрешенный InetSocketAddress

IllegalBlockingModeException — если с этим сокетом связан канал, работающий в неблокирующем режиме

IllegalArgumentException — если конечная точка имеет значение null или является подклассом SocketAddress, который не поддерживается этим сокетом

Начиная с версии:

1.4

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

Примечание к API:

Установка TCP/IP-соединения зависит от настроек времени ожидания подключения в операционной системе. Типичное время ожидания операционной системы составляет от нескольких десятков секунд до нескольких минут. Если время ожидания операционной системы истекает раньше, чем указанное для этого метода значение timeout, выбрасывается IOException. Указанное для этого метода значение timeout обычно меньше времени ожидания операционной системы.

Параметры:

endpoint — SocketAddress

timeout — используемое время ожидания в миллисекундах.

Исключения:

IOException — если во время подключения произошла ошибка, сокет уже подключен или сокет закрыт

SocketTimeoutException — если время ожидания истекло до установления соединения

UnknownHostException — если соединение не удалось установить, поскольку конечная точка представляет собой неразрешенный InetSocketAddress

IllegalBlockingModeException — если с этим сокетом связан канал, работающий в неблокирующем режиме

IllegalArgumentException — если конечная точка имеет значение null или является подклассом SocketAddress, который не поддерживается этим сокетом, либо если timeout отрицательно

Начиная с версии:

1.4

public void bind(SocketAddress bindpoint) throws IOException

Параметры:

bindpoint — SocketAddress, к которому нужно выполнить привязку

Исключения:

IOException — если операция привязки завершилась с ошибкой, сокет уже привязан или сокет закрыт.

IllegalArgumentException — если bindpoint является подклассом SocketAddress, который не поддерживается этим сокетом

Начиная с версии:

1.4

См. также:

• isBound()

public InetAddress getInetAddress()

Возвращает:

удаленный IP-адрес, к которому подключен этот сокет, или null, если сокет не подключен.

public InetAddress getLocalAddress()

Возвращает:

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

Начиная с версии:

1.1

public int getPort()

Возвращает:

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

public int getLocalPort()

Возвращает:

номер локального порта, к которому привязан сокет, или -1, если сокет еще не привязан.

public SocketAddress getRemoteSocketAddress()

Возвращает:

объект SocketAddress, представляющий удаленную конечную точку этого сокета, или null, если сокет еще не подключен.

Начиная с версии:

1.4

См. также:

• getInetAddress()
• getPort()
• connect(SocketAddress, int)
• connect(SocketAddress)

public SocketAddress getLocalSocketAddress()

Возвращает:

объект SocketAddress, представляющий локальную конечную точку этого сокета, или null, если сокет еще не привязан.

Начиная с версии:

1.4

См. также:

• getLocalAddress()
• getLocalPort()
• bind(SocketAddress)

public SocketChannel getChannel()

Возвращает:

канал сокета, связанный с этим сокетом, или null, если этот сокет не был создан для канала

Начиная с версии:

1.4

public InputStream getInputStream() throws IOException

Возвращает:

входной поток для чтения байтов из этого сокета.

Исключения:

IOException — если при создании входного потока произошла ошибка ввода-вывода, сокет закрыт, не подключен или ввод данных в сокет был отключен с помощью shutdownInput()

public OutputStream getOutputStream() throws IOException

Возвращает:

выходной поток для записи байтов в этот сокет.

Исключения:

IOException — если при создании выходного потока произошла ошибка ввода-вывода, сокет не подключен или сокет закрыт.

public void setTcpNoDelay(boolean on) throws SocketException

Параметры:

on — true для включения TCP_NODELAY, false для отключения.

Исключения:

SocketException — если произошла ошибка нижележащего протокола, например ошибка TCP, или сокет закрыт.

Начиная с версии:

1.1

См. также:

• getTcpNoDelay()

public boolean getTcpNoDelay() throws SocketException

Возвращает:

значение boolean, указывающее, включен ли TCP_NODELAY.

Исключения:

SocketException — если произошла ошибка нижележащего протокола, например ошибка TCP, или сокет закрыт.

Начиная с версии:

1.1

См. также:

• setTcpNoDelay(boolean)

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

Параметры:

on — указывает, следует ли включить режим ожидания.

linger — продолжительность ожидания, если параметр on имеет значение true.

Исключения:

SocketException — если произошла ошибка нижележащего протокола, например ошибка TCP, или сокет закрыт.

IllegalArgumentException — если значение времени ожидания отрицательно.

Начиная с версии:

1.1

См. также:

• getSoLinger()

public int getSoLinger() throws SocketException

Возвращает:

значение параметра SO_LINGER.

Исключения:

SocketException — если произошла ошибка нижележащего протокола, например ошибка TCP, или сокет закрыт.

Начиная с версии:

1.1

См. также:

• setSoLinger(boolean, int)

public void sendUrgentData(int data) throws IOException

Параметры:

data — байт данных для отправки

Вызывает исключения:

IOException — если при отправке данных произошла ошибка.

Начиная с:

1.4

public void setOOBInline(boolean on) throws SocketException

Параметры:

on — true для включения SO_OOBINLINE, false для отключения.

Вызывает исключения:

SocketException — если в нижележащем протоколе произошла ошибка, например ошибка TCP, или сокет закрыт.

Начиная с:

1.4

См. также:

• getOOBInline()

public boolean getOOBInline() throws SocketException

Возвращает:

значение boolean, указывающее, включен ли SO_OOBINLINE.

Вызывает исключения:

SocketException — если в нижележащем протоколе произошла ошибка, например ошибка TCP, или сокет закрыт.

Начиная с:

1.4

См. также:

• setOOBInline(boolean)

public void setSoTimeout(int timeout) throws SocketException

Параметры:

timeout — заданное время ожидания в миллисекундах.

Вызывает исключения:

SocketException — если в нижележащем протоколе произошла ошибка, например ошибка TCP, или сокет закрыт.

IllegalArgumentException — если значение timeout отрицательное

Начиная с:

1.1

См. также:

• getSoTimeout()

public int getSoTimeout() throws SocketException

Возвращает:

значение параметра SO_TIMEOUT

Вызывает исключения:

SocketException — если в нижележащем протоколе произошла ошибка, например ошибка TCP, или сокет закрыт.

Начиная с:

1.1

См. также:

• setSoTimeout(int)

public void setSendBufferSize(int size) throws SocketException

Параметры:

size — размер буфера отправки. Значение должно быть больше 0.

Вызывает исключения:

SocketException — если в нижележащем протоколе произошла ошибка, например ошибка TCP, или сокет закрыт.

IllegalArgumentException — если значение равно 0 или отрицательно.

Начиная с:

1.2

См. также:

• getSendBufferSize()

public int getSendBufferSize() throws SocketException

Возвращает:

значение параметра SO_SNDBUF для этого Socket.

Вызывает исключения:

SocketException — если в нижележащем протоколе произошла ошибка, например ошибка TCP, или сокет закрыт.

Начиная с:

1.2

См. также:

• setSendBufferSize(int)

public void setReceiveBufferSize(int size) throws SocketException

Параметры:

size — размер буфера приема. Значение должно быть больше 0.

Вызывает исключения:

IllegalArgumentException — если значение равно 0 или отрицательно.

SocketException — если в нижележащем протоколе произошла ошибка, например ошибка TCP, или сокет закрыт.

Начиная с:

1.2

См. также:

• getReceiveBufferSize()
• ServerSocket.setReceiveBufferSize(int)

public int getReceiveBufferSize() throws SocketException

Возвращает:

значение параметра SO_RCVBUF для этого Socket.

Вызывает исключения:

SocketException — если в нижележащем протоколе произошла ошибка, например ошибка TCP, или сокет закрыт.

Начиная с:

1.2

См. также:

• setReceiveBufferSize(int)

public void setKeepAlive(boolean on) throws SocketException

Параметры:

on — следует ли включить для сокета поддержание активности соединения.

Вызывает исключения:

SocketException — если в нижележащем протоколе произошла ошибка, например ошибка TCP, или сокет закрыт.

Начиная с:

1.3

См. также:

• getKeepAlive()

public boolean getKeepAlive() throws SocketException

Возвращает:

значение boolean, указывающее, включен ли SO_KEEPALIVE.

Вызывает исключения:

SocketException — если в нижележащем протоколе произошла ошибка, например ошибка TCP, или сокет закрыт.

Начиная с:

1.3

См. также:

• setKeepAlive(boolean)

public void setTrafficClass(int tc) throws SocketException

Параметры:

tc — значение int для набора битов.

Вызывает исключения:

SocketException — если при установке класса трафика или типа обслуживания произошла ошибка либо сокет закрыт.

Начиная с:

1.4

См. также:

• getTrafficClass()
• StandardSocketOptions.IP_TOS

public int getTrafficClass() throws SocketException

Возвращает:

уже заданный класс трафика или тип обслуживания

Вызывает исключения:

SocketException — если при получении значения класса трафика или типа обслуживания произошла ошибка либо сокет закрыт.

Начиная с:

1.4

См. также:

• setTrafficClass(int)
• StandardSocketOptions.IP_TOS

public void setReuseAddress(boolean on) throws SocketException

Параметры:

on — следует ли включить или отключить параметр сокета

Вызывает исключения:

SocketException — если при включении или отключении параметра сокета SO_REUSEADDR произошла ошибка либо сокет закрыт.

Начиная с:

1.4

См. также:

• getReuseAddress()
• bind(SocketAddress)
• isClosed()
• isBound()

public boolean getReuseAddress() throws SocketException

Возвращает:

значение boolean, указывающее, включен ли SO_REUSEADDR.

Вызывает исключения:

SocketException — если в нижележащем протоколе произошла ошибка, например ошибка TCP, или сокет закрыт.

Начиная с:

1.4

См. также:

• setReuseAddress(boolean)

public void close() throws IOException

Определено в:

close в интерфейсе AutoCloseable

Определено в:

close в интерфейсе Closeable

Вызывает исключения:

IOException — если при закрытии этого сокета произошла ошибка ввода-вывода.

См. также:

• isClosed()

public void shutdownInput() throws IOException

Вызывает исключения:

IOException — если при завершении работы с этим сокетом произошла ошибка ввода-вывода, сокет не подключен, прием данных уже завершен или сокет закрыт.

Начиная с:

1.3

См. также:

• shutdownOutput()
• close()
• setSoLinger(boolean, int)
• isInputShutdown()

public void shutdownOutput() throws IOException

Вызывает исключения:

IOException — если при завершении работы с этим сокетом произошла ошибка ввода-вывода, сокет не подключен, отправка данных уже завершена или сокет закрыт.

Начиная с:

1.3

См. также:

• shutdownInput()
• close()
• setSoLinger(boolean, int)
• isOutputShutdown()

public String toString()

Переопределяет:

toString в классе Object

Возвращает:

строковое представление этого сокета.

public boolean isConnected()

Возвращает:

true, если сокет был успешно подключен к серверу

Начиная с:

1.4

public boolean isBound()

Возвращает:

true, если сокет был успешно привязан к адресу

Начиная с:

1.4

См. также:

• bind(SocketAddress)

public boolean isClosed()

Возвращает:

true, если сокет был закрыт

Начиная с:

1.4

См. также:

• close()

public boolean isInputShutdown()

Возвращает:

true, только если предыдущий вызов shutdownInput() завершился успешно; в противном случае — false

Начиная с:

1.4

public boolean isOutputShutdown()

Возвращает:

true, только если предыдущий вызов shutdownOutput() завершился успешно; в противном случае — false

Начиная с:

1.4

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

Параметры:

fac — требуемая фабрика.

Вызывает исключения:

IOException — если при задании фабрики сокетов произошла ошибка ввода-вывода.

SocketException — если фабрика уже определена.

См. также:

• SocketImplFactory.createSocketImpl()

@Deprecated(since="26", forRemoval=true) public void setPerformancePreferences(int connectionTime, int latency, int bandwidth)

Параметры:

connectionTime — int, выражающее относительную важность короткого времени установления соединения

latency — int, выражающее относительную важность низкой задержки

bandwidth — int, выражающее относительную важность высокой пропускной способности

Начиная с:

1.5

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

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

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

Параметры:

name — параметр сокета

value — значение параметра сокета. Для некоторых параметров допустимо значение null.

Возвращает:

этот Socket

Вызывает исключения:

UnsupportedOperationException — если сокет не поддерживает этот параметр.

IllegalArgumentException — если значение недопустимо для этого параметра.

IOException — если произошла ошибка ввода-вывода или сокет закрыт.

NullPointerException — если имя равно null

Начиная с:

9

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

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

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

Параметры:

name — параметр сокета

Возвращает:

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

Вызывает исключения:

UnsupportedOperationException — если сокет не поддерживает этот параметр.

IOException — если произошла ошибка ввода-вывода или сокет закрыт.

NullPointerException — если имя равно null

Начиная с:

9

public Set<SocketOption<?>> supportedOptions()

Возвращает:

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

Начиная с:

9