Module org.jnetpcap

Package org.jnetpcap.internal

Class ForeignInitializer<T extends ForeignDowncall<E>,E extends Throwable>

java.lang.Object

org.jnetpcap.internal.ForeignInitializer<T,E>

Type Parameters:

T - the generic type

E - the element type

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

PcapForeignInitializer

public class ForeignInitializer<T extends ForeignDowncall<E>,E extends Throwable>
extends Object
implements AutoCloseable

The Class ForeignInitializer.

Author:

Sly Technologies Inc, repos@slytechs.com, mark

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ForeignInitializer.CType	The Enum CType.
static interface	ForeignInitializer.DowncallSupplier<T extends ForeignDowncall<?>>	The Interface DowncallSupplier.
static interface	ForeignInitializer.MethodHandleLookup	The Interface MethodHandleLookup.
static interface	ForeignInitializer.MissingSymbolsPolicy	The Interface MissingSymbolsPolicy.

Constructor Summary

Constructors

Modifier	Constructor	Description
	ForeignInitializer(String name)	Instantiates a new foreign initializer.
	ForeignInitializer(String name, MethodHandles.Lookup lookup)	Instantiates a new foreign initializer.
protected	ForeignInitializer(String name, ForeignInitializer.DowncallSupplier<T> newFunctionSupplier, BiFunction<String,Throwable,T> exceptionSupplier, MethodHandles.Lookup lookup)	Instantiates a new foreign initializer.

Method Summary

Modifier and Type	Method	Description
void	close()	Close.
T	downcall(String signature)	Create ForeignDowncall from given signature.
T	downcall(String symbolName, ForeignInitializer.CType returnType, ForeignInitializer.CType... arggumentTypes)	Downcall.
String	getName()	Gets the name.
void	makeAccessible(boolean b)	Make accessible.
void	setMissingSymbolsPolicy(ForeignInitializer.MissingSymbolsPolicy missingSymbolsPolicy)	Sets the missing symbols policy.
void	setName(String name)	Sets the name.
<U> ForeignUpcall<U>	upcall(String signature, Class<U> clazz)	Upcall.
<U> ForeignUpcall<U>	upcallStatic(Class<?> clazz, String signature)	Upcall static.
<U> ForeignUpcall<U>	upcallStatic(Class<?> clazz, String methodName, ForeignInitializer.CType returnType, ForeignInitializer.CType... argTypes)	Upcall static.
<U> ForeignUpcall<U>	upcallVirtual(String signature, Class<?> clazz, Consumer<Method> methodSetup)	Upcall virtual.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ForeignInitializer

public ForeignInitializer(String name)

Instantiates a new foreign initializer.

Parameters:

name - the name

ForeignInitializer

protected ForeignInitializer(String name,
 ForeignInitializer.DowncallSupplier<T> newFunctionSupplier,
 BiFunction<String,Throwable,T> exceptionSupplier,
 MethodHandles.Lookup lookup)

Instantiates a new foreign initializer.

Parameters:

name - the name

newFunctionSupplier - the new function supplier

exceptionSupplier - the exception supplier

lookup - the lookup

ForeignInitializer

public ForeignInitializer(String name,
 MethodHandles.Lookup lookup)

Instantiates a new foreign initializer.

Parameters:

name - the name

lookup - the lookup

Method Details

close

public void close()
           throws ExceptionInInitializerError

Close.

Specified by:

close in interface AutoCloseable

Throws:

ExceptionInInitializerError - the exception in initializer error

See Also:

• AutoCloseable.close()

downcall

public T downcall(String signature)

Create ForeignDowncall from given signature. Function name must be part of the signature. For example given this signature "getpid()I;" where 'getpid' is the function name and will be used as a symbol to lookup the native function.

Parameters:

signature - the signature

Returns:

the foreign function

downcall

public T downcall(String symbolName,
 ForeignInitializer.CType returnType,
 ForeignInitializer.CType... arggumentTypes)

Downcall.

Parameters:

symbolName - the symbol name

returnType - the return type

arggumentTypes - the arggument types

Returns:

the t

getName

public String getName()

Gets the name.

Returns:

the name

makeAccessible

public void makeAccessible(boolean b)

Make accessible.

Parameters:

b - the b

setMissingSymbolsPolicy

public void setMissingSymbolsPolicy(ForeignInitializer.MissingSymbolsPolicy missingSymbolsPolicy)

Sets the missing symbols policy.

Parameters:

missingSymbolsPolicy - the new missing symbols policy

setName

public void setName(String name)

Sets the name.

Parameters:

name - the name to set

upcallStatic

public <U> ForeignUpcall<U> upcallStatic(Class<?> clazz,
 String signature)

Upcall static.

Type Parameters:

U - the generic type

Parameters:

clazz - the clazz

signature - the signature

Returns:

the foreign upcall

upcallStatic

public <U> ForeignUpcall<U> upcallStatic(Class<?> clazz,
 String methodName,
 ForeignInitializer.CType returnType,
 ForeignInitializer.CType... argTypes)

Upcall static.

Type Parameters:

U - the generic type

Parameters:

clazz - the clazz

methodName - the method name

returnType - the return type

argTypes - the arg types

Returns:

the foreign upcall

upcall

public <U> ForeignUpcall<U> upcall(String signature,
 Class<U> clazz)

Upcall.

Type Parameters:

U - the generic type

Parameters:

signature - the signature

clazz - the clazz

Returns:

the foreign upcall

upcallVirtual

public <U> ForeignUpcall<U> upcallVirtual(String signature,
 Class<?> clazz,
 Consumer<Method> methodSetup)

Upcall virtual.

Type Parameters:

U - the generic type

Parameters:

signature - the signature

clazz - the clazz

methodSetup - the method setup

Returns:

the foreign upcall