Package 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	Description
static class	PosixShim.BSDWaitMacros
static class	PosixShim.LinuxWaitMacros
static interface	PosixShim.WaitMacros

Field Summary

Fields

Modifier and Type	Field	Description
String	errmsg	The recommended error message, if any.
Throwable	error	The last Throwable exception raised by a call.
static final int	LOCK_EX
static final int	LOCK_NB
static final int	LOCK_SH
static final int	LOCK_UN
static final int	SEEK_CUR
static final int	SEEK_END
static final int	SEEK_SET
static final PosixShim.WaitMacros	WAIT_MACROS

Constructor Summary

Constructors

Constructor	Description
PosixShim(Ruby runtime)

Method Summary

Modifier and Type	Method	Description
int	close(Closeable closeable)
int	close(ChannelFD fd)
int	dup2(ChannelFD filedes, ChannelFD filedes2)
int	fcntlGetFD(int fd)
int	fcntlSetFD(int fd, int flags)
int	flock(ChannelFD fd, int lockMode)
int	ftruncate(ChannelFD fd, long pos)
jnr.constants.platform.Errno	getErrno()	The appropriate errno value for the last thrown error, if any.
long	lseek(ChannelFD fd, long offset, int type)
Channel	open(String cwd, String path, int flags, int perm)
Channel	open(String cwd, String path, ModeFlags flags, int perm)
Channel	open(String cwd, String path, ModeFlags flags, int perm, ClassLoader classLoader)	Deprecated.
Channel[]	pipe()
int	read(ChannelFD fd, byte[] target, int offset, int length, boolean nonblock)
int	read(ChannelFD fd, ByteBuffer buffer, int offset, int length, boolean nonblock)
int	setCloexec(int fd, boolean cloexec)
void	setErrno(jnr.constants.platform.Errno errno)
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)
int	write(ChannelFD fd, ByteBuffer buffer, 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 Details

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.

errmsg

public String errmsg

The recommended error message, if any.

Constructor Details

PosixShim

public PosixShim(Ruby runtime)

Method Details

lseek

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

write

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

write

public int write(ChannelFD fd,
 ByteBuffer buffer,
 int offset,
 int length,
 boolean nonblock)

read

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

read

public int read(ChannelFD fd,
 ByteBuffer buffer,
 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()

getErrno

public jnr.constants.platform.Errno getErrno()

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

setErrno

public void setErrno(jnr.constants.platform.Errno errno)

setCloexec

public int setCloexec(int fd,
 boolean cloexec)

fcntlSetFD

public int fcntlSetFD(int fd,
 int flags)

fcntlGetFD

public int fcntlGetFD(int fd)

open

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

open

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

open

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

Deprecated.

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)