Class MacInternetProtocolStats

java.lang.Object

oshi.software.common.AbstractInternetProtocolStats

oshi.software.common.os.mac.MacInternetProtocolStats

All Implemented Interfaces:

InternetProtocolStats

@ThreadSafe
public abstract class MacInternetProtocolStats
extends AbstractInternetProtocolStats

Abstract base for the macOS InternetProtocolStats. The TCP/UDP statistics computation is shared; the JNA and FFM subclasses read the net.inet.*.stats sysctls into the MacInternetProtocolStats.BsdTcpstat/MacInternetProtocolStats.BsdUdpstat/MacInternetProtocolStats.BsdIpstat/ MacInternetProtocolStats.BsdIp6stat carriers, and supply their own native AbstractInternetProtocolStats.getConnections() implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MacInternetProtocolStats.BsdIp6stat	Selected fields of the macOS ip6stat structure.
static final class	MacInternetProtocolStats.BsdIpstat	Selected fields of the macOS ipstat structure.
static final class	MacInternetProtocolStats.BsdTcpstat	Selected fields of the macOS tcpstat structure.
static final class	MacInternetProtocolStats.BsdUdpstat	Selected fields of the macOS udpstat structure.

Nested classes/interfaces inherited from interface InternetProtocolStats

InternetProtocolStats.IPConnection, InternetProtocolStats.TcpState, InternetProtocolStats.TcpStats, InternetProtocolStats.UdpStats

Modifier and Type	Interface	Description
static final class	InternetProtocolStats.IPConnection	Encapsulates information associated with an IP connection.
static enum	InternetProtocolStats.TcpState	The TCP connection state as described in RFC 793.
static final class	InternetProtocolStats.TcpStats	Encapsulates statistics associated with a TCP connection.
static final class	InternetProtocolStats.UdpStats	Encapsulates statistics associated with a UDP connection.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MacInternetProtocolStats(boolean elevated)	Constructs a Mac InternetProtocolStats.

Method Summary

Modifier and Type	Method	Description
InternetProtocolStats.TcpStats	getTCPv4Stats()	Get the TCP stats for IPv4 connections.
InternetProtocolStats.TcpStats	getTCPv6Stats()	Get the TCP stats for IPv6 connections, if available.
InternetProtocolStats.UdpStats	getUDPv4Stats()	Get the UDP stats for IPv4 datagrams.
InternetProtocolStats.UdpStats	getUDPv6Stats()	Get the UDP stats for IPv6 datagrams, if available.
protected abstract MacInternetProtocolStats.BsdIp6stat	queryIp6stat()	Reads the net.inet6.ip6.stats sysctl into a carrier.
protected abstract MacInternetProtocolStats.BsdIpstat	queryIpstat()	Reads the net.inet.ip.stats sysctl into a carrier.
protected abstract MacInternetProtocolStats.BsdTcpstat	queryTcpstat()	Reads the net.inet.tcp.stats sysctl into a carrier.
protected abstract MacInternetProtocolStats.BsdUdpstat	queryUdpstat()	Reads the net.inet.udp.stats sysctl into a carrier.

Methods inherited from class AbstractInternetProtocolStats

getConnections

Modifier and Type	Method	Description
List<InternetProtocolStats.IPConnection>	getConnections()	Gets a list of TCP and UDP connections.

Methods inherited from class Object

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

Constructor Details

MacInternetProtocolStats

protected MacInternetProtocolStats(boolean elevated)

Constructs a Mac InternetProtocolStats.

Parameters:

elevated - whether running with elevated permissions

Method Details

queryTcpstat

protected abstract MacInternetProtocolStats.BsdTcpstat queryTcpstat()

Reads the net.inet.tcp.stats sysctl into a carrier.

Returns:

the TCP statistics

queryUdpstat

protected abstract MacInternetProtocolStats.BsdUdpstat queryUdpstat()

Reads the net.inet.udp.stats sysctl into a carrier.

Returns:

the UDP statistics

queryIpstat

protected abstract MacInternetProtocolStats.BsdIpstat queryIpstat()

Reads the net.inet.ip.stats sysctl into a carrier.

Returns:

the IP statistics

queryIp6stat

protected abstract MacInternetProtocolStats.BsdIp6stat queryIp6stat()

Reads the net.inet6.ip6.stats sysctl into a carrier.

Returns:

the IPv6 statistics

getTCPv4Stats

public InternetProtocolStats.TcpStats getTCPv4Stats()

Description copied from interface: InternetProtocolStats

Get the TCP stats for IPv4 connections.

On macOS connection information requires elevated permissions. Without elevated permissions, segment data is estimated.

Returns:

a InternetProtocolStats.TcpStats object encapsulating the stats.

getTCPv6Stats

public InternetProtocolStats.TcpStats getTCPv6Stats()

Description copied from interface: InternetProtocolStats

Get the TCP stats for IPv6 connections, if available. If not available separately, these may be 0 and included in IPv4 connections.

Specified by:

getTCPv6Stats in interface InternetProtocolStats

Overrides:

getTCPv6Stats in class AbstractInternetProtocolStats

Returns:

a InternetProtocolStats.TcpStats object encapsulating the stats.

getUDPv4Stats

public InternetProtocolStats.UdpStats getUDPv4Stats()

Description copied from interface: InternetProtocolStats

Get the UDP stats for IPv4 datagrams.

Returns:

a InternetProtocolStats.UdpStats object encapsulating the stats.

getUDPv6Stats

public InternetProtocolStats.UdpStats getUDPv6Stats()

Description copied from interface: InternetProtocolStats

Get the UDP stats for IPv6 datagrams, if available. If not available separately, these may be 0 and included in IPv4 datagrams.

Specified by:

getUDPv6Stats in interface InternetProtocolStats

Overrides:

getUDPv6Stats in class AbstractInternetProtocolStats

Returns:

a InternetProtocolStats.UdpStats object encapsulating the stats.