Interface HRFunc

All Superinterfaces:

FunctionPointer

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
@Generated("org.javagi.JavaGI")
public interface HRFunc
extends FunctionPointer

Functional interface declaration of the HRFunc callback.

See Also:

• run(MemorySegment, MemorySegment)

Method Summary

Modifier and Type	Method	Description
boolean	run(@Nullable MemorySegment key, @Nullable MemorySegment value)	Specifies the type of the function passed to HashTable.find(HRFunc), HashTable.foreachRemove(HRFunc), and HashTable.foreachSteal(HRFunc).
default MemorySegment	toCallback(Arena arena)	Creates a native function pointer to the upcall(MemorySegment, MemorySegment, MemorySegment) method.
default int	upcall(MemorySegment key, MemorySegment value, MemorySegment userData)	The upcall method is called from native code.

Method Details

run

boolean run(@Nullable MemorySegment key,
 @Nullable MemorySegment value)

Specifies the type of the function passed to HashTable.find(HRFunc), HashTable.foreachRemove(HRFunc), and HashTable.foreachSteal(HRFunc).

The function is called with each key/value pair, together with the userData parameter passed to the calling function.

The function should return true if the key/value pair should be selected, meaning it has been found or it should be removed from the GLib.HashTable, depending on the calling function.

Parameters:

key - a key

value - the value associated with the key

Returns:

true if the key/value pair should be selected, and false otherwise

upcall

default int upcall(MemorySegment key,
 MemorySegment value,
 MemorySegment userData)

The upcall method is called from native code. The parameters are marshaled and run(MemorySegment, MemorySegment) is executed.

toCallback

default MemorySegment toCallback(Arena arena)

Creates a native function pointer to the upcall(MemorySegment, MemorySegment, MemorySegment) method.

Specified by:

toCallback in interface FunctionPointer

Parameters:

arena - the arena in which the function pointer is allocated

Returns:

the native function pointer