GeneralDiagnosticsTrait.NetworkInterface
class GeneralDiagnosticsTrait.NetworkInterface : ClusterStruct
Information about a network interface.
Summary
Nested types |
|---|
|
Descriptor enum for this struct's fields. |
Public constructors |
|---|
NetworkInterface(Creates the NetworkInterface class. |
Public functions |
|
|---|---|
open StructDescriptor |
Returns the descriptor for the struct. |
open Any? |
Returns the value of the field for the given tag ID. |
Public properties |
|
|---|---|
ByteArray |
|
List<ByteArray> |
A list of the IPv4 addresses that are assigned to the network interface. |
List<ByteArray> |
A list of the unicast IPv6 addresses that are assigned to the network interface. |
Boolean |
|
String |
|
Boolean? |
|
Boolean? |
|
GeneralDiagnosticsTrait.InterfaceTypeEnum |
Public constructors
NetworkInterface
NetworkInterface(
name: String = "",
isOperational: Boolean = false,
offPremiseServicesReachableIpv4: Boolean? = null,
offPremiseServicesReachableIpv6: Boolean? = null,
hardwareAddress: ByteArray = ByteArray(0),
ipv4Addresses: List<ByteArray> = emptyList(),
ipv6Addresses: List<ByteArray> = emptyList(),
type: GeneralDiagnosticsTrait.InterfaceTypeEnum = InterfaceTypeEnum.Unspecified
)
Creates the NetworkInterface class.
Public functions
getDescriptor
@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor
Returns the descriptor for the struct.
getFieldValueById
@HomeExperimentalGenericApi
open fun getFieldValueById(tagId: UInt): Any?
Returns the value of the field for the given tag ID.
Public properties
ipv4Addresses
val ipv4Addresses: List<ByteArray>
A list of the IPv4 addresses that are assigned to the network interface.
ipv6Addresses
val ipv6Addresses: List<ByteArray>
A list of the unicast IPv6 addresses that are assigned to the network interface. This list includes the node's link-local address and should include any assigned GUA and ULA addresses. This list must not include any multicast group addresses to which the node has subscribed.