SourceFunc (java-gi API)

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 SourceFunc extends FunctionPointer

Functional interface declaration of the SourceFunc callback.

See Also:

Method Summary

Modifier and Type

Method

Description

boolean

run()

Specifies the type of function passed to GLib.timeoutAdd(int, int, org.gnome.glib.SourceFunc), GLib#timeoutAddFull, GLib.idleAdd(int, org.gnome.glib.SourceFunc), and GLib#idleAddFull.

default MemorySegment

toCallback(Arena arena)

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

default int

upcall(MemorySegment userData)

The upcall method is called from native code.

Method Details
- run
  
  boolean run()
  
  Specifies the type of function passed to GLib.timeoutAdd(int, int, org.gnome.glib.SourceFunc), GLib#timeoutAddFull, GLib.idleAdd(int, org.gnome.glib.SourceFunc), and GLib#idleAddFull.
  When calling Source.setCallback(org.gnome.glib.SourceFunc), you may need to cast a function of a different type to this type. Use GLib#SOURCEFUNC to avoid warnings about incompatible function types.
- upcall
  
  default int upcall(MemorySegment userData)
  
  The upcall method is called from native code. The parameters are marshaled and run() is executed.
- toCallback
  
  default MemorySegment toCallback(Arena arena)
  
  Creates a native function pointer to the upcall(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