com.goldencode.p2j.util.osresource

Interface NativeAPICaller

All Known Implementing Classes:

LibraryDaemon

public interface NativeAPICaller

This defines an API for native library management and function invocation.

Method Summary

Modifier and Type	Method and Description
Signature	invoke(java.lang.String libname, java.lang.String funcname, int ordinal, boolean persistent, CallingConvention conv, Signature signature) Invoke the defined native API call, loading (and optionally unloading) the library as needed.
void	release(java.lang.String libname) Attempts to unload the library identified by the given name.

Method Detail

invoke

Signature invoke(java.lang.String libname,
                 java.lang.String funcname,
                 int ordinal,
                 boolean persistent,
                 CallingConvention conv,
                 Signature signature)

Invoke the defined native API call, loading (and optionally unloading) the library as needed.

Parameters:

libname - The library name where this native procedure should be found.

funcname - The function name being called in the library (except where an ordinal is being used).

ordinal - The entry point's ordinal or -1 if the entry point should be found by name.

persistent - true to leave the library loaded when the native call is complete.

conv - The calling convention to be used in this native call.

signature - Contains the return value and argument descriptors. In the case of the arguments there will be 1 descriptor for each argument to the call (where the 0 index is the leftmost argument and the numargs - 1 index is the rightmost). Each descriptor defines the type and will contain any input value in the case of an argument. If the return value descriptor is null, the call should be treated as a void return.

Returns:

The same signature instance will be updated with output (and/or return data) upon a successful call or with an error code on any failure.

release

void release(java.lang.String libname)

Attempts to unload the library identified by the given name.

Parameters:

libname - The name of the library to attempt to unload.