oshi.jna.platform.linux

Interface Libc

All Superinterfaces:

com.sun.jna.Library

public interface Libc
extends com.sun.jna.Library

Linux C Library. 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	Libc.Sysinfo

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 Libc	INSTANCE

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	getloadavg(double[] loadavg, int nelem) The getloadavg() function returns the number of processes in the system run queue averaged over various periods of time.
int	getpid() Returns the process ID of the calling process.
int	readlink(String path, com.sun.jna.Pointer buf, int bufsize) Places the contents of the symbolic link path in the buffer buf, which has size bufsiz.
int	sysinfo(Libc.Sysinfo info)

Field Detail

INSTANCE

static final Libc INSTANCE

Method Detail

sysinfo

int sysinfo(Libc.Sysinfo info)

getloadavg

int getloadavg(double[] loadavg,
               int nelem)

The getloadavg() function returns the number of processes in the system run queue averaged over various periods of time. Up to nelem samples are retrieved and assigned to successive elements of loadavg[]. The system imposes a maximum of 3 samples, representing averages over the last 1, 5, and 15 minutes, respectively.

Parameters:

loadavg - array to be filled

nelem - number of elements in the array to fill

Returns:

If the load average was unobtainable, -1 is returned; otherwise, the number of samples actually retrieved is returned.

getpid

int getpid()

Returns the process ID of the calling process. The ID is guaranteed to be unique and is useful for constructing temporary file names.

Returns:

the process ID of the calling process.

readlink

int readlink(String path,
             com.sun.jna.Pointer buf,
             int bufsize)

Places the contents of the symbolic link path in the buffer buf, which has size bufsiz.

Parameters:

path - A symbolic link

buf - Holds actual path to location pointed to by symlink

bufsize - size of data in buffer

Returns:

readlink() places the contents of the symbolic link path in the buffer buf, which has size bufsiz. readlink() does not append a null byte to buf. It will truncate the contents (to a length of bufsiz characters), in case the buffer is too small to hold all of the contents.