|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Object | +--com.jniwrapper.Function
The Function class allows to call specified function
from a native code library.
| Field Summary | |
static byte |
CDECL_CALLING_CONVENTION
Constant for cdecl calling convention. |
static byte |
DEFAULT_CALLING_CONVENTION
Default calling convention for native platform. |
static com.jniwrapper.NullLibrary |
NULL_LIBRARY
|
static byte |
STDCALL_CALLING_CONVENTION
Constant for stdcall calling convention. |
| Method Summary | |
static void |
call(java.lang.String libraryName,
java.lang.String functionName,
Parameter returnValue)
Convenience method that invokes a native code function, which has no parameters. |
static void |
call(java.lang.String libraryName,
java.lang.String functionName,
Parameter returnValue,
Parameter parameter)
Convenience method that invokes a native code function with single parameter. |
static void |
call(java.lang.String libraryName,
java.lang.String functionName,
Parameter returnValue,
Parameter[] parameters)
Invokes the specified function from specified native library. |
static void |
call(java.lang.String libraryName,
java.lang.String functionName,
Parameter returnValue,
Parameter param1,
Parameter param2)
Convenience method that invokes a native code function, which has two parameters. |
static void |
call(java.lang.String libraryName,
java.lang.String functionName,
Parameter returnValue,
Parameter param1,
Parameter param2,
Parameter param3)
Convenience method that invokes a native function with three parameters. |
static void |
call(java.lang.String libraryName,
java.lang.String functionName,
Parameter returnValue,
Parameter param1,
Parameter param2,
Parameter param3,
Parameter param4)
Convenience method that invokes a native function with four parameters. |
byte |
getCallingConvention()
Returns calling convention used for calling this function. |
java.lang.String |
getName()
Returns function name. |
void |
invoke(Parameter returnValue)
Convenience method for calling a native function without parameters. |
void |
invoke(Parameter returnValue,
Parameter parameter)
Convenience method for calling a native function with a single parameter. |
void |
invoke(Parameter returnValue,
Parameter[] parameters)
Invokes the function with the passed parameters. |
void |
invoke(Parameter returnValue,
Parameter param1,
Parameter param2)
Convenience method for calling native function with two parameters. |
void |
invoke(Parameter returnValue,
Parameter param1,
Parameter param2,
Parameter param3)
Convenience method for calling a native function with three parameters. |
void |
invoke(Parameter returnValue,
Parameter param1,
Parameter param2,
Parameter param3,
Parameter param4)
Convenience method for calling native function with four parameters. |
void |
setCallingConvention(byte callingConvention)
Sets calling convention for this function. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
public static final byte DEFAULT_CALLING_CONVENTION
public static final byte CDECL_CALLING_CONVENTION
public static final byte STDCALL_CALLING_CONVENTION
public static final com.jniwrapper.NullLibrary NULL_LIBRARY
| Method Detail |
public void setCallingConvention(byte callingConvention)
Function object only - it is not mapped to the function name.
Most of the time users do not need to use this method.
public byte getCallingConvention()
DEFAULT_CALLING_CONVENTION value.
public java.lang.String getName()
public void invoke(Parameter returnValue,
Parameter[] parameters)
throws FunctionExecutionException
returnValue - reference to return valueparameters - array of parameters of called function
FunctionExecutionException
public final void invoke(Parameter returnValue)
throws FunctionExecutionException
FunctionExecutionExceptioninvoke(Parameter, Parameter[])
public final void invoke(Parameter returnValue,
Parameter parameter)
throws FunctionExecutionException
FunctionExecutionExceptioninvoke(Parameter, Parameter[])
public final void invoke(Parameter returnValue,
Parameter param1,
Parameter param2)
throws FunctionExecutionException
FunctionExecutionExceptioninvoke(Parameter, Parameter[])
public final void invoke(Parameter returnValue,
Parameter param1,
Parameter param2,
Parameter param3)
throws FunctionExecutionException
FunctionExecutionExceptioninvoke(Parameter, Parameter[])
public final void invoke(Parameter returnValue,
Parameter param1,
Parameter param2,
Parameter param3,
Parameter param4)
throws FunctionExecutionException
FunctionExecutionExceptioninvoke(Parameter, Parameter[])
public static void call(java.lang.String libraryName,
java.lang.String functionName,
Parameter returnValue,
Parameter[] parameters)
throws FunctionExecutionException
Since this method creates instances of Library
and Function, it should be used when the
number of calls is minimal.
libraryName - filename of the library containing a called functionfunctionName - name of the called functionreturnValue - reference to a return valueparameters - array of parameters of the called function
FunctionExecutionException
public static final void call(java.lang.String libraryName,
java.lang.String functionName,
Parameter returnValue)
throws FunctionExecutionException
FunctionExecutionExceptioncall(String, String, Parameter, Parameter[])
public static final void call(java.lang.String libraryName,
java.lang.String functionName,
Parameter returnValue,
Parameter parameter)
throws FunctionExecutionException
FunctionExecutionExceptioncall(String, String, Parameter, Parameter[])
public static final void call(java.lang.String libraryName,
java.lang.String functionName,
Parameter returnValue,
Parameter param1,
Parameter param2)
throws FunctionExecutionException
FunctionExecutionExceptioncall(String, String, Parameter, Parameter[])
public static final void call(java.lang.String libraryName,
java.lang.String functionName,
Parameter returnValue,
Parameter param1,
Parameter param2,
Parameter param3)
throws FunctionExecutionException
FunctionExecutionExceptioncall(String, String, Parameter, Parameter[])
public static final void call(java.lang.String libraryName,
java.lang.String functionName,
Parameter returnValue,
Parameter param1,
Parameter param2,
Parameter param3,
Parameter param4)
throws FunctionExecutionException
FunctionExecutionExceptioncall(String, String, Parameter, Parameter[])
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||