IteratorResyncFunction (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 IteratorResyncFunction extends FunctionPointer

Functional interface declaration of the IteratorResyncFunction callback.

See Also:

Method Summary

Modifier and Type

Method

Description

void

run(Iterator it)

This function will be called whenever a concurrent update happened to the iterated datastructure.

default MemorySegment

toCallback(Arena arena)

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

default void

upcall(MemorySegment it)

The upcall method is called from native code.

Method Details
- run
  
  void run(Iterator it)
  
  This function will be called whenever a concurrent update happened to the iterated datastructure. The implementor of the iterator should restart the iterator from the beginning and clean up any state it might have.
  Implementors of a GstIterator should implement this function and pass it to the constructor of the custom iterator. The function will be called with the iterator lock held.
- upcall
  
  default void upcall(MemorySegment it)
  
  The upcall method is called from native code. The parameters are marshaled and run(org.freedesktop.gstreamer.gst.Iterator) 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