hs.network.host
This sub-module provides functions for acquiring host information, such as hostnames, addresses, and reachability.
API Overview
Functions - API calls offered directly by the extension
addressesForHostname hostnamesForAddress reachabilityForAddress reachabilityForHostname
Methods - API calls which can only be made on an object returned by a constructor
cancel isRunning
API Documentation
Functions
addressesForHostname
| Signature | hs.network.host.addressesForHostname(name[, fn]) -> table | hostObject |
| Type | Function |
| Description | Get IP addresses for the hostname specified. |
| Parameters |
|
| Returns |
|
| Notes |
|
| Examples | None |
| Source | extensions/network/libnetwork_host.m line 268 |
hostnamesForAddress
| Signature | hs.network.host.hostnamesForAddress(address[, fn]) -> table | hostObject |
| Type | Function |
| Description | Get hostnames for the IP address specified. |
| Parameters |
|
| Returns |
|
| Notes |
|
| Examples | None |
| Source | extensions/network/libnetwork_host.m line 287 |
reachabilityForAddress
| Signature | hs.network.host.reachabilityForAddress(address[, fn]) -> integer | hostObject |
| Type | Function |
| Description | Get the reachability status for the IP address specified. |
| Parameters |
|
| Returns |
|
| Notes |
|
| Examples | None |
| Source | extensions/network/libnetwork_host.m line 306 |
reachabilityForHostname
| Signature | hs.network.host.reachabilityForHostname(name[, fn]) -> integer | hostObject |
| Type | Function |
| Description | Get the reachability status for the IP address specified. |
| Parameters |
|
| Returns |
|
| Notes |
|
| Examples | None |
| Source | extensions/network/libnetwork_host.m line 327 |
Methods
cancel
| Signature | hs.network.host:cancel() -> hostObject |
| Type | Method |
| Description | Cancels an in-progress asynchronous host resolution. |
| Parameters |
|
| Returns |
|
| Notes |
|
| Examples | None |
| Source | extensions/network/libnetwork_host.m line 367 |
isRunning
| Signature | hs.network.host:isRunning() -> boolean |
| Type | Method |
| Description | Returns whether or not resolution is still in progress for an asynchronous query. |
| Parameters |
|
| Returns |
|
| Notes | None |
| Examples | None |
| Source | extensions/network/libnetwork_host.m line 350 |