Overview

A description of a single address assigned to a network interface.

Data Fields
unsigned int	index
	The OS-specific network interface number. More...

EtcPalIpAddr	addr
	The interface ip address.

EtcPalIpAddr	mask
	The subnet mask for this interface.

EtcPalMacAddr	mac
	The adapter MAC address.

char	id [ETCPAL_NETINTINFO_ID_LEN]
	The system name for the interface. More...

char	friendly_name [ETCPAL_NETINTINFO_FRIENDLY_NAME_LEN]
	A user-friendly name for the interface. More...

bool	is_default
	Whether this is the default network interface. More...

Field Documentation

◆ friendly_name

char friendly_name[ETCPAL_NETINTINFO_FRIENDLY_NAME_LEN]

A user-friendly name for the interface.

On some systems, this is the same as the id field. Others allow users to create and change a friendly name for network interfaces that's different than the system name. This field should be used when printing the adapter list in a UI.

◆ id

char id[ETCPAL_NETINTINFO_ID_LEN]

The system name for the interface.

This name can be used as a primary key to identify a single network adapter. It will not change unless the adapter is removed or reconfigured. Since interfaces can have multiple IPv4 and IPv6 addresses assigned simultaneously, there can be a one-to-many relationship between physical network interfaces and EtcPalNetintInfo structures on the same system, all of which have the same value for this field.

◆ index

unsigned int index

The OS-specific network interface number.

Since interfaces can have multiple IPv4 and IPv6 addresses assigned simultaneously, there can be a one-to-many relationship between physical network interfaces and EtcPalNetintInfo descriptions on the same system, all of which will have the same value for this field. It is also used for IPv6, multicast and IP-version-neutral APIs. See Network Interface Indexes for more information.

◆ is_default

bool is_default

Whether this is the default network interface.

The default network interface is defined as the network interface chosen for the default IP route on a system.

The documentation for this struct was generated from the following file: