org.jruby.util.io

Class PosixShim

java.lang.Object

org.jruby.util.io.PosixShim

public class PosixShim
extends Object

Representations of as many native posix functions as possible applied to an NIO channel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PosixShim.BSDWaitMacros
static class	PosixShim.LinuxWaitMacros
static interface	PosixShim.WaitMacros

Field Summary

Fields

Modifier and Type	Field and Description
String	errmsg The recommended error message, if any.
jnr.constants.platform.Errno	errno The appropriate errno value for the last thrown error, if any.
Throwable	error The last Throwable exception raised by a call.
static int	LOCK_EX
static int	LOCK_NB
static int	LOCK_SH
static int	LOCK_UN
static int	SEEK_CUR
static int	SEEK_END
static int	SEEK_SET
static PosixShim.WaitMacros	WAIT_MACROS

Constructor Summary

Constructors

Constructor and Description
PosixShim(jnr.posix.POSIX posix)

Method Summary

Methods

Modifier and Type	Method and Description
int	close(ChannelFD fd)
int	close(Closeable closeable)
int	dup2(ChannelFD filedes, ChannelFD filedes2)
int	flock(ChannelFD fd, int lockMode)
int	ftruncate(ChannelFD fd, long pos)
long	lseek(ChannelFD fd, long offset, int type)
Channel	open(String cwd, String path, ModeFlags flags, int perm)
Channel	open(String cwd, String path, ModeFlags flags, int perm, ClassLoader classLoader)
Channel[]	pipe()
int	read(ChannelFD fd, byte[] target, int offset, int length, boolean nonblock)
int	setCloexec(int fd, boolean cloexec)
long	size(ChannelFD fd)
static int	umask(jnr.posix.POSIX posix) Joy of POSIX, only way to get the umask is to set the umask, then set it back.
static int	umask(jnr.posix.POSIX posix, int newMask)
int	write(ChannelFD fd, byte[] bytes, int offset, int length, boolean nonblock)

Methods inherited from class java.lang.Object

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

Field Detail

LOCK_SH

public static final int LOCK_SH

See Also:

Constant Field Values

LOCK_EX

public static final int LOCK_EX

See Also:

Constant Field Values

LOCK_NB

public static final int LOCK_NB

See Also:

Constant Field Values

LOCK_UN

public static final int LOCK_UN

See Also:

Constant Field Values

SEEK_SET

public static final int SEEK_SET

See Also:

Constant Field Values

SEEK_CUR

public static final int SEEK_CUR

See Also:

Constant Field Values

SEEK_END

public static final int SEEK_END

See Also:

Constant Field Values

WAIT_MACROS

public static final PosixShim.WaitMacros WAIT_MACROS

error

public Throwable error

The last Throwable exception raised by a call.

errno

public jnr.constants.platform.Errno errno

The appropriate errno value for the last thrown error, if any.

errmsg

public String errmsg

The recommended error message, if any.

Constructor Detail

PosixShim

public PosixShim(jnr.posix.POSIX posix)

Method Detail

lseek

public long lseek(ChannelFD fd,
         long offset,
         int type)

write

public int write(ChannelFD fd,
        byte[] bytes,
        int offset,
        int length,
        boolean nonblock)

read

public int read(ChannelFD fd,
       byte[] target,
       int offset,
       int length,
       boolean nonblock)

flock

public int flock(ChannelFD fd,
        int lockMode)

dup2

public int dup2(ChannelFD filedes,
       ChannelFD filedes2)

close

public int close(ChannelFD fd)

close

public int close(Closeable closeable)

pipe

public Channel[] pipe()

setCloexec

public int setCloexec(int fd,
             boolean cloexec)

open

public Channel open(String cwd,
           String path,
           ModeFlags flags,
           int perm)

open

public Channel open(String cwd,
           String path,
           ModeFlags flags,
           int perm,
           ClassLoader classLoader)

umask

public static int umask(jnr.posix.POSIX posix)

Joy of POSIX, only way to get the umask is to set the umask, then set it back. That's unsafe in a threaded program. We minimize but may not totally remove this race by caching the obtained or previously set (see umask() above) umask and using that as the initial set value which, cross fingers, is a no-op. The cache access is then synchronized. TODO: Better?

umask

public static int umask(jnr.posix.POSIX posix,
        int newMask)

ftruncate

public int ftruncate(ChannelFD fd,
            long pos)

size

public long size(ChannelFD fd)