Package org.gnome.gobject

Interface SignalEmissionHook

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("io.github.jwharm.JavaGI")
public interface SignalEmissionHook
extends FunctionPointer

Functional interface declaration of the SignalEmissionHook callback.

See Also:

• run(org.gnome.gobject.SignalInvocationHint, org.gnome.gobject.Value[], java.lang.foreign.MemorySegment)

Method Summary

Modifier and Type	Method	Description
boolean	run(SignalInvocationHint ihint, Value[] paramValues, @Nullable MemorySegment data)	A simple function pointer to get invoked when the signal is emitted.
default MemorySegment	toCallback(Arena arena)	Creates a native function pointer to the upcall(java.lang.foreign.MemorySegment, int, java.lang.foreign.MemorySegment, java.lang.foreign.MemorySegment) method.
default int	upcall(MemorySegment ihint, int nParamValues, MemorySegment paramValues, MemorySegment data)	The upcall method is called from native code.

Method Details

run

boolean run(SignalInvocationHint ihint,
 Value[] paramValues,
 @Nullable
 @Nullable MemorySegment data)

A simple function pointer to get invoked when the signal is emitted.

Emission hooks allow you to tie a hook to the signal type, so that it will trap all emissions of that signal, from any object.

You may not attach these to signals created with the SignalFlags.NO_HOOKS flag.

upcall

default int upcall(MemorySegment ihint,
 int nParamValues,
 MemorySegment paramValues,
 MemorySegment data)

The upcall method is called from native code. The parameters are marshaled and run(org.gnome.gobject.SignalInvocationHint, org.gnome.gobject.Value[], java.lang.foreign.MemorySegment) is executed.

toCallback

default MemorySegment toCallback(Arena arena)

Creates a native function pointer to the upcall(java.lang.foreign.MemorySegment, int, java.lang.foreign.MemorySegment, java.lang.foreign.MemorySegment) method.

Specified by:

toCallback in interface FunctionPointer

Parameters:

arena - the function pointer will be allocated in this arena

Returns:

the native function pointer