JNR 2023-06-06 · com.kenai.jffi.Function

Modifier and Type	Field and Description
private final CallContext	callContext
pack-priv final long	contextAddress
pack-priv final long	functionAddress The address of the function

Constructor Summary

Access	Constructor and Description
public	Function(long The native address of the function to invoke. address, Type The return type of the native function. returnType, Type... The parameter types the function accepts. paramTypes) Creates a new instance of `Function` with default calling convention.
public	Function(long The native address of the function to invoke. address, CallContext callContext) Creates a new instance of `Function` with default calling convention.
public	Function(long The native address of the function to invoke. address, Type The return type of the native function. returnType, Type[] The parameter types the function accepts. paramTypes, CallingConvention The calling convention of the function. convention) Creates a new instance of `Function`.
public	Function(long The native address of the function to invoke. address, Type The return type of the native function. returnType, Type[] The parameter types the function accepts. paramTypes, CallingConvention The calling convention of the function. convention, boolean Whether the errno should be saved or not saveErrno) Creates a new instance of `Function`.
public	Function(long The native address of the function to invoke. address, Type The return type of the native function. returnType, int The number of fixed params for a variadic call. fixedParamCount, Type[] The parameter types the function accepts. paramTypes, CallingConvention The calling convention of the function. convention, boolean Whether the errno should be saved or not saveErrno) Creates a new instance of `Function`.

Method Summary

Modifier and Type	Method and Description
public final void	dispose() Deprecated
public final CallContext	getCallContext()
pack-priv final long	Returns: The address of the native function context struct. getContextAddress() Gets the address of the function context.
public final long	Returns: The address of the native function. getFunctionAddress() Gets the address of the function.
public final int	Returns: The number of parameters the native function accepts. getParameterCount() Gets the number of parameters the native function accepts.
public final Type	Returns: The `Type` of the parameter. getParameterType(int The index of the parameter in the function signature index) Gets the type of a parameter.
public final int	Returns: The number of bytes required to store all paraameters of this function. getRawParameterSize() Gets the number of bytes required to pack all the parameters this function accepts, into a region of memory.
public final Type	Returns: The native return type of this function. getReturnType() Gets the native return type of this function.

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

Field Detail

callContext	back to summary
private final CallContext callContext

contextAddress	back to summary
pack-priv final long contextAddress

functionAddress	back to summary
pack-priv final long functionAddress The address of the function

Constructor Detail

Function back to summary

Function	back to summary
public Function(long address, Type returnType, Type... paramTypes) Creates a new instance of `Function` with default calling convention. Parameters address:long The native address of the function to invoke. returnType:Type The return type of the native function. paramTypes:Type[] The parameter types the function accepts.

public Function(long address, Type returnType, Type... paramTypes)

Creates a new instance of Function with default calling convention.

Parameters

address:long: The native address of the function to invoke.
returnType:Type: The return type of the native function.
paramTypes:Type[]: The parameter types the function accepts.

Function back to summary

Function	back to summary
public Function(long address, CallContext callContext) Creates a new instance of `Function` with default calling convention. Parameters address:long The native address of the function to invoke.

public Function(long address, CallContext callContext)

Creates a new instance of Function with default calling convention.

Parameters

address:long: The native address of the function to invoke.

Function back to summary

Function	back to summary
public Function(long address, Type returnType, Type[] paramTypes, CallingConvention convention) Creates a new instance of `Function`. `Function` instances created with this constructor will save the C errno contents after each call. Parameters address:long The native address of the function to invoke. returnType:Type The return type of the native function. paramTypes:Type[] The parameter types the function accepts. convention:CallingConvention The calling convention of the function.

public Function(long address, Type returnType, Type[] paramTypes, CallingConvention convention)

Creates a new instance of Function. Function instances created with this constructor will save the C errno contents after each call.

Parameters

address:long: The native address of the function to invoke.
returnType:Type: The return type of the native function.
paramTypes:Type[]: The parameter types the function accepts.
convention:CallingConvention: The calling convention of the function.

Function back to summary

Function	back to summary
public Function(long address, Type returnType, Type[] paramTypes, CallingConvention convention, boolean saveErrno) Creates a new instance of `Function`. Parameters address:long The native address of the function to invoke. returnType:Type The return type of the native function. paramTypes:Type[] The parameter types the function accepts. convention:CallingConvention The calling convention of the function. saveErrno:boolean Whether the errno should be saved or not

public Function(long address, Type returnType, Type[] paramTypes, CallingConvention convention, boolean saveErrno)

Creates a new instance of Function.

Parameters

address:long: The native address of the function to invoke.
returnType:Type: The return type of the native function.
paramTypes:Type[]: The parameter types the function accepts.
convention:CallingConvention: The calling convention of the function.
saveErrno:boolean: Whether the errno should be saved or not

Function back to summary

Function	back to summary
public Function(long address, Type returnType, int fixedParamCount, Type[] paramTypes, CallingConvention convention, boolean saveErrno) Creates a new instance of `Function`. Parameters address:long The native address of the function to invoke. returnType:Type The return type of the native function. fixedParamCount:int The number of fixed params for a variadic call. paramTypes:Type[] The parameter types the function accepts. convention:CallingConvention The calling convention of the function. saveErrno:boolean Whether the errno should be saved or not

public Function(long address, Type returnType, int fixedParamCount, Type[] paramTypes, CallingConvention convention, boolean saveErrno)

Creates a new instance of Function.

Parameters

address:long: The native address of the function to invoke.
returnType:Type: The return type of the native function.
fixedParamCount:int: The number of fixed params for a variadic call.
paramTypes:Type[]: The parameter types the function accepts.
convention:CallingConvention: The calling convention of the function.
saveErrno:boolean: Whether the errno should be saved or not

Method Detail

dispose	back to summary
public final void dispose() Deprecated Annotations @Deprecated

getCallContext	back to summary
public final CallContext getCallContext()

getContextAddress	back to summary
pack-priv final long getContextAddress() Gets the address of the function context. Returns:long The address of the native function context struct.

getContextAddress

back to summary

pack-priv final long getContextAddress()

Gets the address of the function context.

Returns:long: The address of the native function context struct.

getFunctionAddress	back to summary
public final long getFunctionAddress() Gets the address of the function. Returns:long The address of the native function.

getFunctionAddress

back to summary

public final long getFunctionAddress()

Gets the address of the function.

Returns:long: The address of the native function.

getParameterCount	back to summary
public final int getParameterCount() Gets the number of parameters the native function accepts. Returns:int The number of parameters the native function accepts.

getParameterCount

back to summary

public final int getParameterCount()

Gets the number of parameters the native function accepts.

Returns:int: The number of parameters the native function accepts.

getParameterType back to summary

getParameterType	back to summary
public final Type getParameterType(int index) Gets the type of a parameter. Parameters index:int The index of the parameter in the function signature Returns:Type The `Type` of the parameter.

public final Type getParameterType(int index)

Gets the type of a parameter.

Parameters

index:int: The index of the parameter in the function signature

Returns:Type

The Type of the parameter.

getRawParameterSize	back to summary
public final int getRawParameterSize() Gets the number of bytes required to pack all the parameters this function accepts, into a region of memory. Returns:int The number of bytes required to store all paraameters of this function.

getRawParameterSize

back to summary

public final int getRawParameterSize()

Gets the number of bytes required to pack all the parameters this function accepts, into a region of memory.

Returns:int: The number of bytes required to store all paraameters of this function.

getReturnType	back to summary
public final Type getReturnType() Gets the native return type of this function. Returns:Type The native return type of this function.

getReturnType

back to summary

public final Type getReturnType()

Gets the native return type of this function.

Returns:Type: The native return type of this function.

public final Class Function

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail