Module com.github.oshi

Package oshi.hardware.platform.unix

Class BsdNetworkIF

java.lang.Object

oshi.hardware.common.AbstractNetworkIF

oshi.hardware.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 oshi.hardware.NetworkIF

NetworkIF.IfOperStatus

Constructor Summary

Constructors

Constructor	Description
BsdNetworkIF(NetworkInterface netint)

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.
long	getInDrops()	Getter for the field inDrops.
long	getInErrors()	Getter for the field inErrors.
static 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.
boolean	updateAttributes()	Updates interface network statistics on this 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, getIfType, getNdisPhysicalMediumType, isConnectorPresent

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

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.