PROTOCOLS
NameLookup
Defined in fuchsia.net/namelookup.fidl
LookupHostname
Look up a hostname by IP address.
Request
| Name | Type |
|---|---|
addr |
IpAddress
|
Response
| Name | Type |
|---|---|
result |
NameLookup_LookupHostname_Result
|
LookupIp
Look up a list of IP addresses by hostname.
If hostname is an Internationalized Domain Name, it must be encoded as per RFC 3490.
Request
| Name | Type |
|---|---|
hostname |
Hostname
|
options |
LookupIpOptions
|
Response
| Name | Type |
|---|---|
result |
NameLookup_LookupIp_Result
|
STRUCTS
IpAddressInfo
Defined in fuchsia.net/namelookup.fidl
| Name | Type | Description | Default |
|---|---|---|---|
ipv4_addrs |
vector<Ipv4Address>[256]
|
All of the IPv4 addresses for the requested hostname. |
No default |
ipv6_addrs |
vector<Ipv6Address>[256]
|
All of the IPv6 addresses for the requested hostname. |
No default |
canonical_name |
string[256]?
|
The canonical name of the requested hostname (usually the DNS CNAME record, if one exists). |
No default |
Ipv4Address
Defined in fuchsia.net/net.fidl
Ipv4Address is expressed in network byte order, so the most significant byte ("127" in the address "127.0.0.1") will be at index 0.
| Name | Type | Description | Default |
|---|---|---|---|
addr |
uint8[4]
|
No default |
Ipv4SocketAddress
Defined in fuchsia.net/socket.fidl
An IPv4 socket address, composed of an IPv4 address and a port.
Inspired by the address definition in the POSIX specification.
| Name | Type | Description | Default |
|---|---|---|---|
address |
Ipv4Address
|
IPv4 Address. |
No default |
port |
uint16
|
Transport-layer port. |
No default |
Ipv6Address
Defined in fuchsia.net/net.fidl
Ipv6Address is expressed in network byte order, so the most significant byte ("ff" in the address "ff02::1") will be at index 0.
| Name | Type | Description | Default |
|---|---|---|---|
addr |
uint8[16]
|
No default |
Ipv6SocketAddress
Defined in fuchsia.net/socket.fidl
An IPV6 socket address, composed of an IPv6 address, a port, and a scope identifier.
Inspired by the address definition in the POSIX specification.
| Name | Type | Description | Default |
|---|---|---|---|
address |
Ipv6Address
|
IPv6 Address. |
No default |
port |
uint16
|
Transport-layer port. |
No default |
zone_index |
interface_id
|
Provides a means to identify to which zone a non-global address belongs. A node may have interfaces attached to different zones of the same scope, for example
different link-local zones are disambiguated by the use of a
See RFC 4007 for terminology and examples. |
No default |
MacAddress
Defined in fuchsia.net/net.fidl
A MAC address used to identify a network interface on the data link layer within the network.
| Name | Type | Description | Default |
|---|---|---|---|
octets |
uint8[6]
|
No default |
NameLookup_LookupHostname_Response
Defined in fuchsia.net/namelookup.fidl
| Name | Type | Description | Default |
|---|---|---|---|
hostname |
Hostname
|
No default |
NameLookup_LookupIp_Response
Defined in fuchsia.net/namelookup.fidl
| Name | Type | Description | Default |
|---|---|---|---|
addr |
IpAddressInfo
|
No default |
Subnet
Defined in fuchsia.net/net.fidl
An IP address with its subnet prefix length.
| Name | Type | Description | Default |
|---|---|---|---|
addr |
IpAddress
|
The Ipv4 or Ipv6 address. |
No default |
prefix_len |
uint8
|
The prefix length of the netmask. E.g. for 192.168.1.0/24, the prefix length is 24, corresponding to a netmask of 255.255.255.0. For Ipv4, prefix_len must be in the range [0, 32]. For Ipv6, prefix_len must be in the range [0, 128]. |
No default |
ENUMS
LookupError
Type: uint32
Defined in fuchsia.net/namelookup.fidl
| Name | Value | Description |
|---|---|---|
NOT_FOUND |
1 |
No result was found for this query. |
TRANSIENT |
2 |
The lookup failed, but may succeed at a later time. For instance, the network or DNS server may be unreachable. |
INVALID_ARGS |
3 |
The lookup failed due to an invalid argument (for instance, the hostname was not encoded correctly, or was too long). |
INTERNAL_ERROR |
4 |
The lookup failed due to an internal error. |
UNIONS
IpAddress
Defined in fuchsia.net/net.fidl
Represents an IP address that may be either v4 or v6.
| Name | Type | Description |
|---|---|---|
ipv4 |
Ipv4Address
|
|
ipv6 |
Ipv6Address
|
NameLookup_LookupHostname_Result
Defined in fuchsia.net/namelookup.fidl
| Name | Type | Description |
|---|---|---|
response |
NameLookup_LookupHostname_Response
|
|
err |
LookupError
|
NameLookup_LookupIp_Result
Defined in fuchsia.net/namelookup.fidl
| Name | Type | Description |
|---|---|---|
response |
NameLookup_LookupIp_Response
|
|
err |
LookupError
|
SocketAddress
Defined in fuchsia.net/socket.fidl
Represents an IP socket address that may be either v4 or v6.
| Name | Type | Description |
|---|---|---|
ipv4 |
Ipv4SocketAddress
|
|
ipv6 |
Ipv6SocketAddress
|
BITS
LookupIpOptions
Type: uint8
Defined in fuchsia.net/namelookup.fidl
| Name | Value | Description |
|---|---|---|
| V4_ADDRS | 1 | If the lookup should return IPv4 addresses. |
| V6_ADDRS | 2 | If the lookup should return IPv6 addresses. |
| CNAME_LOOKUP | 4 | If the lookup should return a canonical_name, if one exists. |
CONSTANTS
| Name | Value | Type | Description |
|---|---|---|---|
| MAX_HOSTNAME_SIZE |
255
|
uint64 |
The maximum length of a hostname, as per RFC 1035 section 2.3.4. |
TYPE ALIASES
| Name | Value | Description |
|---|---|---|
| Hostname |
string[MAX_HOSTNAME_SIZE] |
A hostname. Although the maximum length of a domain or hostname is 255 characters, each label within a name must not be longer than 63 characters as per RFC 1035 section 2.3.4. A label in a host name is the alphanumeric characters or hyphens, seperated by a period (e.g. abc.com has two labels, 'abc' and 'com'). |
| interface_id |
uint64 |
A unique non-zero interface identifier. |