org.jruby.cext

Class Native

java.lang.Object

org.jruby.cext.Native

final class Native
extends java.lang.Object

The Native class is used for interfacing with native extensions. It's singleton instance is tied to the Ruby runtime in which it was created and cannot be used in another runtime. The reason for this is, that C extensions loaded into the process space cannot be isolated from other runtimes and thus cannot be used twice within the same operating system process.

Field Summary

Fields

Modifier and Type	Field and Description
private static Native	INSTANCE
private static java.lang.String	jrubyHome
private static java.lang.String	libName
private Ruby	runtime
private static com.kenai.jffi.Library	shim

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Native(Ruby runtime)

Method Summary

Modifier and Type	Method and Description
(package private) long	callFunction(long fn, long data)
long	callInit(ThreadContext ctx, long init)
IRubyObject	callMethod(ThreadContext ctx, long fn, IRubyObject recv, int arity, IRubyObject[] args) General method to execute a C method with the given arity and arguments.
(package private) IRubyObject	callMethod(ThreadContext ctx, long fn, long recv, int arity, long[] args)
(package private) IRubyObject	callMethod0(long fn, long recv)
(package private) IRubyObject	callMethod1(long fn, long recv, long arg0)
(package private) IRubyObject	callMethod2(long fn, long recv, long arg0, long arg1)
(package private) IRubyObject	callMethod3(long fn, long recv, long arg0, long arg1, long arg2)
(package private) IRubyObject	callProcMethod(long fn, long args_ary)
(package private) static void	freeHandle(long handle)
(package private) void	gc()
private static java.lang.String	getCextLibraryPath() Gets the path within the jar file of the jruby-cext native library.
private static java.io.InputStream	getCextLibraryStream() Gets an InputStream representing the stub library image stored in the jar file.
(package private) long	getFalse()
(package private) static Native	getInstance(Ruby runtime)
(package private) long	getNil()
(package private) long	getTrue()
private void	initNative(Ruby runtime)
private void	load(Ruby runtime) Loads and initializes the "jruby-cext" native library.
private java.io.File	loadFromJar() Copies the "jruby-cext" library to a temporary file to allow the operating system routines to load it into the process space.
private java.io.File	loadFromJrubyHome() Tries loading the "jruby-cext" library from the classpath, the JRuby Jar or the jruby home in the file-system.
(package private) long	newFixnumHandle(IRubyObject obj, long value)
(package private) long	newFloatHandle(IRubyObject obj, double value)
(package private) long	newHandle(IRubyObject obj, int type)
(package private) long	newIOHandle(IRubyObject obj, int fileno, int i)

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

private static Native INSTANCE

shim

private static com.kenai.jffi.Library shim

libName

private static final java.lang.String libName

See Also:

Constant Field Values

jrubyHome

private static final java.lang.String jrubyHome

runtime

private final Ruby runtime

Constructor Detail

Native

private Native(Ruby runtime)

Method Detail

getInstance

static Native getInstance(Ruby runtime)

load

private void load(Ruby runtime)

Loads and initializes the "jruby-cext" native library. If it is shipped in a Jar, it will be extracted to a temporary folder.

loadFromJrubyHome

private java.io.File loadFromJrubyHome()

Tries loading the "jruby-cext" library from the classpath, the JRuby Jar or the jruby home in the file-system.

loadFromJar

private java.io.File loadFromJar()

Copies the "jruby-cext" library to a temporary file to allow the operating system routines to load it into the process space.

getCextLibraryStream

private static final java.io.InputStream getCextLibraryStream()

Gets an InputStream representing the stub library image stored in the jar file.

Returns:

A new InputStream

getCextLibraryPath

private static final java.lang.String getCextLibraryPath()

Gets the path within the jar file of the jruby-cext native library.

Returns:

The path in the jar file.

callMethod

public final IRubyObject callMethod(ThreadContext ctx,
                                    long fn,
                                    IRubyObject recv,
                                    int arity,
                                    IRubyObject[] args)

General method to execute a C method with the given arity and arguments. Slow, general path.

callInit

public final long callInit(ThreadContext ctx,
                           long init)

initNative

private final void initNative(Ruby runtime)

callMethod

final IRubyObject callMethod(ThreadContext ctx,
                             long fn,
                             long recv,
                             int arity,
                             long[] args)

callMethod0

final IRubyObject callMethod0(long fn,
                              long recv)

callMethod1

final IRubyObject callMethod1(long fn,
                              long recv,
                              long arg0)

callMethod2

final IRubyObject callMethod2(long fn,
                              long recv,
                              long arg0,
                              long arg1)

callMethod3

final IRubyObject callMethod3(long fn,
                              long recv,
                              long arg0,
                              long arg1,
                              long arg2)

callFunction

final long callFunction(long fn,
                        long data)

callProcMethod

final IRubyObject callProcMethod(long fn,
                                 long args_ary)

freeHandle

static void freeHandle(long handle)

newHandle

final long newHandle(IRubyObject obj,
                     int type)

newFixnumHandle

final long newFixnumHandle(IRubyObject obj,
                           long value)

newFloatHandle

final long newFloatHandle(IRubyObject obj,
                          double value)

newIOHandle

final long newIOHandle(IRubyObject obj,
                       int fileno,
                       int i)

gc

final void gc()

getNil

final long getNil()

getTrue

final long getTrue()

getFalse

final long getFalse()