Package oshi.hardware.platform.windows

Class WindowsNetworkIF

java.lang.Object

oshi.hardware.common.AbstractNetworkIF

oshi.hardware.platform.windows.WindowsNetworkIF

All Implemented Interfaces:

NetworkIF

@ThreadSafe
public final class WindowsNetworkIF
extends AbstractNetworkIF

WindowsNetworks class.

Nested Class Summary

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

NetworkIF.IfOperStatus

Constructor Summary

Constructors

Constructor	Description
WindowsNetworkIF(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.
String	getIfAlias()	The ifAlias as described in RFC 2863.
NetworkIF.IfOperStatus	getIfOperStatus()	The ifOperStatus as described in RFC 2863.
int	getIfType()	(Windows, macOS) The NDIS Interface Type.
long	getInDrops()	Getter for the field inDrops.
long	getInErrors()	Getter for the field inErrors.
int	getNdisPhysicalMediumType()	(Windows Vista and higher only) The NDIS physical medium type.
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	isConnectorPresent()	(Windows Vista and higher) Set if a connector is present on the network interface.
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

Constructor Details

WindowsNetworkIF

public WindowsNetworkIF(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

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

getNdisPhysicalMediumType

public int getNdisPhysicalMediumType()

Description copied from interface: NetworkIF

(Windows Vista and higher only) The NDIS physical medium type. This member can be one of the values from the NDIS_PHYSICAL_MEDIUM enumeration type defined in the Ntddndis.h header file.

Returns:

the ndisPhysicalMediumType

isConnectorPresent

public boolean isConnectorPresent()

Description copied from interface: NetworkIF

(Windows Vista and higher) Set if a connector is present on the network interface.

(Linux) Indicates the current physical link state of the interface.

Returns:

true if there is a physical network adapter (Windows) or a connected cable (Linux), false otherwise

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.

getIfAlias

public String getIfAlias()

Description copied from interface: NetworkIF

The ifAlias as described in RFC 2863.

The ifAlias object allows a network manager to give one or more interfaces their own unique names, irrespective of any interface-stack relationship. Further, the ifAlias name is non-volatile, and thus an interface must retain its assigned ifAlias value across reboots, even if an agent chooses a new ifIndex value for the interface.

Only implemented for Windows (Vista and newer) and Linux.

Returns:

The ifAlias of the interface if available, otherwise the empty string.

getIfOperStatus

public NetworkIF.IfOperStatus getIfOperStatus()

Description copied from interface: NetworkIF

The ifOperStatus as described in RFC 2863.

Only implemented for Windows (Vista and newer) and Linux.

Returns:

The current operational state of the interface.

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.