Spec-Zone.ru › Hammerspoon

hs.network

Этот модуль предоставляет функции для запроса и мониторинга изменений в сети.

Подмодули

  • hs.network.configuration
  • hs.network.host
  • hs.network.ping
  • hs.network.reachability

Обзор API

  • Функции — API-вызовы, предлагаемые непосредственно расширением
    • addresses
    • interfaceDetails
    • interfaceName
    • interfaces
    • primaryInterfaces

Документация API

Функции

addresses
Подпись hs.network.addresses([interface_list]) -> table
Тип Функция
Описание

Возвращает список адресов IPv4 и IPv6 для указанных интерфейсов или для всех интерфейсов, если аргументы не указаны.

Параметры
  • interface_list — Имена интерфейсов, для которых нужно вернуть IP-адреса. Должен быть указан одним из следующих способов:
    • одно или несколько имён интерфейсов, разделенных запятой
    • если первый аргумент является таблицей, предполагается, что это таблица, содержащая список интерфейсов, и этот список используется вместо него, игнорируя любые дополнительные аргументы, которые могут быть предоставлены
    • если аргументы не указаны, то используются результаты hs.network.interfaces.
Возвращает
  • Таблица, содержащая список IP-адресов для интерфейсов, как определено предоставленными аргументами.
Примечания
  • Порядок возвращаемых IP-адресов не определен.
  • Если аргументы не предоставлены, то эта функция возвращает те же результаты, что и hs.host.addresses, но не блокируется.
Источник extensions/network/network.lua строка 145
interfaceDetails
Подпись hs.network.interfaceDetails([interface | favorIPv6]) -> table
Тип Функция
Описание

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

Параметры
  • interface — необязательная строка, определяющая интерфейс, для которого нужно получить подробные сведения. По умолчанию используется основной интерфейс, если не указан.
  • favorIPv6 — необязательный boolean, определяющий, следует ли предпочитать основной IPv6 или основной IPv4 интерфейс, если interface не указан. По умолчанию false.
Возвращает
  • Таблица, содержащая пары ключ-значение, описывающие сведения об интерфейсе. Возвращает пустую таблицу, если основной интерфейс не может быть определен. Выводит ошибку и возвращает nil, если возникла проблема при получении этой информации.
Примечания
  • При определении основного интерфейса флаг favorIPv6 определяет только порядок поиска интерфейсов. Если вы укажете true для этого флага, но не существует основного IPv6 интерфейса (например, ваш DHCP-сервер предоставляет только IPv4 адрес, а IPv6 ограничен только локальным трафиком), то вместо этого будет использован основной IPv4 интерфейс.
Источник extensions/network/network.lua строка 69
interfaceName
Подпись hs.network.interfaceName([interface | favorIPv6]) -> string
Тип Функция
Описание

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

Параметры
  • interface — необязательная строка, определяющая интерфейс, для которого нужно получить имя. По умолчанию используется основной интерфейс, если не указан.
  • favorIPv6 — необязательный boolean, определяющий, следует ли предпочитать основной IPv6 или основной IPv4 интерфейс, если interface не указан. По умолчанию false.
Возвращает
  • Строка, содержащая имя, заданное пользователем, для интерфейса, если оно существует, или false, если для интерфейса нет имени, заданного пользователем. Выводит ошибку и возвращает nil, если возникла проблема при получении этой информации.
Примечания
  • Только у интерфейсов, которые отображаются в панели «Сеть» в настройках системы, будет имя, заданное пользователем.

  • При определении основного интерфейса флаг favorIPv6 определяет только порядок поиска интерфейсов. Если вы укажете true для этого флага, но не существует основного IPv6 интерфейса (например, ваш DHCP-сервер предоставляет только IPv4 адрес, а IPv6 ограничен только локальным трафиком), то вместо этого будет использован основной IPv4 интерфейс.

Источник extensions/network/network.lua строка 190
interfaces
Подпись hs.network.interfaces() -> table
Тип Функция
Описание

Возвращает список активных интерфейсов системы.

Параметры
  • Нет
Возвращает
  • Таблица, содержащая список активных интерфейсов системы. Выводит ошибку и возвращает nil, если возникла проблема при получении этой информации.
Примечания
  • Имена интерфейсов, возвращаемые этой функцией, соответствуют имени BSD интерфейса, а не имени, заданному пользователем, которое отображается в панели «Сеть» в настройках системы.
  • Эта функция возвращает все интерфейсы, даже те, которые используются системой и не управляются напрямую пользователем.
Источник extensions/network/network.lua строка 38
primaryInterfaces
Подпись hs.network.primaryInterfaces() -> ipv4Interface, ipv6Interface
Тип Функция
Описание

Возвращает имена основных IPv4 и IPv6 интерфейсов.

Параметры
  • Нет
Возвращает
  • Имя основного IPv4 интерфейса или false, если его нет, и имя IPv6 интерфейса или false, если его нет. Выводит ошибку и возвращает один nil, если возникла проблема при получении этой информации.
Примечания
  • Имена IPv4 и IPv6 интерфейсов часто, но не всегда, совпадают.
Источник extensions/network/network.lua строка 115

© 2014–2017 Hammerspoon contributors
Licensed under the MIT License.
https://www.hammerspoon.org/docs/hs.network.html

Spec-Zone.ru

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