Class MacNetworkIF

java.lang.Object

oshi.hardware.common.AbstractNetworkIF

oshi.hardware.common.platform.mac.MacNetworkIF

All Implemented Interfaces:

NetworkIF

@ThreadSafe
public abstract class MacNetworkIF
extends AbstractNetworkIF

Base class for macOS NetworkIF implementations. Subclasses provide platform-specific display name resolution and network statistics updates.

Nested Class Summary

Nested classes/interfaces inherited from interface NetworkIF

NetworkIF.IfOperStatus

Modifier and Type	Interface	Description
static enum	NetworkIF.IfOperStatus	The current operational state of a network interface.

Field Summary

Fields inherited from class AbstractNetworkIF

bytesRecv, bytesSent, collisions, inDrops, inErrors, outErrors, packetsRecv, packetsSent, speed, timeStamp

Modifier and Type	Field	Description
protected long	bytesRecv
protected long	bytesSent
protected long	collisions
protected long	inDrops
protected long	inErrors
protected long	outErrors
protected long	packetsRecv
protected long	packetsSent
protected long	speed
protected long	timeStamp

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MacNetworkIF(NetworkInterface netint, String displayName)	Creates a MacNetworkIF.

Method Summary

Modifier and Type	Method	Description
int	getIfType()	(Windows, macOS) The NDIS Interface Type.
protected void	setIfType(int ifType)	Sets the interface type.

Methods inherited from class AbstractNetworkIF

getBytesRecv, getBytesSent, getCollisions, getDisplayName, getIndex, getInDrops, getInErrors, getIPv4addr, getIPv6addr, getMacaddr, getMTU, getName, getNetworkInterfaces, getOutErrors, getPacketsRecv, getPacketsSent, getPrefixLengths, getSpeed, getSubnetMasks, getTimeStamp, isKnownVmMacAddr, queryNetworkInterface, toString

Modifier and Type	Method	Description
long	getBytesRecv()	Getter for the field bytesRecv.
long	getBytesSent()	Getter for the field bytesSent.
long	getCollisions()	Getter for the field collisions.
String	getDisplayName()	Interface description.
int	getIndex()	Interface index.
long	getInDrops()	Getter for the field inDrops.
long	getInErrors()	Getter for the field inErrors.
String[]	getIPv4addr()	The Internet Protocol (IP) v4 address.
String[]	getIPv6addr()	The Internet Protocol (IP) v6 address.
String	getMacaddr()	The Media Access Control (MAC) address.
long	getMTU()	The interface Maximum Transmission Unit (MTU).
String	getName()	Interface name.
protected static List<NetworkInterface>	getNetworkInterfaces(boolean includeLocalInterfaces)	Returns network interfaces on this machine.
long	getOutErrors()	Getter for the field outErrors.
long	getPacketsRecv()	Getter for the field packetsRecv.
long	getPacketsSent()	Getter for the field packetsSent.
Short[]	getPrefixLengths()	The Internet Protocol (IP) v6 address.
long	getSpeed()	Getter for the field speed.
Short[]	getSubnetMasks()	The Internet Protocol (IP) v4 subnet masks.
long	getTimeStamp()	Getter for the field timeStamp.
boolean	isKnownVmMacAddr()	Determines if the MAC address on this interface corresponds to a known Virtual Machine.
NetworkInterface	queryNetworkInterface()	Gets the NetworkInterface object.
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface NetworkIF

getIfAlias, getIfOperStatus, getNdisPhysicalMediumType, isConnectorPresent, updateAttributes

Modifier and Type	Method	Description
default String	getIfAlias()	The ifAlias as described in RFC 2863.
default NetworkIF.IfOperStatus	getIfOperStatus()	The ifOperStatus as described in RFC 2863.
default int	getNdisPhysicalMediumType()	(Windows Vista and higher only) The NDIS physical medium type.
default boolean	isConnectorPresent()	(Windows Vista and higher) Set if a connector is present on the network interface.
boolean	updateAttributes()	Updates interface network statistics on this interface.

Constructor Details

MacNetworkIF

protected MacNetworkIF(NetworkInterface netint,
 String displayName)
                throws InstantiationException

Creates a MacNetworkIF.

Parameters:

netint - the network interface

displayName - the display name

Throws:

InstantiationException - if the interface cannot be instantiated

Method Details

getIfType

public int getIfType()

Description copied from interface: NetworkIF

(Windows, macOS) The NDIS Interface Type. NDIS interface types are registered with the Internet Assigned Numbers Authority (IANA), which publishes a list of interface types periodically in the Assigned Numbers RFC, or in a derivative of it that is specific to Internet network management number assignments.

(Linux) ARP Protocol hardware identifiers defined in include/uapi/linux/if_arp.h

Returns:

the ifType

setIfType

protected void setIfType(int ifType)

Sets the interface type.

Parameters:

ifType - the interface type to set