Класс NetworkInterface

java.lang.Object

java.net.NetworkInterface

public final class NetworkInterface extends Object

Этот класс представляет сетевой интерфейс, состоящий из имени и списка IP-адресов, назначенных этому интерфейсу. Он используется для идентификации локального интерфейса, к которому присоединена многоадресная группа. Интерфейсы обычно известны по именам, таким как "le0".

Since:: 1.4

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

Модификатор и тип	Метод	Описание
`boolean`	`equals(Object obj)`	Сравнивает этот объект с указанным объектом.
`static NetworkInterface`	`getByIndex(int index)`	Получение сетевого интерфейса по его индексу.
`static NetworkInterface`	`getByInetAddress(InetAddress addr)`	Удобный метод для поиска сетевого интерфейса, к которому привязан указанный IP-адрес.
`static NetworkInterface`	`getByName(String name)`	Поиск сетевого интерфейса по заданному имени.
`String`	`getDisplayName()`	Получение отображаемого имени этого сетевого интерфейса.
`byte[]`	`getHardwareAddress()`	Возвращает физический адрес (обычно MAC) интерфейса, если он есть и доступен при текущих разрешениях.
`int`	`getIndex()`	Возвращает индекс этого сетевого интерфейса.
`Enumeration<InetAddress>`	`getInetAddresses()`	Получение перечисления всех или подмножества InetAddresses, привязанных к этому сетевому интерфейсу.
`List<InterfaceAddress>`	`getInterfaceAddresses()`	Получение списка всех или подмножества `InterfaceAddresses` этого сетевого интерфейса.
`int`	`getMTU()`	Возвращает максимальное значение MTU (Maximum Transmission Unit) этого интерфейса.
`String`	`getName()`	Получение имени этого сетевого интерфейса.
`static Enumeration<NetworkInterface>`	`getNetworkInterfaces()`	Возвращает перечисление всех интерфейсов на этом компьютере.
`NetworkInterface`	`getParent()`	Возвращает родительский NetworkInterface этого интерфейса, если это дочерний интерфейс, или `null` если это физический (не виртуальный) интерфейс или у него нет родителя.
`Enumeration<NetworkInterface>`	`getSubInterfaces()`	Получение перечисления всех дочерних интерфейсов (также известных как виртуальные интерфейсы), подключенных к этому сетевому интерфейсу.
`Stream<InetAddress>`	`inetAddresses()`	Получение потока всех или подмножества InetAddresses, привязанных к этому сетевому интерфейсу.
`boolean`	`isLoopback()`	Возвращает, является ли сетевой интерфейс интерфейсом обратной связи.
`boolean`	`isPointToPoint()`	Возвращает, является ли сетевой интерфейс точечно-точечным интерфейсом.
`boolean`	`isUp()`	Возвращает, включён ли сетевой интерфейс и работает ли он.
`boolean`	`isVirtual()`	Возвращает, является ли этот интерфейс виртуальным интерфейсом (также называемым дочерним интерфейсом).
`static Stream<NetworkInterface>`	`networkInterfaces()`	Возвращает перечисление всех интерфейсов на этом компьютере.
`Stream<NetworkInterface>`	`subInterfaces()`	Получение потока всех дочерних интерфейсов (также известных как виртуальные интерфейсы), подключенных к этому сетевому интерфейсу.
`boolean`	`supportsMulticast()`	Возвращает, поддерживает ли сетевой интерфейс многоадресную рассылку.

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

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getName

public String getName()

Получить имя этого сетевого интерфейса.

Возвращает:: имя этого сетевого интерфейса

getInetAddresses

public Enumeration<InetAddress> getInetAddresses()

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

Если существует менеджер безопасности, его метод checkConnect вызывается для каждого InetAddress. Только InetAddresses, для которых checkConnect не выбросит SecurityException, будут возвращены в перечислении. Однако, если вызывающий обладает разрешением NetPermission("getNetworkInformation"), то возвращаются все InetAddresses.

Возвращает:

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

См. также:

inetAddresses()

inetAddresses

public Stream<InetAddress> inetAddresses()

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

Если существует менеджер безопасности, его метод checkConnect вызывается для каждого InetAddress. Только InetAddresses, для которых checkConnect не выбросит SecurityException, будут возвращены в потоке. Однако, если вызывающий обладает разрешением NetPermission("getNetworkInformation"), то возвращаются все InetAddresses.

Возвращает:: объект потока со всеми или подмножеством адресов InetAddresses, привязанных к этому сетевому интерфейсу
С тех пор как:: 9

getInterfaceAddresses

public List<InterfaceAddress> getInterfaceAddresses()

Получить список всех или подмножества адресов InterfaceAddresses этого сетевого интерфейса.

Если существует менеджер безопасности, его метод checkConnect вызывается с InetAddress для каждого InterfaceAddress. Только InterfaceAddresses, для которых checkConnect не выбросит SecurityException, будут возвращены в списке.

Возвращает:: объект списка со всеми или подмножеством InterfaceAddress этого сетевого интерфейса
С тех пор как:: 1.6

getSubInterfaces

public Enumeration<NetworkInterface> getSubInterfaces()

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

Например, eth0:1 будет подсетевым интерфейсом к eth0.

Возвращает:

объект перечисления со всеми подсетевыми интерфейсами этого сетевого интерфейса

С тех пор как:

1.6

См. также:

subInterfaces()

subInterfaces

public Stream<NetworkInterface> subInterfaces()

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

Возвращает:: объект потока со всеми подсетевыми интерфейсами этого сетевого интерфейса
С тех пор как:: 9

getParent

public NetworkInterface getParent()

Возвращает родительский NetworkInterface этого интерфейса, если это подсетевой интерфейс, или null если это физический (не виртуальный) интерфейс или у него нет родителя.

Возвращает:: родительский интерфейс, к которому подключен этот интерфейс.
С тех пор как:: 1.6

getIndex

public int getIndex()

Возвращает индекс этого сетевого интерфейса. Индекс — целое число, больше или равно нулю, или -1 для неизвестного. Это значение, специфичное для системы, и интерфейсы с одинаковыми именами могут иметь разные индексы на разных машинах.

Возвращает:

индекс этого сетевого интерфейса или -1 если индекс неизвестен

С тех пор как:

1.7

См. также:

getByIndex(int)

getDisplayName

public String getDisplayName()

Получить имя для отображения этого сетевого интерфейса. Имя для отображения — это читаемая человеком строка, описывающая сетевое устройство.

Возвращает:: непустую строку, представляющую имя для отображения этого сетевого интерфейса, или null, если имя для отображения недоступно.

getByName

public static NetworkInterface getByName(String name) throws SocketException

Поиск сетевого интерфейса по указанному имени.

Параметры:: name - Имя сетевого интерфейса.
Возвращает:: сетевой интерфейс с указанным именем или null если сетевого интерфейса с указанным именем нет.
Выбрасывает:: SocketException - Если произошла ошибка ввода-вывода.; NullPointerException - Если указанное имя null.

getByIndex

public static NetworkInterface getByIndex(int index) throws SocketException

Получить сетевой интерфейс по его индексу.

Параметры:

index - целое число, индекс интерфейса

Возвращает:

сетевой интерфейс, полученный по его индексу, или null если на системе нет интерфейса с таким индексом

Выбрасывает:

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

IllegalArgumentException - если индекс имеет отрицательное значение

С тех пор как:

1.7

См. также:

getIndex()

getByInetAddress

public static NetworkInterface getByInetAddress(InetAddress addr) throws SocketException

Удобный метод для поиска сетевого интерфейса, к которому привязан указанный адрес Интернет-протокола (IP).

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

Параметры:: addr - IP-адрес для поиска.
Возвращает:: сетевой интерфейс или null если сетевого интерфейса с указанным IP-адресом нет.
Выбрасывает:: SocketException - Если произошла ошибка ввода-вывода.; NullPointerException - Если указанный адрес null.

getNetworkInterfaces

public static Enumeration<NetworkInterface> getNetworkInterfaces() throws SocketException

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

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

Этот метод можно использовать в сочетании с getInetAddresses() для получения всех IP-адресов для этого узла

Возвращает:

перечисление NetworkInterfaces, найденных на этой машине

Выбрасывает:

SocketException - если произошла ошибка ввода-вывода или платформа не имеет по крайней мере одного настроенного сетевого интерфейса.

См. также:

networkInterfaces()

networkInterfaces

public static Stream<NetworkInterface> networkInterfaces() throws SocketException

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

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

Этот метод можно использовать в сочетании с inetAddresses()} для получения потока всех IP-адресов для этого узла, например:

 
 Stream<InetAddress> addrs = NetworkInterface.networkInterfaces()
     .flatMap(NetworkInterface::inetAddresses);

Возвращает:

поток NetworkInterfaces, найденных на этой машине

Выбрасывает:

С тех пор как:

isUp

public boolean isUp() throws SocketException

Возвращает, активен ли сетевой интерфейс.

Возвращает:: true если интерфейс активен.
Выбрасывает:: SocketException - если произошла ошибка ввода-вывода.
С тех пор как:: 1.6

isLoopback

public boolean isLoopback() throws SocketException

Возвращает, является ли сетевой интерфейс интерфейсом обратной связи.

Возвращает:: true если интерфейс является интерфейсом обратной связи.
Выбрасывает:: SocketException - если произошла ошибка ввода-вывода.
С тех пор как:: 1.6

isPointToPoint

public boolean isPointToPoint() throws SocketException

Возвращает, является ли сетевой интерфейс интерфейсом «точка-точка». Типичный интерфейс «точка-точка» — это соединение PPP через модем.

Возвращает:: true если интерфейс является интерфейсом «точка-точка».
Выбрасывает:: SocketException - если произошла ошибка ввода-вывода.
С тех пор как:: 1.6

supportsMulticast

public boolean supportsMulticast() throws SocketException

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

Возвращает:: true если интерфейс поддерживает мультимедиа-трансляцию.
Выбрасывает:: SocketException - если произошла ошибка ввода-вывода.
С тех пор как:: 1.6

getHardwareAddress

public byte[] getHardwareAddress() throws SocketException

Возвращает аппаратный адрес (обычно MAC) интерфейса, если он есть и доступен с текущими привилегиями. Если установлен менеджер безопасности, вызывающий метод должен иметь разрешение NetPermission("getNetworkInformation").

Возвращает:: массив байтов, содержащий адрес, или null если адрес не существует, недоступен или менеджер безопасности установлен, и вызывающий метод не имеет разрешения NetPermission("getNetworkInformation")
Изначает исключение:: SocketException - если произошла ошибка ввода-вывода.
С:: 1.6

getMTU

public int getMTU() throws SocketException

Возвращает максимальный размер пакета (MTU) этого интерфейса.

Возвращает:: значение MTU для данного интерфейса.
Изначает исключение:: SocketException - если произошла ошибка ввода-вывода.
С:: 1.6

isVirtual

public boolean isVirtual()

Возвращает значение, указывающее, является ли этот интерфейс виртуальным интерфейсом (также называемым подинтерфейсом). Виртуальные интерфейсы — это, на некоторых системах, интерфейсы, созданные как дочерние по отношению к физическому интерфейсу и имеющие разные настройки (например, адрес или MTU). Обычно имя интерфейса будет именем родительского интерфейса, за которым следует двоеточие (:) и число, определяющее дочерний интерфейс, так как к одному физическому интерфейсу могут быть подключены несколько виртуальных интерфейсов.

Возвращает:: true если этот интерфейс является виртуальным интерфейсом.
С:: 1.6

equals

public boolean equals(Object obj)

Сравнивает этот объект с указанным объектом. Результат — true тогда и только тогда, когда аргумент не null и представляет тот же NetworkInterface, что и этот объект.

Два экземпляра NetworkInterface представляют один и тот же NetworkInterface, если имя и набор InetAddress интерфейсов равны.

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

equals в классе Object

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

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

Параметры:

obj - объект для сравнения.

Возвращает:

true если объекты идентичны; false в противном случае.

См. также:

InetAddress.getAddress()

© 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/NetworkInterface.html