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

Modifier and Type	Field and Description
pack-priv static final Map<K, V>	altCallbackMap
pack-priv static final Map<K, V>	callbackMap
pack-priv Pointer	cbstruct
private static final Map<K, V>	nativeStrings
pack-priv CallbackProxy	proxy

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

Method Summary

Modifier and Type	Method and Description
private static synchronized native Pointer	createNativeCallback(CallbackProxy callback, Method method, Class<T>[] parameterTypes, Class<T> returnType, int callingConvention) Create a native trampoline to delegate execution to the Java callback.
protected void	finalize() Overrides java.lang.Object.finalize. Free native resources associated with this callback.
private static synchronized native void	freeNativeCallback(long ptr) Free the given callback trampoline.
public static Callback	getCallback(Class<T> type, Pointer p) Return a Callback associated with the given function pointer.
private Callback	getCallback()
private static Class<T>	getCallbackClass(Class<T> type)
private static Method	getCallbackMethod(Callback callback)
public static Pointer	getFunctionPointer(Callback cb) Return a `Pointer` to the native function address for the given callback.
private static Pointer	getNativeFunctionPointer(Callback cb)
private Class<T>	getNativeType(Class<T> cls)
public Pointer	getTrampoline() Obtain a pointer to the native glue code for this callback.
private static boolean	isAllowableNativeType(Class<T> cls) Returns whether the given class is supported in native code.

Field Detail

altCallbackMap	back to summary
pack-priv static final Map<K, V> altCallbackMap

callbackMap	back to summary
pack-priv static final Map<K, V> callbackMap

cbstruct	back to summary
pack-priv Pointer cbstruct

nativeStrings	back to summary
private static final Map<K, V> nativeStrings

proxy	back to summary
pack-priv CallbackProxy proxy

Constructor Detail

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

Method Detail

createNativeCallback	back to summary
private static synchronized native Pointer createNativeCallback(CallbackProxy callback, Method method, Class<T>[] parameterTypes, Class<T> returnType, int callingConvention) Create a native trampoline to delegate execution to the Java callback.

finalize	back to summary
protected void finalize() Overrides java.lang.Object.finalize. Free native resources associated with this callback.

finalize

back to summary

protected void finalize()

Overrides java.lang.Object.finalize.

Free native resources associated with this callback.

freeNativeCallback	back to summary
private static synchronized native void freeNativeCallback(long ptr) Free the given callback trampoline.

getCallback	back to summary
public static Callback getCallback(Class<T> 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.

getCallback	back to summary
private Callback getCallback()

getCallbackClass	back to summary
private static Class<T> getCallbackClass(Class<T> type)

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

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

getNativeFunctionPointer	back to summary
private static Pointer getNativeFunctionPointer(Callback cb)

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

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

isAllowableNativeType	back to summary
private static boolean isAllowableNativeType(Class<T> 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.

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 Method	callbackMethod
private FromNativeConverter[]	fromNative
private ToNativeConverter	toNative

Constructor Summary

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

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	callback_inner(Object[] args)
private Object	convertArgument(Object value, Class<T> dstType) Convert argument from its basic native type to the given Java parameter type.
private Object	convertResult(Object value)
public Class<T>[]	getParameterTypes() Implements com.sun.jna.CallbackProxy.getParameterTypes. Returns the types of the parameters to the callback method.
public Class<T>	getReturnType() Implements com.sun.jna.CallbackProxy.getReturnType. Returns the type of the callback method's return value.

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

Field Detail

callbackMethod	back to summary
private Method callbackMethod

fromNative	back to summary
private FromNativeConverter[] fromNative

toNative	back to summary
private ToNativeConverter toNative

Constructor Detail

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

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.

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.

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

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

convertResult	back to summary
private Object convertResult(Object value)

getParameterTypes	back to summary
public Class<T>[] getParameterTypes() Implements com.sun.jna.CallbackProxy.getParameterTypes. Doc from com.sun.jna.CallbackProxy.getParameterTypes. Returns the types of the parameters to the callback method.

getParameterTypes

back to summary

public Class<T>[] getParameterTypes()

Implements com.sun.jna.CallbackProxy.getParameterTypes.

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

Returns the types of the parameters to the callback method.

getReturnType	back to summary
public Class<T> getReturnType() Implements com.sun.jna.CallbackProxy.getReturnType. Doc from com.sun.jna.CallbackProxy.getReturnType. Returns the type of the callback method's return value.

getReturnType

back to summary

public Class<T> getReturnType()

Implements com.sun.jna.CallbackProxy.getReturnType.

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

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

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 Function	function
private Map<K, V>	options

Constructor Summary

Access	Constructor and Description
public	NativeFunctionHandler(Pointer address, int callingConvention, Map<K, V> libOptions)

Method Summary

Modifier and Type Method and Description

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.

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 Function function

options	back to summary
private Map<K, V> options

Constructor Detail

NativeFunctionHandler	back to summary
public NativeFunctionHandler(Pointer address, int callingConvention, Map<K, V> libOptions)

Method Detail

getPointer	back to summary
public Pointer getPointer()

invoke back to summary

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. 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. args:Object[] Doc from java.lang.reflect.InvocationHandler.invoke. 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`. 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. 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 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.

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.

pack-priv Class CallbackReference

Nested and Inner Type Summary

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

private Interface CallbackReference.NativeFunctionProxy