Spec-Zone.ru › OpenJDK 17

Класс InetSocketAddress

java.lang.Object
java.net.SocketAddress
java.net.InetSocketAddress
Все реализованные интерфейсы:
Serializable
public class InetSocketAddress extends SocketAddress
Этот класс реализует адрес IP-соккета (IP-адрес + номер порта). Он также может быть парой (имя хоста + номер порта), в этом случае будет предпринята попытка разрешить имя хоста. Если разрешение не удаётся, адрес считается неразрешённым, но его всё равно можно использовать в некоторых ситуациях, например, при подключении через прокси.

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

Адрес-маска — это специальный локальный IP-адрес. Обычно он означает «любой» и может использоваться только для bind операций.

С тех пор:
1.4
См. также:
  • Socket
  • ServerSocket
  • Сериализованная форма

Краткое описание конструкторов

Конструктор Описание
InetSocketAddress(int port)
Создаёт адрес сокета, где IP-адрес — адрес-маска, а номер порта — заданное значение.
InetSocketAddress(String hostname, int port)
Создаёт адрес сокета из имени хоста и номера порта.
InetSocketAddress(InetAddress addr, int port)
Создаёт адрес сокета из IP-адреса и номера порта.

Краткое описание методов

Модификатор и тип Метод Описание
static InetSocketAddress createUnresolved(String host, int port)
Создаёт неразрешённый адрес сокета из имени хоста и номера порта.
final boolean equals(Object obj)
Сравнивает этот объект с указанным объектом.
final InetAddress getAddress()
Получает InetAddress.
final String getHostName()
Получает hostname.
final String getHostString()
Возвращает имя хоста или строковое представление адреса, если у него нет имени хоста (он был создан с помощью литерала).
final int getPort()
Получает номер порта.
final int hashCode()
Возвращает хэш-код для этого адреса сокета.
final boolean isUnresolved()
Проверяет, был ли адрес разрешён.
String toString()
Конструирует строковое представление этого InetSocketAddress.

Методы, объявленные в классе java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Подробное описание конструкторов

InetSocketAddress

public InetSocketAddress(int port)
Создаёт адрес сокета, где IP-адрес — адрес по умолчанию, а номер порта — заданное значение.

Действительное значение порта должно быть в диапазоне от 0 до 65535. Номер порта zero позволит системе выбрать временный порт в ходе bind операции.

Параметры:
port - Номер порта
Исключения:
IllegalArgumentException - если параметр порта находится вне указанного диапазона допустимых значений портов.

InetSocketAddress

public InetSocketAddress(InetAddress addr, int port)
Создаёт адрес сокета из IP-адреса и номера порта.

Действительное значение порта должно быть в диапазоне от 0 до 65535. Номер порта zero позволит системе выбрать временный порт в ходе bind операции.

Адрес null назначит адрес по умолчанию.

Параметры:
addr - IP-адрес
port - Номер порта
Исключения:
IllegalArgumentException - если параметр порта находится вне указанного диапазона допустимых значений портов.

InetSocketAddress

public InetSocketAddress(String hostname, int port)
Создаёт адрес сокета из имени хоста и номера порта.

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

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

Действительное значение порта должно быть в диапазоне от 0 до 65535. Номер порта zero позволит системе выбрать временный порт в ходе bind операции.

Параметры:
hostname - имя хоста
port - Номер порта
Исключения:
IllegalArgumentException - если параметр порта находится вне диапазона допустимых значений, или если параметр имени хоста null.
SecurityException - если менеджер безопасности присутствует и разрешение на разрешение имени хоста отклонено.
См. также:
  • isUnresolved()

Подробное описание методов

createUnresolved

public static InetSocketAddress createUnresolved(String host, int port)
Создаёт неразрешённый адрес сокета из имени хоста и номера порта.

Попытка разрешить имя хоста в InetAddress не будет выполнена. Адрес будет помечен как неразрешённый.

Действительное значение порта должно быть в диапазоне от 0 до 65535. Номер порта zero позволит системе выбрать временный порт в ходе bind операции.

Параметры:
host - имя хоста
port - Номер порта
Возвращает:
объект InetSocketAddress, представляющий неразрешённый адрес сокета
Исключения:
IllegalArgumentException - если параметр порта находится вне диапазона допустимых значений, или если параметр имени хоста null.
С версии:
1.5
См. также:
  • isUnresolved()

getPort

public final int getPort()
Возвращает номер порта.
Возвращает:
номер порта.

getAddress

public final InetAddress getAddress()
Возвращает InetAddress.
Возвращает:
InetАдресс или null если он не разрешён.

getHostName

public final String getHostName()
Возвращает имя hostname. Примечание: Этот метод может инициировать обратный поиск имени службы, если адрес был создан с использованием литерального IP-адреса.
Возвращает:
часть имени хоста адреса.

getHostString

public final String getHostString()
Возвращает имя хоста или строковое представление адреса, если у него нет имени хоста (он был создан с использованием литерала). Это имеет преимущество в том, что не пытается выполнить обратный поиск.
Возвращает:
имя хоста или строковое представление адреса.
С версии:
1.7

isUnresolved

public final boolean isUnresolved()
Проверяет, был ли адрес разрешён или нет.
Возвращает:
true если имя хоста не удалось разрешить в InetAddress.

toString

public String toString()
Строит строковое представление этого InetSocketAddress. Эта строка строится путём вызова InetAddress.toString() на InetAddress и конкатенации номера порта (с двоеточием).

Если адрес — IPv6-адрес, IPv6-литерал заключён в квадратные скобки, например: "localhost/[0:0:0:0:0:0:0:1]:80". Если адрес — неразрешённый, вместо литерала адреса отображается <unresolved>, например "foo/<unresolved>:80".

Чтобы получить строковое представление имени хоста или адреса, используйте getHostString(), а не парсирование строки, возвращаемой этим методом toString().

Переопределяет:
toString в классе Object
Возвращает:
строковое представление этого объекта.

equals

public final boolean equals(Object obj)
Сравнивает этот объект со заданным объектом. Результат — true тогда и только тогда, когда аргумент не null и представляет тот же адрес, что и этот объект.

Два экземпляра InetSocketAddress представляют один и тот же адрес, если оба InetAddress (или имена хостов, если адрес не разрешен) и номера портов равны. Если оба адреса не разрешены, сравниваются имя хоста и номер порта. Примечание: имена хостов нечувствительны к регистру. Например, "FooBar" и "foobar" считаются равными.

Переопределяет:
equals в классе Object
Параметры:
obj - объект для сравнения.
Возвращает:
true если объекты одинаковые; false в противном случае.
См. также:
  • InetAddress.equals(java.lang.Object)

hashCode

public final int hashCode()
Возвращает хэш-код для этого адреса сокета.
Переопределяет:
hashCode в классе Object
Возвращает:
значение хэш-кода для этого адреса сокета.
См. также:
  • Object.equals(java.lang.Object)
  • System.identityHashCode(java.lang.Object)

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/InetSocketAddress.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API