Class BsdNetworkIF

java.lang.Object

oshi.hardware.common.AbstractNetworkIF

oshi.hardware.common.platform.unix.BsdNetworkIF

All Implemented Interfaces:

NetworkIF

@ThreadSafe
public final class BsdNetworkIF
extends AbstractNetworkIF

BsdNetworkIF applicable to FreeBSD and OpenBSD.

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

Constructor	Description
BsdNetworkIF(NetworkInterface netint)

Method Summary

Modifier and Type	Method	Description
static List<NetworkIF>	getNetworks(boolean includeLocalInterfaces)	Gets all network interfaces on this machine
boolean	updateAttributes()	Updates interface network statistics on this interface.

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, getIfType, getNdisPhysicalMediumType, isConnectorPresent

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	getIfType()	(Windows, macOS) The NDIS Interface Type.
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.

Constructor Details

BsdNetworkIF

public BsdNetworkIF(NetworkInterface netint)
             throws InstantiationException

Throws:

InstantiationException

Method Details

getNetworks

public static 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

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.

This method is intended for updating a single interface that is being individually monitored. If you are updating multiple interfaces, it is more efficient to re-query the entire list from HardwareAbstractionLayer.getNetworkIFs() and correlate the results, since on many platforms the full list must be queried to provide any individual result.

Returns:

true if the update was successful, false otherwise.