org.jruby.util

Class IOChannel

java.lang.Object

org.jruby.util.IOChannel

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.nio.channels.Channel

Direct Known Subclasses:

IOChannel.IOReadableByteChannel, IOChannel.IOReadableWritableByteChannel, IOChannel.IOWritableByteChannel

public abstract class IOChannel
extends java.lang.Object
implements java.nio.channels.Channel

Wrap an IO object in a Channel.

See Also:

IOChannel.IOReadableByteChannel, IOChannel.IOWritableByteChannel, IOChannel.IOReadableWritableByteChannel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IOChannel.IOReadableByteChannel A ReadableByteChannel wrapper around an IO-like Ruby object.
static class	IOChannel.IOReadableWritableByteChannel A ReadableByteChannel and WritableByteChannel wrapper around an IO-like Ruby object.
static class	IOChannel.IOWritableByteChannel A WritableByteChannel wrapper around an IO-like Ruby object.

Field Summary

Fields

Modifier and Type	Field and Description
protected IRubyObject	io
protected Ruby	runtime

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IOChannel(IRubyObject io)

Method Summary

Modifier and Type	Method and Description
void	close()
protected CallSite	initReadSite(java.lang.String readMethod)
protected CallSite	initWriteSite()
boolean	isOpen()
protected static int	read(Ruby runtime, IRubyObject io, CallSite read, java.nio.ByteBuffer dst)
protected static int	write(Ruby runtime, IRubyObject io, CallSite write, java.nio.ByteBuffer src) Perform a write to the given IO-like object, using the given call site, and passing the contents of the given buffer.

Methods inherited from class java.lang.Object

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

Field Detail

io

protected final IRubyObject io

runtime

protected final Ruby runtime

Constructor Detail

IOChannel

protected IOChannel(IRubyObject io)

Method Detail

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.nio.channels.Channel

Throws:

java.io.IOException

isOpen

public boolean isOpen()

Specified by:

isOpen in interface java.nio.channels.Channel

read

protected static int read(Ruby runtime,
                          IRubyObject io,
                          CallSite read,
                          java.nio.ByteBuffer dst)

write

protected static int write(Ruby runtime,
                           IRubyObject io,
                           CallSite write,
                           java.nio.ByteBuffer src)

Perform a write to the given IO-like object, using the given call site, and passing the contents of the given buffer. The buffer and its contents should not be referenced beyond the method's return.

Parameters:

runtime - the current runtime

io - the target IO-like object

write - the call site for making dynamic `write` calls

src - the data to write

Returns:

the amount of data reported written by the dynamic `write` call

initReadSite

protected CallSite initReadSite(java.lang.String readMethod)

initWriteSite

protected CallSite initWriteSite()