NetworkIF (oshi-core 3.5.0 API)

java.lang.Object
- oshi.hardware.NetworkIF

All Implemented Interfaces:

Serializable
```
public class NetworkIF
extends Object
implements Serializable
```
A network interface in the machine, including statistics

Author:

enrico[dot]bianchi[at]gmail[dot]com

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

NetworkIF()

Constructors
Constructor and Description
`NetworkIF()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`getBytesRecv()`
`long`	`getBytesSent()`
`String`	`getDisplayName()`
`long`	`getInErrors()`
`String[]`	`getIPv4addr()`
`String[]`	`getIPv6addr()`
`String`	`getMacaddr()`
`int`	`getMTU()`
`String`	`getName()`
`NetworkInterface`	`getNetworkInterface()`
`long`	`getOutErrors()`
`long`	`getPacketsRecv()`
`long`	`getPacketsSent()`
`long`	`getSpeed()`
`long`	`getTimeStamp()`
`void`	`setBytesRecv(long bytesRecv)`
`void`	`setBytesSent(long bytesSent)`
`void`	`setInErrors(long inErrors)`
`void`	`setNetworkInterface(NetworkInterface networkInterface)` Sets the network interface and calculates other information derived from it
`void`	`setOutErrors(long outErrors)`
`void`	`setPacketsRecv(long packetsRecv)`
`void`	`setPacketsSent(long packetsSent)`
`void`	`setSpeed(long speed)`
`void`	`setTimeStamp(long timeStamp)`
`void`	`updateNetworkStats()` Updates interface network statistics on this interface.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - NetworkIF
```
public NetworkIF()
```
- Method Detail
  - getNetworkInterface
```
public NetworkInterface getNetworkInterface()
```
    Returns:
    
    the network interface
  - setNetworkInterface
```
public void setNetworkInterface(NetworkInterface networkInterface)
```
    Sets the network interface and calculates other information derived from it
    
    Parameters:
    
    networkInterface - The network interface to set
  - getName
```
public String getName()
```
    Returns:
    
    The interface name.
  - getDisplayName
```
public String getDisplayName()
```
    Returns:
    
    The description of the network interface. On some platforms, this is identical to the name.
  - getMTU
```
public int getMTU()
```
    Returns:
    
    The MTU of the network interface. This value is set when the NetworkIF is instantiated and may not be up to date. To update this value, execute the setNetworkInterface(NetworkInterface) method
  - getMacaddr
```
public String getMacaddr()
```
    Returns:
    
    The MAC Address. This value is set when the NetworkIF is instantiated and may not be up to date. To update this value, execute the setNetworkInterface(NetworkInterface) method
  - getIPv4addr
```
public String[] getIPv4addr()
```
    Returns:
    
    The IPv4 Addresses. This value is set when the NetworkIF is instantiated and may not be up to date. To update this value, execute the setNetworkInterface(NetworkInterface) method
  - getIPv6addr
```
public String[] getIPv6addr()
```
    Returns:
    
    The IPv6 Addresses. This value is set when the NetworkIF is instantiated and may not be up to date. To update this value, execute the setNetworkInterface(NetworkInterface) method
  - getBytesRecv
```
public long getBytesRecv()
```
    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 updateNetworkStats() method
  - setBytesRecv
```
public void setBytesRecv(long bytesRecv)
```
    Parameters:
    
    bytesRecv - Set Bytes Received
  - getBytesSent
```
public long getBytesSent()
```
    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 updateNetworkStats() method
  - setBytesSent
```
public void setBytesSent(long bytesSent)
```
    Parameters:
    
    bytesSent - Set the Bytes Sent
  - getPacketsRecv
```
public long getPacketsRecv()
```
    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 updateNetworkStats() method
  - setPacketsRecv
```
public void setPacketsRecv(long packetsRecv)
```
    Parameters:
    
    packetsRecv - Set The Packets Received
  - getPacketsSent
```
public long getPacketsSent()
```
    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 updateNetworkStats() method
  - setPacketsSent
```
public void setPacketsSent(long packetsSent)
```
    Parameters:
    
    packetsSent - Set The Packets Sent
  - getInErrors
```
public long getInErrors()
```
    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 updateNetworkStats() method
  - setInErrors
```
public void setInErrors(long inErrors)
```
    Parameters:
    
    inErrors - The Input Errors to set.
  - getOutErrors
```
public long getOutErrors()
```
    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 updateNetworkStats() method
  - setOutErrors
```
public void setOutErrors(long outErrors)
```
    Parameters:
    
    outErrors - The Output Errors to set.
  - getSpeed
```
public long getSpeed()
```
    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 updateNetworkStats() method
  - setSpeed
```
public void setSpeed(long speed)
```
    Parameters:
    
    speed - Set the speed of the network interface
  - getTimeStamp
```
public long getTimeStamp()
```
    Returns:
    
    Returns the timeStamp.
  - setTimeStamp
```
public void setTimeStamp(long timeStamp)
```
    Parameters:
    
    timeStamp - The timeStamp to set.
  - updateNetworkStats
```
public void updateNetworkStats()
```
    Updates interface network statistics on this interface. Statistics include packets and bytes sent and received, and interface speed.

Class NetworkIF

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NetworkIF

Method Detail

getNetworkInterface

setNetworkInterface

getName

getDisplayName

getMTU

getMacaddr

getIPv4addr

getIPv6addr

getBytesRecv

setBytesRecv

getBytesSent

setBytesSent

getPacketsRecv

setPacketsRecv

getPacketsSent

setPacketsSent

getInErrors

setInErrors

getOutErrors

setOutErrors

getSpeed

setSpeed

getTimeStamp

setTimeStamp

updateNetworkStats