Module de.ibapl.jnhw.posix

Package de.ibapl.jnhw.posix

Class Unistd

java.lang.Object

de.ibapl.jnhw.posix.Unistd

@Include("#include <unistd.h>")
public final class Unistd
extends Object

Wrapper around the <stdio.h> header. See specs at: unistd.h - standard symbolic constants and types.

Author:

aploese

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Unistd.JnhwPrimitiveArrayCritical

Field Summary

Fields

Modifier and Type	Field	Description
static int	_POSIX_VERSION	POSIX: Integer value indicating version of this standard (C-language binding) to which the implementation conforms.
static boolean	HAVE_UNISTD_H
static int	SEEK_CUR	POSIX:seek relative to current position.
static IntDefine	SEEK_DATA	Linux,Apple: Adjust the file offset to the next location in the file greater than or equal to offset containing data.
static int	SEEK_END	POSIX: Seek relative to end-of-file.
static IntDefine	SEEK_HOLE	POSIX: Adjust the file offset to the next hole in the file greater than or equal to offset.
static int	SEEK_SET	POSIX: Seek relative to start-of-file.
static int	STDERR_FILENO	POSIX: File number of stderr; 2.
static int	STDIN_FILENO	POSIX: File number of stdin; 0.
static int	STDOUT_FILENO	POSIX: File number of stdout; 1.

Method Summary

Modifier and Type	Method	Description
static void	close(int fildes)	POSIX: close - close a file descriptor.
static void	fsync(int fildes)	POSIX: fsync - synchronize changes to a file.
static int	getegid()	POSIX: getegid - get the effective group ID.
static int	geteuid()	POSIX: geteuid - get the effective user ID.
static int	getgid()	POSIX: getgid - get the real group ID.
static int	getpgrp()	POSIX: getpgrp - get the process group ID of the calling process.
static int	getpid()	POSIX: getpid - get the process ID.
static int	getppid()	POSIX: getppid - get the parent process ID.
static int	getuid()	POSIX: getuid - get a real user ID.
static boolean	jnhwIsSingeByteRead(short nread)
static byte	jnhwSingeByteReadToByte(short nread)
static int	jnhwSingeByteReadToInt(short nread)
static int	lseek(int fildes, int offset, int whence)	POSIX: lseek - move the read/write file offset.
static long	lseek(int fildes, long offset, int whence)	POSIX: lseek - move the read/write file offset.
static long	lseek64(int fildes, long offset, int whence)	Linux: Available if _LARGEFILE64_SOURCE is defined.
static void	pipe(IntRef read_fd, IntRef write_fd)	POSIX: pipe - create an interprocess channel.
static short	read(int fildes)	POSIX: pread, read - read from a file.
static int	read(int fildes, byte[] buf)	POSIX: pread, read - read from a file.
static int	read(int fildes, byte[] buf, int off, int nbyte)	POSIX: pread, read - read from a file.
static int	read(int fildes, OpaqueMemory32 mem)	POSIX: pread, read - read from a file.
static int	read(int fildes, OpaqueMemory32 mem, int off, int nbyte)	POSIX: pread, read - read from a file.
static long	read(int fildes, OpaqueMemory64 mem)	POSIX: pread, read - read from a file.
static long	read(int fildes, OpaqueMemory64 mem, long off, long nbyte)	POSIX: pread, read - read from a file.
static int	read(int fildes, ByteRef data)	POSIX: pread, read - read from a file.
static int	read(int fildes, ByteBuffer buffer)	POSIX: pread, read - read from a file.
static void	setegid(int gid)	POSIX: setegid - set effective user ID.
static void	seteuid(int uid)	POSIX: seteuid - set effective user ID.
static void	setgid(int gid)	POSIX: setgid - set group ID.
static void	setregid(int rgid, int egid)	POSIX: setregid - set real and effective group IDs.
static void	setreuid(int ruid, int euid)	POSIX: setreuid - set real and effective user IDs.
static void	setuid(int uid)	POSIX: setuid - set user ID.
static void	usleep(int usleep)	LINUX,APPLE,BSD: usleep - suspend execution for an interval.
static int	write(int fildes, byte data)	POSIX: pwrite, write - write on a file.
static int	write(int fildes, byte[] buf)	POSIX: pwrite, write - write on a file.
static int	write(int fildes, byte[] buf, int off, int nbyte)	POSIX: pwrite, write - write on a file.
static int	write(int fildes, OpaqueMemory32 mem)	POSIX: pwrite, write - write on a file.
static int	write(int fildes, OpaqueMemory32 mem, int off, int nbyte)	POSIX: pwrite, write - write on a file.
static long	write(int fildes, OpaqueMemory64 mem)	POSIX: pwrite, write - write on a file.
static long	write(int fildes, OpaqueMemory64 mem, long off, long nbyte)	POSIX: pwrite, write - write on a file.
static int	write(int fildes, ByteBuffer buffer)	POSIX: pwrite, write - write on a file.

Methods inherited from class java.lang.Object

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

Field Detail

HAVE_UNISTD_H

public static final boolean HAVE_UNISTD_H

SEEK_CUR

@Define
public static int SEEK_CUR

POSIX:seek relative to current position. This must be the same value as {@link de.ibapl.jnhw.posix.Stdio.SEEK_CUR()}.

SEEK_DATA

@Define
public static IntDefine SEEK_DATA

Linux,Apple: Adjust the file offset to the next location in the file greater than or equal to offset containing data.

SEEK_END

@Define
public static int SEEK_END

POSIX: Seek relative to end-of-file. This must be the same value as de.ibapl.jnhw.posix.Stdio.SEEK_END.

SEEK_HOLE

@Define
public static IntDefine SEEK_HOLE

POSIX: Adjust the file offset to the next hole in the file greater than or equal to offset.

SEEK_SET

@Define
public static int SEEK_SET

POSIX: Seek relative to start-of-file. This must be the same value as de.ibapl.jnhw.posix.Stdio.SEEK_SET.

STDERR_FILENO

@Define
public static final int STDERR_FILENO

POSIX: File number of stderr; 2.

STDIN_FILENO

@Define
public static final int STDIN_FILENO

POSIX: File number of stdin; 0.

STDOUT_FILENO

@Define
public static final int STDOUT_FILENO

POSIX: File number of stdout; 1.

_POSIX_VERSION

@Define
public static int _POSIX_VERSION

POSIX: Integer value indicating version of this standard (C-language binding) to which the implementation conforms.

Method Detail

close

public static final void close(int fildes)
                        throws NativeErrorException

POSIX: close - close a file descriptor.

Parameters:

fildes - an open file descriptor.

Throws:

NativeErrorException - if the return value of the native function indicates an error.

fsync

public static final void fsync(int fildes)
                        throws NativeErrorException

POSIX: fsync - synchronize changes to a file.

Parameters:

fildes - a valid filedescriptor.

Throws:

NativeErrorException - if the return value of the native function indicates an error.

getgid

public static final int getgid()

POSIX: getgid - get the real group ID.

Returns:

the real group ID

getegid

public static final int getegid()

POSIX: getegid - get the effective group ID.

setgid

public static final void setgid(int gid)
                         throws NativeErrorException

POSIX: setgid - set group ID.

Throws:

NativeErrorException - if the return value of the native function indicates an error.

setegid

public static final void setegid(int gid)
                          throws NativeErrorException

POSIX: setegid - set effective user ID.

Throws:

NativeErrorException - if the return value of the native function indicates an error.

setregid

public static final void setregid(int rgid,
                                  int egid)
                           throws NativeErrorException

POSIX: setregid - set real and effective group IDs.

Throws:

NativeErrorException - if the return value of the native function indicates an error.

geteuid

public static final int geteuid()

POSIX: geteuid - get the effective user ID.

seteuid

public static final void seteuid(int uid)
                          throws NativeErrorException

POSIX: seteuid - set effective user ID.

Throws:

NativeErrorException - if the return value of the native function indicates an error.

getpgrp

public static final int getpgrp()

POSIX: getpgrp - get the process group ID of the calling process.

getpid

public static final int getpid()

POSIX: getpid - get the process ID.

getppid

public static final int getppid()

POSIX: getppid - get the parent process ID.

setreuid

public static final void setreuid(int ruid,
                                  int euid)
                           throws NativeErrorException

POSIX: setreuid - set real and effective user IDs.

Throws:

NativeErrorException - if the return value of the native function indicates an error.

getuid

public static final int getuid()

POSIX: getuid - get a real user ID.

setuid

public static final void setuid(int uid)
                         throws NativeErrorException

POSIX: setuid - set user ID.

Throws:

NativeErrorException - if the return value of the native function indicates an error.

lseek

public static final int lseek(int fildes,
                              int offset,
                              int whence)
                       throws NativeErrorException

POSIX: lseek - move the read/write file offset.

Parameters:

fildes - a valid file descriptor.

offset - depending on the size of @see SizeOf.off_t int or long may be used.

whence - one of SEEK_SET, SEEK_CUR, SEEK_END.

Returns:

the position depending on the size of @see SizeOf.off_t int or long may be used.

Throws:

NativeErrorException - if the return value of the native function indicates an error.

lseek

public static final long lseek(int fildes,
                               long offset,
                               int whence)
                        throws NativeErrorException

POSIX: lseek - move the read/write file offset.

Parameters:

fildes - a valid file descriptor.

offset - depending on the size of @see SizeOf.off_t int or long may be used.

whence - one of SEEK_SET, SEEK_CUR, SEEK_END.

Returns:

the position depending on the size of @see SizeOf.off_t int or long may be used.

Throws:

IndexOutOfBoundsException - if offset is greater or smaller as the native off_t can hold.

NativeErrorException - if the return value of the native function indicates an error.

lseek64

public static final long lseek64(int fildes,
                                 long offset,
                                 int whence)
                          throws NativeErrorException,
                                 NoSuchNativeMethodException

Linux: Available if _LARGEFILE64_SOURCE is defined. lseek - move the read/write file offset.

Parameters:

fildes - a valid file descriptor.

offset - alway 64 bit.

whence - one of SEEK_SET, SEEK_CUR, SEEK_END.

Returns:

the position depending on the size of @see SizeOf.off_t int or long may be used.

Throws:

NativeErrorException - if the return value of the native function indicates an error.

NoSuchNativeMethodException - if _LARGEFILE64_SOURCE is not defined.

pipe

public static final void pipe(IntRef read_fd,
                              IntRef write_fd)
                       throws NativeErrorException

POSIX: pipe - create an interprocess channel.

Parameters:

read_fd - the file descriptor for reading

write_fd - the file descriptor for writing

Throws:

NullPointerException - if read_fd or write_fd is null.

NativeErrorException - if the return value of the native function indicates an error.

read

public static final int read(int fildes,
                             byte[] buf)
                      throws NativeErrorException

POSIX: pread, read - read from a file.

Parameters:

fildes - a valid file descriptor open for reading

buf - the byte array into which all bytes are to be transferred.

Returns:

The number of bytes read, possibly zero.

Throws:

NullPointerException - if buf is null.

NativeErrorException - if the return value of the native function indicates an error.

read

public static final int read(int fildes,
                             byte[] buf,
                             int off,
                             int nbyte)
                      throws NativeErrorException

POSIX: pread, read - read from a file.

Parameters:

fildes - a valid file descriptor open for reading

buf - the byte array into which bytes are to be transferred.

off - the start offset in buf to which the data is transferred.

nbyte - the maximum number of bytes to read.

Returns:

The number of bytes read, possibly zero.

Throws:

NullPointerException - if buf is null.

ArrayIndexOutOfBoundsException - if off or nByte out of bounds.

NativeErrorException - if the return value of the native function indicates an error.

read

public static final int read(int fildes,
                             ByteBuffer buffer)
                      throws NativeErrorException

POSIX: pread, read - read from a file. Read the bytes between Buffer.position() and Buffer.limit() from the file. After sucessful reading, position is updated accordingly to the number of bytes read.

Parameters:

fildes - a valid file descriptor open for reading

buffer - the ByteBuffer into which bytes are to be transferred between position and limit.

Returns:

The number of bytes read, possibly zero.

Throws:

NullPointerException - if buffer is null.

NativeErrorException - if the return value of the native function indicates an error.

read

public static final int read(int fildes,
                             OpaqueMemory32 mem,
                             int off,
                             int nbyte)
                      throws NativeErrorException

POSIX: pread, read - read from a file.

Parameters:

fildes - a valid file descriptor open for reading

mem - the OpaqueMemory32 into which bytes are to be transferred.

off - the start offset in mem to which the data is transferred.

nbyte - the maximum number of bytes to read.

Returns:

The number of bytes read, possibly zero.

Throws:

NullPointerException - if mem is null.

ArrayIndexOutOfBoundsException - if off or nByte out of bounds.

NativeErrorException - if the return value of the native function indicates an error.

read

public static final long read(int fildes,
                              OpaqueMemory64 mem,
                              long off,
                              long nbyte)
                       throws NativeErrorException

POSIX: pread, read - read from a file.

Parameters:

fildes - a valid file descriptor open for reading

mem - the OpaqueMemory64 into which bytes are to be transferred.

off - the start offset in mem to which the data is transferred.

nbyte - the maximum number of bytes to read.

Returns:

The number of bytes read, possibly zero.

Throws:

NullPointerException - if mem is null.

ArrayIndexOutOfBoundsException - if off or nByte out of bounds.

NativeErrorException - if the return value of the native function indicates an error.

read

public static final int read(int fildes,
                             OpaqueMemory32 mem)
                      throws NativeErrorException

POSIX: pread, read - read from a file.

Parameters:

fildes - a valid file descriptor open for reading

mem - the OpaqueMemory32 into which all bytes are to be transferred.

Returns:

The number of bytes read, possibly zero.

Throws:

NullPointerException - if buf is null.

NativeErrorException - if the return value of the native function indicates an error.

read

public static final long read(int fildes,
                              OpaqueMemory64 mem)
                       throws NativeErrorException

POSIX: pread, read - read from a file.

Parameters:

fildes - a valid file descriptor open for reading

mem - the OpaqueMemory32 into which all bytes are to be transferred.

Returns:

The number of bytes read, possibly zero.

Throws:

NullPointerException - if buf is null.

NativeErrorException - if the return value of the native function indicates an error.

read

public static final int read(int fildes,
                             ByteRef data)
                      throws NativeErrorException

POSIX: pread, read - read from a file.

Parameters:

fildes - a valid file descriptor open for reading

data - the ByteRef into which the single byte is to be transferred.

Returns:

On succes 1.

Throws:

NullPointerException - if data is null.

NativeErrorException - if the return value of the native function indicates an error.

read

public static final short read(int fildes)
                        throws NativeErrorException

POSIX: pread, read - read from a file.

Parameters:

fildes - a valid file descriptor open for reading

Returns:

the unsigned byte in the low byte and the length in the upper byte. if nothing was read the value of the lower byte is unspecific, the length must be 0.

Throws:

NativeErrorException - if the return value of the native function indicates an error.

usleep

public static final void usleep(int usleep)
                         throws NativeErrorException

LINUX,APPLE,BSD: usleep - suspend execution for an interval.

Parameters:

usleep - the micro seconds to sleep.

Throws:

NativeErrorException - if the return value of the native function indicates an error.

write

public static final int write(int fildes,
                              byte[] buf)
                       throws NativeErrorException

POSIX: pwrite, write - write on a file.

Parameters:

fildes - a valid file descriptor open for writing

buf - The byte array from which all bytes are to be retrieved for writing.

Returns:

The number of bytes written, possibly zero.

Throws:

NativeErrorException - if the return value of the native function indicates an error.

write

public static final int write(int fildes,
                              OpaqueMemory32 mem,
                              int off,
                              int nbyte)
                       throws NativeErrorException

POSIX: pwrite, write - write on a file.

Parameters:

fildes - a valid file descriptor open for writing

mem - The {link OpaqueMemory} from which the bytes are to be retrieved for writing.

off - the start offset in mem.

nbyte - the number of bytes to write.

Returns:

The number of bytes written, possibly zero.

Throws:

NullPointerException - if mem is null.

ArrayIndexOutOfBoundsException - if off or nByte out of bounds.

NativeErrorException - if the return value of the native function indicates an error.

write

public static final long write(int fildes,
                               OpaqueMemory64 mem,
                               long off,
                               long nbyte)
                        throws NativeErrorException,
                               NoSuchNativeMethodException

POSIX: pwrite, write - write on a file.

Parameters:

fildes - a valid file descriptor open for writing

mem - The {link OpaqueMemory} from which the bytes are to be retrieved for writing.

off - the start offset in mem.

nbyte - the number of bytes to write.

Returns:

The number of bytes written, possibly zero.

Throws:

NullPointerException - if mem is null.

ArrayIndexOutOfBoundsException - if off or nByte out of bounds.

NativeErrorException - if the return value of the native function indicates an error.

NoSuchNativeMethodException

write

public static final int write(int fildes,
                              OpaqueMemory32 mem)
                       throws NativeErrorException

POSIX: pwrite, write - write on a file.

Parameters:

fildes - a valid file descriptor open for writing

mem - The {link OpaqueMemory} from which all bytes are to be retrieved for writing.

Returns:

The number of bytes written, possibly zero.

Throws:

NativeErrorException - if the return value of the native function indicates an error.

write

public static final long write(int fildes,
                               OpaqueMemory64 mem)
                        throws NativeErrorException,
                               NoSuchNativeMethodException

POSIX: pwrite, write - write on a file.

Parameters:

fildes - a valid file descriptor open for writing

mem - The {link OpaqueMemory} from which all bytes are to be retrieved for writing.

Returns:

The number of bytes written, possibly zero.

Throws:

NativeErrorException - if the return value of the native function indicates an error.

NoSuchNativeMethodException

write

public static final int write(int fildes,
                              byte data)
                       throws NativeErrorException

POSIX: pwrite, write - write on a file.

Parameters:

fildes - a valid file descriptor open for writing

data - The single byte to write.

Returns:

on succes 1.

Throws:

NativeErrorException - if the return value of the native function indicates an error.

write

public static final int write(int fildes,
                              byte[] buf,
                              int off,
                              int nbyte)
                       throws NativeErrorException

POSIX: pwrite, write - write on a file.

Parameters:

fildes - a valid file descriptor open for writing

buf - The byte array from which the bytes are to be retrieved for writing.

off - the start offset in buf.

nbyte - the number of bytes to write.

Returns:

The number of bytes written, possibly zero.

Throws:

NullPointerException - if buf is null.

ArrayIndexOutOfBoundsException - if off or nByte out of bounds.

NativeErrorException - if the return value of the native function indicates an error.

write

public static final int write(int fildes,
                              ByteBuffer buffer)
                       throws NativeErrorException

POSIX: pwrite, write - write on a file. Write the bytes between Buffer.position() and Buffer.limit() to the file. After sucessful writing, position is updated accordingly to the number of written bytes.

Parameters:

fildes - a valid file descriptor open for writing

buffer - The {link ByteBuffer} from which the bytes between position and limit are to be retrieved for writing.

Returns:

The number of bytes written, possibly zero.

Throws:

NativeErrorException - if the return value of the native function indicates an error.

jnhwIsSingeByteRead

public static boolean jnhwIsSingeByteRead(short nread)

jnhwSingeByteReadToByte

public static byte jnhwSingeByteReadToByte(short nread)

jnhwSingeByteReadToInt

public static int jnhwSingeByteReadToInt(short nread)