Package oshi.hardware.platform.mac

Class MacNetworkIF

java.lang.Object

oshi.hardware.common.AbstractNetworkIF

oshi.hardware.platform.mac.MacNetworkIF

All Implemented Interfaces:

NetworkIF

@ThreadSafe
public final class MacNetworkIF
extends AbstractNetworkIF

MacNetworks class.

Nested Class Summary

Nested classes/interfaces inherited from interface oshi.hardware.NetworkIF

NetworkIF.IfOperStatus

Field Summary

Fields

Modifier and Type	Field	Description
private long	bytesRecv
private long	bytesSent
private long	collisions
private int	ifType
private long	inDrops
private long	inErrors
private static org.slf4j.Logger	LOG
private long	outErrors
private long	packetsRecv
private long	packetsSent
private long	speed
private long	timeStamp

Constructor Summary

Constructors

Constructor	Description
MacNetworkIF(java.net.NetworkInterface netint, java.util.Map<java.lang.Integer,NetStat.IFdata> data)

Method Summary

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.
int	getIfType()	(Windows, macOS) The NDIS Interface Type.
long	getInDrops()	Getter for the field inDrops.
long	getInErrors()	Getter for the field inErrors.
static java.util.List<NetworkIF>	getNetworks(boolean includeLocalInterfaces)	Gets all 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.
long	getSpeed()	Getter for the field speed.
long	getTimeStamp()	Getter for the field timeStamp.
private static java.lang.String	queryIfDisplayName(java.net.NetworkInterface netint)
boolean	updateAttributes()	Updates interface network statistics on this interface.
private boolean	updateNetworkStats(java.util.Map<java.lang.Integer,NetStat.IFdata> data)	Updates interface network statistics on the given interface.

Methods inherited from class oshi.hardware.common.AbstractNetworkIF

getDisplayName, getIndex, getIPv4addr, getIPv6addr, getMacaddr, getMTU, getName, getNetworkInterfaces, getPrefixLengths, getSubnetMasks, isKnownVmMacAddr, queryNetworkInterface, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface oshi.hardware.NetworkIF

getIfAlias, getIfOperStatus, getNdisPhysicalMediumType, isConnectorPresent

Field Detail

LOG

private static final org.slf4j.Logger LOG

ifType

private int ifType

bytesRecv

private long bytesRecv

bytesSent

private long bytesSent

packetsRecv

private long packetsRecv

packetsSent

private long packetsSent

inErrors

private long inErrors

outErrors

private long outErrors

inDrops

private long inDrops

collisions

private long collisions

speed

private long speed

timeStamp

private long timeStamp

Constructor Detail

MacNetworkIF

public MacNetworkIF(java.net.NetworkInterface netint,
                    java.util.Map<java.lang.Integer,NetStat.IFdata> data)
             throws java.lang.InstantiationException

Throws:

java.lang.InstantiationException

Method Detail

queryIfDisplayName

private static java.lang.String queryIfDisplayName(java.net.NetworkInterface netint)

getNetworks

public static java.util.List<NetworkIF> getNetworks(boolean includeLocalInterfaces)

Gets all network interfaces on this machine

Parameters:

includeLocalInterfaces - include local interfaces in the result

Returns:

A list of NetworkIF objects representing the interfaces

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

getBytesRecv

public long getBytesRecv()

Description copied from interface: NetworkIF

Getter for the field bytesRecv.

Returns:

The Bytes Received.

This value is set when the NetworkIF is instantiated and may not be up to date. To update this value, execute the NetworkIF.updateAttributes() method

getBytesSent

public long getBytesSent()

Description copied from interface: NetworkIF

Getter for the field bytesSent.

Returns:

The Bytes Sent.

This value is set when the NetworkIF is instantiated and may not be up to date. To update this value, execute the NetworkIF.updateAttributes() method

getPacketsRecv

public long getPacketsRecv()

Description copied from interface: NetworkIF

Getter for the field packetsRecv.

Returns:

The Packets Received.

This value is set when the NetworkIF is instantiated and may not be up to date. To update this value, execute the NetworkIF.updateAttributes() method

getPacketsSent

public long getPacketsSent()

Description copied from interface: NetworkIF

Getter for the field packetsSent.

Returns:

The Packets Sent.

This value is set when the NetworkIF is instantiated and may not be up to date. To update this value, execute the NetworkIF.updateAttributes() method

getInErrors

public long getInErrors()

Description copied from interface: NetworkIF

Getter for the field inErrors.

Returns:

Input Errors.

This value is set when the NetworkIF is instantiated and may not be up to date. To update this value, execute the NetworkIF.updateAttributes() method

getOutErrors

public long getOutErrors()

Description copied from interface: NetworkIF

Getter for the field outErrors.

Returns:

The Output Errors.

This value is set when the NetworkIF is instantiated and may not be up to date. To update this value, execute the NetworkIF.updateAttributes() method

getInDrops

public long getInDrops()

Description copied from interface: NetworkIF

Getter for the field inDrops.

Returns:

Incoming/Received dropped packets. On Windows, returns discarded incoming packets.

This value is set when the NetworkIF is instantiated and may not be up to date. To update this value, execute the NetworkIF.updateAttributes() method

getCollisions

public long getCollisions()

Description copied from interface: NetworkIF

Getter for the field collisions.

Returns:

Packet collisions. On Windows, returns discarded outgoing packets.

This value is set when the NetworkIF is instantiated and may not be up to date. To update this value, execute the NetworkIF.updateAttributes() method

getSpeed

public long getSpeed()

Description copied from interface: NetworkIF

Getter for the field speed.

Returns:

The speed of the network interface in bits per second.

This value is set when the NetworkIF is instantiated and may not be up to date. To update this value, execute the NetworkIF.updateAttributes() method

getTimeStamp

public long getTimeStamp()

Description copied from interface: NetworkIF

Getter for the field timeStamp.

Returns:

Returns the timeStamp.

updateAttributes

public boolean updateAttributes()

Description copied from interface: NetworkIF

Updates interface network statistics on this interface. Statistics include packets and bytes sent and received, and interface speed.

Returns:

true if the update was successful, false otherwise.

updateNetworkStats

private boolean updateNetworkStats(java.util.Map<java.lang.Integer,NetStat.IFdata> data)

Updates interface network statistics on the given interface. Statistics include packets and bytes sent and received, and interface speed.

Parameters:

data - A map of network interface statistics with the index as the key

Returns:

true if the update was successful, false otherwise.