Package org.jruby.util

Class IOChannel

java.lang.Object

org.jruby.util.IOChannel

All Implemented Interfaces:

Closeable, AutoCloseable, Channel

Direct Known Subclasses:

IOChannel.IOReadableByteChannel, IOChannel.IOReadableWritableByteChannel, IOChannel.IOWritableByteChannel

public abstract class IOChannel
extends Object
implements 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	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	Description
protected final IRubyObject	io
protected final Ruby	runtime

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	IOChannel(IRubyObject io)

Method Summary

Modifier and Type	Method	Description
void	close()
protected FunctionalCachingCallSite	initReadSite(String readMethod)
protected FunctionalCachingCallSite	initWriteSite()
boolean	isOpen()
protected static int	read(Ruby runtime, IRubyObject io, FunctionalCachingCallSite read, ByteBuffer dst)
protected static int	write(Ruby runtime, IRubyObject io, FunctionalCachingCallSite write, 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 Details

io

protected final IRubyObject io

runtime

protected final Ruby runtime

Constructor Details

IOChannel

protected IOChannel(IRubyObject io)

Method Details

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Specified by:

close in interface Closeable

Throws:

IOException

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel

read

protected static int read(Ruby runtime,
 IRubyObject io,
 FunctionalCachingCallSite read,
 ByteBuffer dst)
                   throws IOException

Throws:

IOException

write

protected static int write(Ruby runtime,
 IRubyObject io,
 FunctionalCachingCallSite write,
 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 FunctionalCachingCallSite initReadSite(String readMethod)

initWriteSite

protected FunctionalCachingCallSite initWriteSite()