Modifier and Type	Class and Description
public static class	LibCAPI.size_t This is an unsigned integer type used to represent the sizes of objects.
public static class	LibCAPI.ssize_t This is a signed integer type used for a count of bytes or an error indication.

Modifier and Type	Field and Description
public static final int	HOST_NAME_MAX

Method Summary

Modifier and Type	Method and Description
public int	Returns: returns zero on success. On error, -1 is returned, and `errno` is set appropriately. `close()` should not be retried after an error. close(int a file descriptor fd) Closes a file descriptor, so that it no longer refers to any file and may be reused.
public int	getdomainname(byte[] name, int len)
public int	getegid()
public String	Returns: Returns the value in the environment, or `null` if there is no match for the name getenv(String Environment variable name name)
public int	geteuid()
public int	getgid()
public int	gethostname(byte[] name, int len)
public int	Returns: If the load average was unobtainable, -1 is returned; otherwise, the number of samples actually retrieved is returned. getloadavg(double[] An array of doubles which will be filled with the results loadavg, int Number of samples to return nelem) The getloadavg() function returns the number of processes in the system run queue averaged over various periods of time.
public int	getuid()
public int	Returns: On success, zero is returned. On error, -1 is returned, and `errno` is set appropriately. msync(Pointer The start of the memory area to sync to the filesystem. addr, LibCAPI.size_t The length of the memory area to sync to the filesystem. length, int The flags argument should specify exactly one of `MS_ASYNC` and `MS_SYNC`, and may additionally include the `MS_INVALIDATE` bit. flags) Flushes changes made to the in-core copy of a file that was mapped into memory using `LibCUtil#mmap(Pointer, long, int, int, int, long)` back to the filesystem.
public int	Returns: On success, returns 0. On failure, it returns -1, and `errno` is set to indicate the cause of the error (probably to `EINVAL`). munmap(Pointer The base address from which to delete mappings. The address addr must be a multiple of the page size (but length need not be). addr, LibCAPI.size_t The length from the base address to delete mappings. All pages containing a part of the indicated range are unmapped, and subsequent references to these pages will generate `SIGSEGV`. length) Deletes the mappings for the specified address range, and causes further references to addresses within the range to generate invalid memory references.
public int	setdomainname(String name, int len)
public int	setegid(int gid)
public int	Returns: Upon successful completion, zero shall be returned. Otherwise, -1 shall be returned, `errno` set to indicate the error, and the environment shall be unchanged setenv(String Environment variable name name, String Required value value, int If the environment variable already exists and the value of `overwrite` is non-zero, the function shall return success and the environment shall be updated. If the environment variable already exists and the value of `overwrite` is zero, the function shall return success and the environment shall remain unchanged. overwrite) Update or add a variable in the environment of the calling process.
public int	seteuid(int uid)
public int	setgid(int gid)
public int	sethostname(String name, int len)
public int	setuid(int uid)
public int	Returns: Upon successful completion, zero shall be returned. Otherwise, -1 shall be returned, `errno` set to indicate the error, and the environment shall be unchanged unsetenv(String Environment variable name - If the named variable does not exist in the current environment, the environment shall be unchanged and the function is considered to have completed successfully. name)

Inherited from com.sun.jna.platform.unix.Reboot:: reboot
Inherited from com.sun.jna.platform.unix.Resource:: getrlimit setrlimit

Field Detail

HOST_NAME_MAX	back to summary
public static final int HOST_NAME_MAX

Method Detail

close back to summary

close	back to summary
public int close(int fd) Closes a file descriptor, so that it no longer refers to any file and may be reused. Any record locks held on the file it was associated with, and owned by the process, are removed (regardless of the file descriptor that was used to obtain the lock). If `fd` is the last file descriptor referring to the underlying open file description, the resources associated with the open file description are freed; if the file descriptor was the last reference to a file which has been removed using `unlink`, the file is deleted. Parameters fd:int a file descriptor Returns:int returns zero on success. On error, -1 is returned, and `errno` is set appropriately. `close()` should not be retried after an error.

public int close(int fd)

Closes a file descriptor, so that it no longer refers to any file and may be reused. Any record locks held on the file it was associated with, and owned by the process, are removed (regardless of the file descriptor that was used to obtain the lock).

If fd is the last file descriptor referring to the underlying open file description, the resources associated with the open file description are freed; if the file descriptor was the last reference to a file which has been removed using unlink, the file is deleted.

Parameters

fd:int: a file descriptor

Returns:int

returns zero on success. On error, -1 is returned, and errno is set appropriately.

close() should not be retried after an error.

getdomainname	back to summary
public int getdomainname(byte[] name, int len)

getegid	back to summary
public int getegid()

getenv	back to summary
public String getenv(String name) Parameters name:String Environment variable name Returns:String Returns the value in the environment, or `null` if there is no match for the name See Also getenv(3)

geteuid	back to summary
public int geteuid()

getgid	back to summary
public int getgid()

gethostname	back to summary
public int gethostname(byte[] name, int len)

getloadavg	back to summary
public 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:double[] An array of doubles which will be filled with the results nelem:int Number of samples to return Returns:int If the load average was unobtainable, -1 is returned; otherwise, the number of samples actually retrieved is returned. See Also getloadavg(3)

getloadavg

back to summary

public 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:double[]: An array of doubles which will be filled with the results
nelem:int: Number of samples to return

Returns:int

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

See Also

getloadavg(3)

getuid	back to summary
public int getuid()

msync back to summary

msync	back to summary
public int msync(Pointer addr, LibCAPI.size_t length, int flags) Flushes changes made to the in-core copy of a file that was mapped into memory using `LibCUtil#mmap(Pointer, long, int, int, int, long)` back to the filesystem. Without use of this call, there is no guarantee that changes are written back before `munmap(Pointer, size_t)` is called. To be more precise, the part of the file that corresponds to the memory area starting at `addr` and having length `length` is updated. Parameters addr:Pointer The start of the memory area to sync to the filesystem. length:LibCAPI.size_t The length of the memory area to sync to the filesystem. flags:int The flags argument should specify exactly one of `MS_ASYNC` and `MS_SYNC`, and may additionally include the `MS_INVALIDATE` bit. Returns:int On success, zero is returned. On error, -1 is returned, and `errno` is set appropriately.

public int msync(Pointer addr, LibCAPI.size_t length, int flags)

Flushes changes made to the in-core copy of a file that was mapped into memory using LibCUtil#mmap(Pointer, long, int, int, int, long) back to the filesystem. Without use of this call, there is no guarantee that changes are written back before munmap(Pointer, size_t) is called. To be more precise, the part of the file that corresponds to the memory area starting at addr and having length length is updated.

Parameters

addr:Pointer: The start of the memory area to sync to the filesystem.
length:LibCAPI.size_t: The length of the memory area to sync to the filesystem.
flags:int: The flags argument should specify exactly one of MS_ASYNC and MS_SYNC, and may additionally include the MS_INVALIDATE bit.

Returns:int

On success, zero is returned. On error, -1 is returned, and errno is set appropriately.

munmap back to summary

munmap	back to summary
public int munmap(Pointer addr, LibCAPI.size_t length) Deletes the mappings for the specified address range, and causes further references to addresses within the range to generate invalid memory references. The region is also automatically unmapped when the process is terminated. On the other hand, closing the file descriptor does not unmap the region. It is not an error if the indicated range does not contain any mapped pages. Parameters addr:Pointer The base address from which to delete mappings. The address addr must be a multiple of the page size (but length need not be). length:LibCAPI.size_t The length from the base address to delete mappings. All pages containing a part of the indicated range are unmapped, and subsequent references to these pages will generate `SIGSEGV`. Returns:int On success, returns 0. On failure, it returns -1, and `errno` is set to indicate the cause of the error (probably to `EINVAL`).

public int munmap(Pointer addr, LibCAPI.size_t length)

Deletes the mappings for the specified address range, and causes further references to addresses within the range to generate invalid memory references. The region is also automatically unmapped when the process is terminated. On the other hand, closing the file descriptor does not unmap the region.

It is not an error if the indicated range does not contain any mapped pages.

Parameters

addr:Pointer: The base address from which to delete mappings. The address addr must be a multiple of the page size (but length need not be).
length:LibCAPI.size_t: The length from the base address to delete mappings. All pages containing a part of the indicated range are unmapped, and subsequent references to these pages will generate SIGSEGV.

Returns:int

On success, returns 0. On failure, it returns -1, and errno is set to indicate the cause of the error (probably to EINVAL).

setdomainname	back to summary
public int setdomainname(String name, int len)

setegid	back to summary
public int setegid(int gid)

setenv back to summary

setenv	back to summary
public int setenv(String name, String value, int overwrite) Update or add a variable in the environment of the calling process. Parameters name:String Environment variable name value:String Required value overwrite:int If the environment variable already exists and the value of `overwrite` is non-zero, the function shall return success and the environment shall be updated. If the environment variable already exists and the value of `overwrite` is zero, the function shall return success and the environment shall remain unchanged. Returns:int Upon successful completion, zero shall be returned. Otherwise, -1 shall be returned, `errno` set to indicate the error, and the environment shall be unchanged See Also getenv(3)

public int setenv(String name, String value, int overwrite)

Update or add a variable in the environment of the calling process.

Parameters

name:String: Environment variable name
value:String: Required value
overwrite:int: If the environment variable already exists and the value of overwrite is non-zero, the function shall return success and the environment shall be updated. If the environment variable already exists and the value of overwrite is zero, the function shall return success and the environment shall remain unchanged.

Returns:int

Upon successful completion, zero shall be returned. Otherwise, -1 shall be returned, errno set to indicate the error, and the environment shall be unchanged

See Also

getenv(3)

seteuid	back to summary
public int seteuid(int uid)

setgid	back to summary
public int setgid(int gid)

sethostname	back to summary
public int sethostname(String name, int len)

setuid	back to summary
public int setuid(int uid)

unsetenv back to summary

unsetenv	back to summary
public int unsetenv(String name) Parameters name:String Environment variable name - If the named variable does not exist in the current environment, the environment shall be unchanged and the function is considered to have completed successfully. Returns:int Upon successful completion, zero shall be returned. Otherwise, -1 shall be returned, `errno` set to indicate the error, and the environment shall be unchanged See Also getenv(3)

public int unsetenv(String name)

Parameters

name:String: Environment variable name - If the named variable does not exist in the current environment, the environment shall be unchanged and the function is considered to have completed successfully.

Returns:int

Upon successful completion, zero shall be returned. Otherwise, -1 shall be returned, errno set to indicate the error, and the environment shall be unchanged

See Also

getenv(3)

com.sun.jna.platform.unix back to summary

public Class LibCAPI.size_t

Class Inheritance

extends IntegerType

java.lang.Object
java.lang.Number
com.sun.jna.IntegerType
com.sun.jna.platform.unix.LibCAPI.size_t

This is an unsigned integer type used to represent the sizes of objects.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	LibCAPI.size_t.ByReference

Field Summary

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides com.sun.jna.IntegerType.serialVersionUID.
public static final LibCAPI.size_t	ZERO

Constructor Summary

Access	Constructor and Description
public	size_t()
public	size_t(long value)

Method Summary

Inherited from com.sun.jna.IntegerType:: compare compare compare doubleValue equals floatValue fromNative hashCode intValue longValue nativeType setValue toNative toString

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID Hides com.sun.jna.IntegerType.serialVersionUID.

ZERO	back to summary
public static final LibCAPI.size_t ZERO

Constructor Detail

size_t	back to summary
public size_t()

size_t	back to summary
public size_t(long value)

com.sun.jna.platform.unix back to summary

public Class LibCAPI.size_t.ByReference

Class Inheritance

extends ByReference

java.lang.Object
com.sun.jna.PointerType
com.sun.jna.ptr.ByReference
com.sun.jna.platform.unix.LibCAPI.size_t.ByReference

Constructor Summary

Access	Constructor and Description
public	ByReference()
public	ByReference(long value)
public	ByReference(LibCAPI.size_t value)

Method Summary

Modifier and Type	Method and Description
public LibCAPI.size_t	getValue()
public long	longValue()
public void	setValue(long value)
public void	setValue(LibCAPI.size_t value)

Inherited from com.sun.jna.ptr.ByReference:: toString

Constructor Detail

ByReference	back to summary
public ByReference()

ByReference	back to summary
public ByReference(long value)

ByReference	back to summary
public ByReference(LibCAPI.size_t value)

Method Detail

getValue	back to summary
public LibCAPI.size_t getValue()

longValue	back to summary
public long longValue()

setValue	back to summary
public void setValue(long value)

setValue	back to summary
public void setValue(LibCAPI.size_t value)

public Interface LibCAPI

Nested and Inner Type Summary

Field Summary

Method Summary

Field Detail

Method Detail

public Class LibCAPI.size_t

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

public Class LibCAPI.size_t.ByReference

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public Class LibCAPI.ssize_t

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides com.sun.jna.IntegerType.serialVersionUID.
public static final LibCAPI.ssize_t	ZERO