Top Inners Fields Constructors Methods
org.jruby.util.io

public Class OpenFile

extends Object
implements Finalizable
Class Inheritance
All Implemented Interfaces
org.jruby.Finalizable
Imports
java.io.Closeable, .IOException, java.nio.ByteBuffer, java.nio.channels.Channel, .FileChannel, .FileLock, .ReadableByteChannel, .SeekableByteChannel, .SelectableChannel, .SelectionKey, .SocketChannel, .WritableByteChannel, java.util.HashSet, .Set, java.util.concurrent.locks.ReentrantLock, .ReentrantReadWriteLock, jnr.constants.platform.Errno, .OpenFlags, org.jcodings.Encoding, .Ptr, org.jcodings.transcode.EConv, .EConvFlags, .EConvResult, org.jruby.Finalizable, .Ruby, .RubyArgsFile, .RubyBignum, .RubyEncoding, .RubyException, .RubyFixnum, .RubyIO, .RubyIOError, .RubyNumeric, .FiberScheduler, .RubyString, .RubyThread, org.jruby.exceptions.RaiseException, org.jruby.ext.fcntl.FcntlLibrary, org.jruby.platform.Platform, org.jruby.runtime.Helpers, .ThreadContext, org.jruby.runtime.builtin.IRubyObject, org.jruby.util.ByteList, .ShellLauncher, .StringSupport, org.jruby.util.cli.Options

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
OpenFile.Buffer

public static interface
OpenFile.Finalizer

Field Summary

Modifier and TypeField and Description
public static final int
APPEND

public static final int
BINMODE

protected volatile Set<RubyThread>
blockingThreads

public static final int
BUFSIZ

public final OpenFile.Buffer
cbuf

public static final int
CREATE

public volatile FileLock
currentLock

private final Ptr
dpPtr

public static final int
DUPLEX

private static final byte[]
EMPTY_BYTE_ARRAY

public IOEncodable.ConvConfig
encs

public static final int
EOF

public static final int
EXCLUSIVE

private ChannelFD
fd

private final boolean
fiberScheduler

private OpenFile.Finalizer
finalizer

public final RubyIO
io

public static final int
IO_CBUF_CAPA_MIN

private static final int
IO_MAX_BUFFER_GROWTH

public static final int
IO_RBUF_CAPA_MIN

public static final int
IO_WBUF_CAPA_MIN

private int
lineno

private final ReentrantLock
lock

private int
mode

public static final int
MORE_CHAR_FINISHED

public static final int
MORE_CHAR_SUSPENDED

private boolean
nonblock

private String
pathv

private long
pid

public static final int
PIPE_BUF

public static final OpenFile.Finalizer
PIPE_FINALIZE

Deprecated
public final PosixShim
posix

public static final RubyThread.ReadWrite<ChannelFD>
PREAD_TASK

public static final int
PREP

private Process
process

public static final RubyThread.ReadWrite<ChannelFD>
PWRITE_TASK

public final OpenFile.Buffer
rbuf

pack-priv static final RubyThread.ReadWrite<OpenFile>
READ_TASK

public static final int
READABLE

public EConv
readconv

public static final int
READWRITE

private final Ruby
runtime

public static final int
SETENC_BY_BOM

private final Ptr
spPtr

public Closeable
stdio_file

public static final int
SYNC

public static final int
SYNCWRITE

public static final int
TEXTMODE

public RubyIO
tiedIOForWriting

public static final int
TMPFILE

public static final int
TRUNC

public static final int
TTY

public final OpenFile.Buffer
wbuf

public static final int
WRITABLE

public volatile ReentrantReadWriteLock
write_lock

pack-priv static final RubyThread.ReadWrite<OpenFile>
WRITE_TASK

public EConv
writeconv

public Encoding
writeconvAsciicompat

public boolean
writeconvInitialized

public int
writeconvPreEcflags

public IRubyObject
writeconvPreEcopts

public static final int
WSPLIT

Constructor Summary

AccessConstructor and Description
public
OpenFile(RubyIO io, IRubyObject nil)

Method Summary

Modifier and TypeMethod and Description
public void
addBlockingThread(RubyThread
A thread blocking on this IO
thread)

Add a thread to the list of blocking threads for this IO.

public int
appendline(ThreadContext context, int delim, final ByteList[] strp, final int[] lp, Encoding enc)

public void
ascii8bitBinmode(Ruby runtime)

public long
binwrite(ThreadContext context, byte[] ptrBytes, int ptr, int len, boolean nosync)
Deprecated

public int
binwriteInt(ThreadContext context, byte[] ptrBytes, int ptr, int len, boolean nosync)

pack-priv static int
binwriteString(OpenFile fptr, byte[] bytes, int start, int length)

public Channel
channel()

public void
checkByteReadable(ThreadContext context)

public void
checkCharReadable(ThreadContext context)

public void
checkClosed()

public void
checkReadable(ThreadContext context)

public void
checkReopenSeek(ThreadContext context, Ruby runtime, long pos)

public void
checkTTY()

public void
checkWritable(ThreadContext context)

public void
cleanup(Ruby runtime, boolean noraise)

public void
clearCodeConversion()

public void
clearReadConversion()

public void
clearStdio()

public void
clearTextMode()

public static int
cloexecDup2(PosixShim posix, ChannelFD oldfd, ChannelFD newfd)

public RubyString
doWriteconv(ThreadContext context, RubyString str)

public ByteList
doWriteconv(ThreadContext context, byte[] bytes, int start, int length, Encoding encoding)

public Errno
errno()

public void
errno(Errno newErrno)

public ChannelFD
fd()

public static void
fdFixCloexec(PosixShim posix, int fd)

public FileChannel
fileChannel()

public int
fillbuf(ThreadContext context)

private Object
fillCbuf(ThreadContext context, int ec_flags)

public void
finalize()

Overrides java.lang.Object.finalize.

Implements org.jruby.Finalizable.finalize.

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

public void
finalize(ThreadContext context, boolean noraise)

public void
finalizeFlush(ThreadContext context, boolean noraise)

pack-priv IRubyObject
finishWriteconv(ThreadContext context, boolean noalloc)

private void
flushBeforeSeek(ThreadContext context)

public int
flushBuffer()

public int
flushBufferAsync2()

private int
flushBufferSync()

private int
flushBufferSync2()

public int
fread(ThreadContext context, byte[] buffer, int offset, int size)

public long
fwrite(ThreadContext context, RubyString str, boolean nosync)

public int
fwrite(ThreadContext context, byte[] bytes, int start, int length, Encoding encoding, boolean nosync)

public IRubyObject
getc(ThreadContext context, Encoding enc)

protected Encoding
getCommonEncodingForWriteConv(ThreadContext context, Encoding strEncoding)

public int
getFileno()

public OpenFile.Finalizer
getFinalizer()

public static int
getFModeFromString(String modesString)
Deprecated

public IRubyObject
getlineFast(ThreadContext context, Encoding enc, RubyIO io, boolean chomp)

public int
getLineNumber()

public int
getMode()

public String
getModeAsString(Ruby runtime)
Deprecated

public String
getModeAsString(ThreadContext context)

public static int
getModeFlagsAsIntFrom(int fmode)

public String
getPath()

public long
getPid()

public Process
getProcess()

public static String
getStringFromMode(int mode)

public void
incrementLineno(Ruby runtime, RubyIO io)

public void
incrementLineno(Ruby runtime)
Deprecated

public Encoding
inputEncoding(Ruby runtime)

public void
interruptBlockingThreads(ThreadContext context)

Fire an IOError in all threads blocking on this IO object

public int
io_fflush(ThreadContext context)

public int
IO_RBUF_CAPA_FOR()

private int
ioBufread(ThreadContext context, byte[] ptrBytes, int ptr, int len)

pack-priv static boolean
ioEncnameBomP(String name, long len)

public static int
ioFmodeOflags(int fmode)

public static int
ioModestrFmode(Ruby runtime, String modestr)
Deprecated

public static int
ioModestrFmode(ThreadContext context, String modestr)

public static int
ioModestrOflags(Ruby runtime, String modestr)
Deprecated

public static int
ioModestrOflags(ThreadContext context, String modestr)

public static String
ioOflagsModestr(Ruby runtime, int oflags)
Deprecated

public static String
ioOflagsModestr(ThreadContext context, int oflags)

public boolean
IS_PREP_STDIO()

public boolean
isAutoclose()

public boolean
isBinmode()

public boolean
isBlocking()

public boolean
isBOM()

public boolean
isDuplex()

public boolean
isOpen()

public boolean
isReadable()

public boolean
isReadBuffered()

public boolean
isStdio()

public boolean
isSync()

public boolean
isTextMode()

public boolean
isWritable()

public boolean
isWriteBuffered()

public boolean
lock()

public boolean
lockedByMe()

public void
makeReadConversion(ThreadContext context, int size)

public void
makeReadConversion(ThreadContext context)

public void
makeWriteConversion(ThreadContext context)

private static int
memchr(byte[] pBytes, int p, int delim, int length)

private static String
MODE_BINARY(int oflags, String a, String b)

public int
moreChar(ThreadContext context)

public boolean
NEED_NEWLINE_DECORATOR_ON_READ()

public void
NEED_NEWLINE_DECORATOR_ON_READ_CHECK()

public boolean
NEED_NEWLINE_DECORATOR_ON_WRITE()

public boolean
needsReadConversion()

public boolean
needsWriteConversion(ThreadContext context)

public static int
preadInternal(ThreadContext context, OpenFile fptr, ChannelFD fd, ByteBuffer buffer, int from, int length)

public String
PREP_STDIO_NAME()

public static int
pwriteInternal(ThreadContext context, OpenFile fptr, ChannelFD fd, ByteBuffer buffer, int from, int length)

public static long
rbW32WriteConsole(RubyString buffer)

public static int
rbW32WriteConsole(byte[] bytes, int start, int length, Encoding encoding)

public boolean
READ_CHAR_PENDING()

public int
READ_CHAR_PENDING_COUNT()

public int
READ_CHAR_PENDING_OFF()

public byte[]
READ_CHAR_PENDING_PTR()

public int
READ_CHAR_PENDING_START()

public void
READ_CHECK(ThreadContext context)

public boolean
READ_DATA_BUFFERED()

public boolean
READ_DATA_PENDING()

public int
READ_DATA_PENDING_COUNT()

public int
READ_DATA_PENDING_OFF()

public byte[]
READ_DATA_PENDING_PTR()

public int
READ_DATA_PENDING_START()

public IRubyObject
readAll(ThreadContext context, int siz, IRubyObject str)

public int
readBufferedData(byte[] ptrBytes, int ptr, int len)

public ReadableByteChannel
readChannel()

public Encoding
readEncoding(Ruby runtime)

public static int
readInternal(ThreadContext context, OpenFile fptr, ChannelFD fd, byte[] bufBytes, int buf, int count)

public static int
readInternal(ThreadContext context, OpenFile fptr, ChannelFD fd, ByteBuffer buffer, int buf, int count)

public int
readPending()

public boolean
ready(Ruby runtime, RubyThread thread, int ops, long timeout)

Wait until the channel is available for the given operations or the timeout expires.

public boolean
readyNow(ThreadContext context)

Like OpenFile#ready(org.jruby.Ruby, org.jruby.RubyThread, int, long) but returns a result immediately.

public int
remainSize()

public void
removeBlockingThread(RubyThread
A thread blocking on this IO
thread)

Remove a thread from the list of blocking threads for this IO.

private static int
searchDelimiter(byte[] pBytes, int p, int delim, int len, Encoding enc)

public long
seek(ThreadContext context, long offset, int whence)

public SeekableByteChannel
seekChannel()

public SelectableChannel
selectChannel()

private static void
selectForRead(ThreadContext context, OpenFile fptr, ChannelFD fd)

public void
SET_BINARY_MODE()

private void
SET_TEXT_MODE()

public void
setAutoclose(boolean autoclose)

public void
setBinmode()

public void
setBlock(Ruby runtime)

public void
setBlocking(Ruby runtime, boolean blocking)

public void
setBOM(boolean bom)

public void
setChannel(Channel fd)

public void
setFD(ChannelFD fd)

public void
setFinalizer(OpenFile.Finalizer finalizer)

public void
setLineNumber(int lineNumber)

public void
setMode(int modes)

public void
setNonblock(Ruby runtime)

public void
setPath(String path)

public void
setPid(long pid)

public void
setProcess(Process process)

public void
setSync(boolean sync)

public void
setTextMode()

public RubyString
shiftCbuf(ThreadContext context, final int len, final IRubyObject strp)

public RubyString
shiftCbuf(final int len, final RubyString str)

public SocketChannel
socketChannel()

pack-priv static RubyIOError
streamClosedInParallelError(Ruby runtime)

public boolean
swallow(ThreadContext context, int term)

public synchronized long
tell(ThreadContext context)

public int
threadFlock(ThreadContext context, final int lockMode)

public void
ungetbyte(ThreadContext context, IRubyObject str)

public void
unlock()

public synchronized void
unread(ThreadContext context)

private void
unreadPosix()

private void
unreadWindows(ThreadContext context)

public void
waitForBlockingThreads(ThreadContext context)

Wait until all blocking threads have exited their blocking area.

public boolean
waitReadable(ThreadContext context, long timeout)

public boolean
waitReadable(ThreadContext context)

pack-priv boolean
waitReadable(ThreadContext context, ChannelFD fd)

Logic to match (as well as possible) rb_io_wait_readable from MRI.

public boolean
waitWritable(ThreadContext context, long timeout)

public boolean
waitWritable(ThreadContext context)

private int
writableLength(int l)

public WritableByteChannel
writeChannel()

public static int
writeInternal(ThreadContext context, OpenFile fptr, byte[] bufBytes, int buf, int count)

public static int
writeInternal(ThreadContext context, OpenFile fptr, ByteBuffer bufBytes, int buf, int count)

pack-priv int
writeInternal2(ChannelFD fd, byte[] bufBytes, int buf, int count)

private boolean
wsplit()

wsplit mode selects a smaller write size based on the internal buffer of things like pipes, in order to help guarantee it will not block when emptying our write buffer.

Inherited from java.lang.Object:
cloneequalsgetClasshashCodenotifynotifyAlltoStringwaitwaitwait