oshi.jna.platform.mac

Interface SystemB

All Superinterfaces:

CLibrary, com.sun.jna.Library, com.sun.jna.platform.mac.SystemB

public interface SystemB
extends CLibrary, com.sun.jna.platform.mac.SystemB

Power Supply stats. This class should be considered non-API as it may be removed if/when its code is incorporated into the JNA project.

Author:

widdis[at]gmail[dot]com

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SystemB.Group Return type for getgrgid
static class	SystemB.IFdata Data type as part of IFmsgHdr
static class	SystemB.IFdata64 Data type as part of IFmsgHdr
static class	SystemB.IFmsgHdr Return type for sysctl CTL_NET,PF_ROUTE
static class	SystemB.IFmsgHdr2 Return type for sysctl CTL_NET,PF_ROUTE
static class	SystemB.Passwd Return type for getpwuid
static class	SystemB.ProcBsdInfo
static class	SystemB.ProcTaskAllInfo
static class	SystemB.ProcTaskInfo
static class	SystemB.RUsageInfoV2
static class	SystemB.Statfs The statfs() routine returns information about a mounted file system.
static class	SystemB.XswUsage Return type for sysctl vm.swapusage

Nested classes/interfaces inherited from interface oshi.jna.platform.unix.CLibrary

CLibrary.Addrinfo, CLibrary.Sockaddr, CLibrary.Timeval

Nested classes/interfaces inherited from interface com.sun.jna.platform.mac.SystemB

com.sun.jna.platform.mac.SystemB.HostCpuLoadInfo, com.sun.jna.platform.mac.SystemB.HostLoadInfo, com.sun.jna.platform.mac.SystemB.VMStatistics, com.sun.jna.platform.mac.SystemB.VMStatistics64

Nested classes/interfaces inherited from interface com.sun.jna.Library

com.sun.jna.Library.Handler

Field Summary

Fields

Modifier and Type	Field and Description
static SystemB	INSTANCE
static int	MAXCOMLEN
static int	MAXPATHLEN
static int	MFSTYPENAMELEN
static int	MNAMELEN
static int	MNT_DWAIT
static int	MNT_NOWAIT
static int	MNT_WAIT
static int	PROC_ALL_PIDS
static int	PROC_PIDPATHINFO_MAXSIZE
static int	PROC_PIDTASKALLINFO
static int	PROC_PIDTASKINFO
static int	PROC_PIDTBSDINFO
static int	RUSAGE_INFO_V2

Fields inherited from interface oshi.jna.platform.unix.CLibrary

AI_CANONNAME

Fields inherited from interface com.sun.jna.platform.mac.SystemB

CPU_STATE_IDLE, CPU_STATE_MAX, CPU_STATE_NICE, CPU_STATE_SYSTEM, CPU_STATE_USER, HOST_CPU_LOAD_INFO, HOST_LOAD_INFO, HOST_VM_INFO, HOST_VM_INFO64, INT_SIZE, PROCESSOR_BASIC_INFO, PROCESSOR_CPU_LOAD_INFO, UINT64_SIZE

Fields inherited from interface com.sun.jna.Library

OPTION_ALLOW_OBJECTS, OPTION_CALLING_CONVENTION, OPTION_CLASSLOADER, OPTION_FUNCTION_MAPPER, OPTION_INVOCATION_MAPPER, OPTION_OPEN_FLAGS, OPTION_STRING_ENCODING, OPTION_STRUCTURE_ALIGNMENT, OPTION_TYPE_MAPPER

Method Summary

Modifier and Type	Method and Description
int	getfsstat64(SystemB.Statfs[] buf, int bufsize, int flags) The getfsstat() function returns information about all mounted file systems.
SystemB.Group	getgrgid(int gid) This function searches the group database for the given group name pointed to by the group id given by gid, returning the first one encountered.
SystemB.Passwd	getpwuid(int uid) This function searches the password database for the given user uid, always returning the first one encountered.
int	proc_listpids(int type, int typeinfo, int[] buffer, int buffersize) Search through the current processes
int	proc_pid_rusage(int pid, int flavor, SystemB.RUsageInfoV2 buffer) Return resource usage information for the given pid, which can be a live process or a zombie.
int	proc_pidinfo(int pid, int flavor, long arg, com.sun.jna.Structure buffer, int buffersize) Return in buffer a proc_*info structure corresponding to the flavor for the specified process
int	proc_pidpath(int pid, com.sun.jna.Pointer buffer, int buffersize) Return in buffer the name of the specified process

Methods inherited from interface oshi.jna.platform.unix.CLibrary

freeaddrinfo, gai_strerror, getaddrinfo, getloadavg, getpagesize, getpid, readlink, sysctl, sysctlbyname, sysctlnametomib

Methods inherited from interface com.sun.jna.platform.mac.SystemB

getloadavg, host_page_size, host_processor_info, host_statistics, host_statistics64, mach_host_self, mach_task_self, sysctl, sysctlbyname, sysctlnametomib

Field Detail

INSTANCE

static final SystemB INSTANCE

MAXCOMLEN

static final int MAXCOMLEN

See Also:

Constant Field Values

MAXPATHLEN

static final int MAXPATHLEN

See Also:

Constant Field Values

PROC_PIDPATHINFO_MAXSIZE

static final int PROC_PIDPATHINFO_MAXSIZE

See Also:

Constant Field Values

PROC_ALL_PIDS

static final int PROC_ALL_PIDS

See Also:

Constant Field Values

PROC_PIDTASKALLINFO

static final int PROC_PIDTASKALLINFO

See Also:

Constant Field Values

PROC_PIDTBSDINFO

static final int PROC_PIDTBSDINFO

See Also:

Constant Field Values

PROC_PIDTASKINFO

static final int PROC_PIDTASKINFO

See Also:

Constant Field Values

MFSTYPENAMELEN

static final int MFSTYPENAMELEN

See Also:

Constant Field Values

MNAMELEN

static final int MNAMELEN

See Also:

Constant Field Values

MNT_WAIT

static final int MNT_WAIT

See Also:

Constant Field Values

MNT_NOWAIT

static final int MNT_NOWAIT

See Also:

Constant Field Values

MNT_DWAIT

static final int MNT_DWAIT

See Also:

Constant Field Values

RUSAGE_INFO_V2

static final int RUSAGE_INFO_V2

See Also:

Constant Field Values

Method Detail

getpwuid

SystemB.Passwd getpwuid(int uid)

This function searches the password database for the given user uid, always returning the first one encountered.

Parameters:

uid - The user ID

Returns:

a Passwd structure matching that user

getgrgid

SystemB.Group getgrgid(int gid)

This function searches the group database for the given group name pointed to by the group id given by gid, returning the first one encountered. Identical group gids may result in undefined behavior.

Parameters:

gid - The group ID

Returns:

a Group structure matching that group

proc_listpids

int proc_listpids(int type,
                  int typeinfo,
                  int[] buffer,
                  int buffersize)

Search through the current processes

Parameters:

type - types of processes to be searched

typeinfo - adjunct information for type

buffer - a C array of int-sized values to be filled with process identifiers that hold an open file reference matching the specified path or volume. Pass NULL to obtain the minimum buffer size needed to hold the currently active processes.

buffersize - the size (in bytes) of the provided buffer.

Returns:

the number of bytes of data returned in the provided buffer; -1 if an error was encountered;

proc_pidinfo

int proc_pidinfo(int pid,
                 int flavor,
                 long arg,
                 com.sun.jna.Structure buffer,
                 int buffersize)

Return in buffer a proc_*info structure corresponding to the flavor for the specified process

Parameters:

pid - the process identifier

flavor - the type of information requested

arg - argument possibly needed for some flavors

buffer - holds results

buffersize - size of results

Returns:

the number of bytes of data returned in the provided buffer; -1 if an error was encountered;

proc_pidpath

int proc_pidpath(int pid,
                 com.sun.jna.Pointer buffer,
                 int buffersize)

Return in buffer the name of the specified process

Parameters:

pid - the process identifier

buffer - holds results

buffersize - size of results

Returns:

the length of the name returned in buffer if successful; 0 otherwise

proc_pid_rusage

int proc_pid_rusage(int pid,
                    int flavor,
                    SystemB.RUsageInfoV2 buffer)

Return resource usage information for the given pid, which can be a live process or a zombie.

Parameters:

pid - the process identifier

flavor - the type of information requested

buffer - holds results

Returns:

0 on success; or -1 on failure, with errno set to indicate the specific error.

getfsstat64

int getfsstat64(SystemB.Statfs[] buf,
                int bufsize,
                int flags)

The getfsstat() function returns information about all mounted file systems. The buf argument is a pointer to an array of statfs structures. Fields that are undefined for a particular file system are set to -1. The buffer is filled with an array of statfs structures, one for each mounted file system up to the size specified by bufsize.

Parameters:

buf - Array of statfs structures that will be filled with results. If buf is given as NULL, getfsstat() returns just the number of mounted file systems.

bufsize - Size of the buffer to fill

flags - If flags is set to MNT_NOWAIT, getfsstat() will directly return the information retained in the kernel to avoid delays caused by waiting for updated information from a file system that is perhaps temporarily unable to respond. Some of the information returned may be out of date, however; if flags is set to MNT_WAIT or MNT_DWAIT instead, getfsstat() will request updated information from each mounted filesystem before returning.

Returns:

Upon successful completion, the number of statfs structures is returned. Otherwise, -1 is returned and the global variable errno is set to indicate the error.