Modifier and Type	Class and Description
pack-priv static class	CallbackReference.AttachOptions
private static class	CallbackReference.CallbackReferenceDisposer
private class	CallbackReference.DefaultCallbackProxy
private static class	CallbackReference.NativeFunctionHandler Provide invocation handling for an auto-generated Java interface proxy for a native function pointer.

Modifier and Type	Field and Description
private static final Map<Long, Reference<CallbackReference>>	allocatedMemory
pack-priv static final Map<Object, Object>	allocations
pack-priv static final Map<Callback, CallbackReference>	callbackMap
pack-priv int	callingConvention
pack-priv Pointer	cbstruct
pack-priv Cleaner.Cleanable	cleanable
pack-priv static final Map<Callback, CallbackReference>	directCallbackMap
private static final Class<?>	DLL_CALLBACK_CLASS
private static final Map<Callback, CallbackThreadInitializer>	initializers
pack-priv Method	method
pack-priv static final Map<Pointer, Reference<Callback>[]>	pointerCallbackMap
pack-priv CallbackProxy	proxy
private static final Method	PROXY_CALLBACK_METHOD
pack-priv Pointer	trampoline

Access	Constructor and Description
private	CallbackReference(Callback callback, int callingConvention, boolean direct)

Method Summary

Modifier and Type	Method and Description
private static Reference<Callback>[]	addCallbackToArray(Callback cb, Reference<Callback>[] array)
private static Method	checkMethod(Method m)
public void	close() Implements java.io.Closeable.close. Free native resources associated with this callback.
private static Callback	createCallback(Class<?> type, Pointer p)
protected void	dispose() Deprecated
pack-priv static void	disposeAll() Dispose of all memory allocated for callbacks.
pack-priv static Class<?>	findCallbackClass(Class<?> type)
public static Callback	getCallback(Class<?> type, Pointer p) Return a Callback associated with the given function pointer.
private static Callback	getCallback(Class<?> type, Pointer p, boolean direct)
private Callback	getCallback()
private static Method	getCallbackMethod(Callback callback)
private static Method	getCallbackMethod(Class<?> cls)
public static Pointer	getFunctionPointer(Callback cb) Return a `Pointer` to the native function address for the given callback.
private static Pointer	getFunctionPointer(Callback cb, boolean direct) Native code may call this method with direct=true.
private static Pointer	getNativeFunctionPointer(Callback cb) If the callback is one we generated to wrap a native function pointer, return that.
private static Pointer	getNativeString(Object value, boolean wide)
private Class<?>	getNativeType(Class<?> cls)
public Pointer	getTrampoline() Obtain a pointer to the native glue code for this callback.
private static Callback	getTypeAssignableCallback(Class<?> type, Reference<Callback>[] array)
private static ThreadGroup	initializeThread(Callback cb, CallbackReference.AttachOptions args)
private static boolean	isAllowableNativeType(Class<?> cls) Returns whether the given class is supported in native code.
private void	setCallbackOptions(int options) Set the behavioral options for this callback.
pack-priv static CallbackThreadInitializer	Returns: The previous initializer instance (may be `null`) setCallbackThreadInitializer(Callback The `Callback` instance cb, CallbackThreadInitializer The `CallbackThreadInitializer` - if `null` then the associated initializer instance is removed initializer)

Field Detail

allocatedMemory	back to summary
private static final Map<Long, Reference<CallbackReference>> allocatedMemory

allocations	back to summary
pack-priv static final Map<Object, Object> allocations

callbackMap	back to summary
pack-priv static final Map<Callback, CallbackReference> callbackMap

callingConvention	back to summary
pack-priv int callingConvention

cbstruct	back to summary
pack-priv Pointer cbstruct

cleanable	back to summary
pack-priv Cleaner.Cleanable cleanable

directCallbackMap	back to summary
pack-priv static final Map<Callback, CallbackReference> directCallbackMap

DLL_CALLBACK_CLASS	back to summary
private static final Class<?> DLL_CALLBACK_CLASS

initializers	back to summary
private static final Map<Callback, CallbackThreadInitializer> initializers

method	back to summary
pack-priv Method method

pointerCallbackMap	back to summary
pack-priv static final Map<Pointer, Reference<Callback>[]> pointerCallbackMap

proxy	back to summary
pack-priv CallbackProxy proxy

PROXY_CALLBACK_METHOD	back to summary
private static final Method PROXY_CALLBACK_METHOD

trampoline	back to summary
pack-priv Pointer trampoline

Constructor Detail

CallbackReference	back to summary
private CallbackReference(Callback callback, int callingConvention, boolean direct)

Method Detail

addCallbackToArray	back to summary
private static Reference<Callback>[] addCallbackToArray(Callback cb, Reference<Callback>[] array)

checkMethod	back to summary
private static Method checkMethod(Method m)

close	back to summary
public void close() Implements java.io.Closeable.close. Free native resources associated with this callback.

back to summary

public void close()

Implements java.io.Closeable.close.

Free native resources associated with this callback.

createCallback	back to summary
private static Callback createCallback(Class<?> type, Pointer p)

dispose	back to summary
protected void dispose() Deprecated Annotations @Deprecated

disposeAll	back to summary
pack-priv static void disposeAll() Dispose of all memory allocated for callbacks.

findCallbackClass	back to summary
pack-priv static Class<?> findCallbackClass(Class<?> type)

getCallback	back to summary
public static Callback getCallback(Class<?> type, Pointer p) Return a Callback associated with the given function pointer. If the pointer refers to a Java callback trampoline, return the original Java Callback. Otherwise, return a proxy to the native function pointer. Exceptions IllegalStateException: if the given pointer has already been mapped to a callback of a different type.

getCallback

back to summary

public static Callback getCallback(Class<?> type, Pointer p)

Return a Callback associated with the given function pointer. If the pointer refers to a Java callback trampoline, return the original Java Callback. Otherwise, return a proxy to the native function pointer.

Exceptions

IllegalStateException:: if the given pointer has already been mapped to a callback of a different type.

getCallback	back to summary
private static Callback getCallback(Class<?> type, Pointer p, boolean direct)

getCallback	back to summary
private Callback getCallback()

getCallbackMethod	back to summary
private static Method getCallbackMethod(Callback callback)

getCallbackMethod	back to summary
private static Method getCallbackMethod(Class<?> cls)

getFunctionPointer	back to summary
public static Pointer getFunctionPointer(Callback cb) Return a `Pointer` to the native function address for the given callback.

getFunctionPointer	back to summary
private static Pointer getFunctionPointer(Callback cb, boolean direct) Native code may call this method with direct=true.

getNativeFunctionPointer	back to summary
private static Pointer getNativeFunctionPointer(Callback cb) If the callback is one we generated to wrap a native function pointer, return that. Otherwise return null.

getNativeString	back to summary
private static Pointer getNativeString(Object value, boolean wide)

getNativeType	back to summary
private Class<?> getNativeType(Class<?> cls)

getTrampoline	back to summary
public Pointer getTrampoline() Obtain a pointer to the native glue code for this callback.

getTypeAssignableCallback	back to summary
private static Callback getTypeAssignableCallback(Class<?> type, Reference<Callback>[] array)

initializeThread	back to summary
private static ThreadGroup initializeThread(Callback cb, CallbackReference.AttachOptions args)

isAllowableNativeType	back to summary
private static boolean isAllowableNativeType(Class<?> cls) Returns whether the given class is supported in native code. Other types (String, WString, Structure, arrays, NativeMapped, etc) are supported in the Java library.

setCallbackOptions	back to summary
private void setCallbackOptions(int options) Set the behavioral options for this callback.

setCallbackThreadInitializer	back to summary
pack-priv static CallbackThreadInitializer setCallbackThreadInitializer(Callback cb, CallbackThreadInitializer initializer) Parameters cb:Callback The `Callback` instance initializer:CallbackThreadInitializer The `CallbackThreadInitializer` - if `null` then the associated initializer instance is removed Returns:CallbackThreadInitializer The previous initializer instance (may be `null`)

com.sun.jna back to summary

pack-priv Class CallbackReference.AttachOptions

Class Inheritance

extends Structure

java.lang.Object
com.sun.jna.Structure
com.sun.jna.CallbackReference.AttachOptions

Field Summary

Modifier and Type	Field and Description
public boolean	daemon
public boolean	detach
public static final List<String>	FIELDS
public String	name

Inherited from com.sun.jna.Structure:: ALIGN_DEFAULT ALIGN_GNUC ALIGN_MSVC ALIGN_NONE CALCULATE_SIZE fieldOrder layoutInfo

Constructor Summary

Access	Constructor and Description
pack-priv	AttachOptions()

Method Summary

Modifier and Type	Method and Description
protected List<String>	getFieldOrder() Overrides com.sun.jna.Structure.getFieldOrder. Returns this Structure's field names in their proper order.

Field Detail

daemon	back to summary
public boolean daemon

detach	back to summary
public boolean detach

FIELDS	back to summary
public static final List<String> FIELDS

name	back to summary
public String name

Constructor Detail

AttachOptions	back to summary
pack-priv AttachOptions()

Method Detail

getFieldOrder back to summary

protected List<String> getFieldOrder()

Overrides com.sun.jna.Structure.getFieldOrder.

Doc from com.sun.jna.Structure.getFieldOrder.

Returns this Structure's field names in their proper order.
When defining a new Structure you shouldn't override this method, but use FieldOrder annotation to define your field order(this also works with inheritance)
If you want to do something non-standard you can override the method and define it as followed


protected List getFieldOrder() {
    return Arrays.asList(...);
}

Important Note

When deriving from an existing Structure subclass, ensure that you augment the list provided by the superclass, e.g.


protected List getFieldOrder() {
    List fields = new LinkedList(super.getFieldOrder());
    fields.addAll(Arrays.asList(...));
    return fields;
}

Field order must be explicitly indicated, since the field order as returned by Class#getFields() is not guaranteed to be predictable.

Returns:List<String>

ordered list of field names

Annotations

@Override

com.sun.jna back to summary

private final Class CallbackReference.CallbackReferenceDisposer

Class Inheritance

extends Object
implements Runnable

java.lang.Object
com.sun.jna.CallbackReference.CallbackReferenceDisposer

All Implemented Interfaces

java.lang.Runnable

Field Summary

Modifier and Type	Field and Description
private Pointer	cbstruct

Constructor Summary

Access	Constructor and Description
public	CallbackReferenceDisposer(Pointer cbstruct)

Method Summary

Modifier and Type	Method and Description
public synchronized void	run() Implements java.lang.Runnable.run. Runs this operation.

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

Field Detail

cbstruct	back to summary
private Pointer cbstruct

Constructor Detail

CallbackReferenceDisposer	back to summary
public CallbackReferenceDisposer(Pointer cbstruct)

Method Detail

run

back to summary

public synchronized void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

com.sun.jna back to summary

private Class CallbackReference.DefaultCallbackProxy

Class Inheritance

extends Object
implements CallbackProxy

java.lang.Object
com.sun.jna.CallbackReference.DefaultCallbackProxy

All Implemented Interfaces

com.sun.jna.CallbackProxy, com.sun.jna.Callback

Field Summary

Modifier and Type	Field and Description
private final Method	callbackMethod
private final String	encoding
private final FromNativeConverter[]	fromNative
private ToNativeConverter	toNative

Constructor Summary

Access	Constructor and Description
public	DefaultCallbackProxy(Method callbackMethod, TypeMapper mapper, String encoding)

Method Summary

Modifier and Type	Method and Description
public Object	callback(Object[] args) Implements com.sun.jna.CallbackProxy.callback. Called from native code.
private Object	convertArgument(Object value, Class<?> dstType) Convert argument from its basic native type to the given Java parameter type.
private Object	convertResult(Object value)
public Callback	getCallback()
public Class<?>[]	getParameterTypes() Implements com.sun.jna.CallbackProxy.getParameterTypes. Returns the types of the parameters to the callback method.
public Class<?>	getReturnType() Implements com.sun.jna.CallbackProxy.getReturnType. Returns the type of the callback method's return value.
private Object	invokeCallback(Object[] args)

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

Field Detail

callbackMethod	back to summary
private final Method callbackMethod

encoding	back to summary
private final String encoding

fromNative	back to summary
private final FromNativeConverter[] fromNative

toNative	back to summary
private ToNativeConverter toNative

Constructor Detail

DefaultCallbackProxy	back to summary
public DefaultCallbackProxy(Method callbackMethod, TypeMapper mapper, String encoding)

Method Detail

callback

back to summary

public Object callback(Object[] args)

Implements com.sun.jna.CallbackProxy.callback.

Called from native code. All arguments are in an array of Object as the first argument. Converts all arguments to types required by the actual callback method signature, and converts the result back into an appropriate native type. This method must not throw exceptions.

Annotations

@Override

convertArgument	back to summary
private Object convertArgument(Object value, Class<?> dstType) Convert argument from its basic native type to the given Java parameter type.

convertResult	back to summary
private Object convertResult(Object value)

getCallback	back to summary
public Callback getCallback()

getParameterTypes

back to summary

public Class<?>[] getParameterTypes()

Implements com.sun.jna.CallbackProxy.getParameterTypes.

Doc from com.sun.jna.CallbackProxy.getParameterTypes.

Returns the types of the parameters to the callback method.

Annotations

@Override

getReturnType

back to summary

public Class<?> getReturnType()

Implements com.sun.jna.CallbackProxy.getReturnType.

Doc from com.sun.jna.CallbackProxy.getReturnType.

Returns the type of the callback method's return value.

Annotations

@Override

invokeCallback	back to summary
private Object invokeCallback(Object[] args)

com.sun.jna back to summary

private Class CallbackReference.NativeFunctionHandler

Class Inheritance

extends Object
implements InvocationHandler

java.lang.Object
com.sun.jna.CallbackReference.NativeFunctionHandler

All Implemented Interfaces

java.lang.reflect.InvocationHandler

Provide invocation handling for an auto-generated Java interface proxy for a native function pointer. Cf. Library.Handler

Field Summary

Modifier and Type	Field and Description
private final Function	function
private final Map<String, ?>	options

Constructor Summary

Access	Constructor and Description
public	NativeFunctionHandler(Pointer address, int callingConvention, Map<String, ?> options)

Method Summary

Modifier and Type Method and Description

public Pointer

getPointer()

public Object

invoke(Object

the proxy instance that the method was invoked on

proxy, Method

the Method instance corresponding to the interface method invoked on the proxy instance. The declaring class of the Method object will be the interface that the method was declared in, which may be a superinterface of the proxy interface that the proxy class inherits the method through.

method, Object[]

an array of objects containing the values of the arguments passed in the method invocation on the proxy instance, or null if interface method takes no arguments. Arguments of primitive types are wrapped in instances of the appropriate primitive wrapper class, such as java.lang.Integer or java.lang.Boolean.

args)

Implements java.lang.reflect.InvocationHandler.invoke.

Chain invocation to the native function.

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

Field Detail

function	back to summary
private final Function function

options	back to summary
private final Map<String, ?> options

Constructor Detail

NativeFunctionHandler	back to summary
public NativeFunctionHandler(Pointer address, int callingConvention, Map<String, ?> options)

Method Detail

getPointer	back to summary
public Pointer getPointer()

invoke back to summary

public Object invoke(Object proxy, Method method, Object[] args) throws Throwable

Implements java.lang.reflect.InvocationHandler.invoke.

Chain invocation to the native function.

Parameters

proxy:Object

Doc from java.lang.reflect.InvocationHandler.invoke.

the proxy instance that the method was invoked on

method:Method

Doc from java.lang.reflect.InvocationHandler.invoke.

args:Object[]

Doc from java.lang.reflect.InvocationHandler.invoke.

Returns:Object

Doc from java.lang.reflect.InvocationHandler.invoke.

the value to return from the method invocation on the proxy instance. If the declared return type of the interface method is a primitive type, then the value returned by this method must be an instance of the corresponding primitive wrapper class; otherwise, it must be a type assignable to the declared return type. If the value returned by this method is null and the interface method's return type is primitive, then a NullPointerException will be thrown by the method invocation on the proxy instance. If the value returned by this method is otherwise not compatible with the interface method's declared return type as described above, a ClassCastException will be thrown by the method invocation on the proxy instance.

Annotations

@Override

Exceptions

Throwable:

Doc from java.lang.reflect.InvocationHandler.invoke.

the exception to throw from the method invocation on the proxy instance. The exception's type must be assignable either to any of the exception types declared in the throws clause of the interface method or to the unchecked exception types java.lang.RuntimeException or java.lang.Error. If a checked exception is thrown by this method that is not assignable to any of the exception types declared in the throws clause of the interface method, then an UndeclaredThrowableException containing the exception that was thrown by this method will be thrown by the method invocation on the proxy instance.

public Class CallbackReference

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class CallbackReference.AttachOptions

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class CallbackReference.CallbackReferenceDisposer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class CallbackReference.DefaultCallbackProxy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class CallbackReference.NativeFunctionHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail