Modifier and Type	Class and Description
private static class	Factory.SingletonHolder

Access	Constructor and Description
protected	Factory()

Method Summary

Modifier and Type	Method and Description
public abstract int	alignmentOf(NativeType type)
public abstract MemoryIO	Returns: A new `AllocatedDirectMemoryIO`. allocateDirectMemory(Ruby runtime, int The number of bytes to allocate. size, boolean If the memory should be cleared. clear) Allocates memory on the native C heap and wraps it in a `MemoryIO` accessor.
public abstract MemoryIO	Returns: A new `AllocatedDirectMemoryIO`. allocateDirectMemory(Ruby runtime, int The number of bytes to allocate. size, int The minimum alignment of the memory align, boolean If the memory should be cleared. clear) Allocates memory on the native C heap and wraps it in a `MemoryIO` accessor.
public abstract MemoryIO	Returns: A new `AllocatedDirectMemoryIO`. allocateTransientDirectMemory(Ruby runtime, int The number of bytes to allocate. size, int The minimum alignment of the memory align, boolean If the memory should be cleared. clear) Allocates transient native memory (not from C heap) and wraps it in a `MemoryIO` accessor.
public abstract CallbackManager	getCallbackManager()
public static final Factory	Returns: an instance of `FFIProvider` getInstance() Gets an instance of `FFIProvider`
public void	init(Ruby The ruby runtime runtime, RubyModule the module to register the classes under FFI) Registers FFI ruby classes/modules
public abstract AbstractInvoker	newFunction(Ruby runtime, Pointer address, CallbackInfo cbInfo)
public abstract int	sizeOf(NativeType type)
public abstract MemoryIO	Returns: A new `MemoryIO`. wrapDirectMemory(Ruby runtime, long The native address to wrap. address) Wraps a native C memory address in a `MemoryIO` accessor.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

Factory	back to summary
protected Factory()

Method Detail

alignmentOf	back to summary
public abstract int alignmentOf(NativeType type)

allocateDirectMemory back to summary

allocateDirectMemory	back to summary
public abstract MemoryIO allocateDirectMemory(Ruby runtime, int size, boolean clear) Allocates memory on the native C heap and wraps it in a `MemoryIO` accessor. Parameters size:int The number of bytes to allocate. clear:boolean If the memory should be cleared. Returns:MemoryIO A new `AllocatedDirectMemoryIO`.

public abstract MemoryIO allocateDirectMemory(Ruby runtime, int size, boolean clear)

Allocates memory on the native C heap and wraps it in a MemoryIO accessor.

Parameters

size:int: The number of bytes to allocate.
clear:boolean: If the memory should be cleared.

Returns:MemoryIO

A new AllocatedDirectMemoryIO.

allocateDirectMemory back to summary

allocateDirectMemory	back to summary
public abstract MemoryIO allocateDirectMemory(Ruby runtime, int size, int align, boolean clear) Allocates memory on the native C heap and wraps it in a `MemoryIO` accessor. Parameters size:int The number of bytes to allocate. align:int The minimum alignment of the memory clear:boolean If the memory should be cleared. Returns:MemoryIO A new `AllocatedDirectMemoryIO`.

public abstract MemoryIO allocateDirectMemory(Ruby runtime, int size, int align, boolean clear)

Allocates memory on the native C heap and wraps it in a MemoryIO accessor.

Parameters

size:int: The number of bytes to allocate.
align:int: The minimum alignment of the memory
clear:boolean: If the memory should be cleared.

Returns:MemoryIO

A new AllocatedDirectMemoryIO.

allocateTransientDirectMemory back to summary

allocateTransientDirectMemory	back to summary
public abstract MemoryIO allocateTransientDirectMemory(Ruby runtime, int size, int align, boolean clear) Allocates transient native memory (not from C heap) and wraps it in a `MemoryIO` accessor. Parameters size:int The number of bytes to allocate. align:int The minimum alignment of the memory clear:boolean If the memory should be cleared. Returns:MemoryIO A new `AllocatedDirectMemoryIO`.

public abstract MemoryIO allocateTransientDirectMemory(Ruby runtime, int size, int align, boolean clear)

Allocates transient native memory (not from C heap) and wraps it in a MemoryIO accessor.

Parameters

size:int: The number of bytes to allocate.
align:int: The minimum alignment of the memory
clear:boolean: If the memory should be cleared.

Returns:MemoryIO

A new AllocatedDirectMemoryIO.

getCallbackManager	back to summary
public abstract CallbackManager getCallbackManager()

getInstance back to summary

getInstance	back to summary
public static final Factory getInstance() Gets an instance of `FFIProvider` Returns:Factory an instance of `FFIProvider`

public static final Factory getInstance()

Gets an instance of FFIProvider

Returns:Factory: an instance of FFIProvider

init	back to summary
public void init(Ruby runtime, RubyModule FFI) Registers FFI ruby classes/modules Parameters runtime:Ruby The ruby runtime FFI:RubyModule the module to register the classes under

init

back to summary

public void init(Ruby runtime, RubyModule FFI)

Registers FFI ruby classes/modules

Parameters

runtime:Ruby: The ruby runtime
FFI:RubyModule: the module to register the classes under

newFunction	back to summary
public abstract AbstractInvoker newFunction(Ruby runtime, Pointer address, CallbackInfo cbInfo)

sizeOf	back to summary
public abstract int sizeOf(NativeType type)

wrapDirectMemory back to summary

wrapDirectMemory	back to summary
public abstract MemoryIO wrapDirectMemory(Ruby runtime, long address) Wraps a native C memory address in a `MemoryIO` accessor. Parameters address:long The native address to wrap. Returns:MemoryIO A new `MemoryIO`.

public abstract MemoryIO wrapDirectMemory(Ruby runtime, long address)

Wraps a native C memory address in a MemoryIO accessor.

Parameters

address:long: The native address to wrap.

Returns:MemoryIO

A new MemoryIO.

org.jruby.ext.ffi back to summary

private final Class Factory.SingletonHolder

Class Inheritance

extends Object

java.lang.Object
org.jruby.ext.ffi.Factory.SingletonHolder

Field Summary

Modifier and Type	Field and Description
private static final Factory	INSTANCE

Constructor Summary

Access	Constructor and Description
private	SingletonHolder()

Method Summary

Modifier and Type	Method and Description
private static final Factory	getInstance()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

INSTANCE	back to summary
private static final Factory INSTANCE

Constructor Detail

SingletonHolder	back to summary
private SingletonHolder()

Method Detail

getInstance	back to summary
private static final Factory getInstance()

public abstract Class Factory

Nested and Inner Type Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class Factory.SingletonHolder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail