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

Functional interface declaration of the IteratorNextFunction callback.

See Also:

Method Summary

Modifier and Type

Method

Description

IteratorResult

run(Iterator it, Value result)

The function that will be called when the next element of the iterator should be retrieved.

default MemorySegment

toCallback(Arena arena)

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

default int

upcall(MemorySegment it, MemorySegment result)

The upcall method is called from native code.

Method Details
- run
  
  IteratorResult run(Iterator it, Value result)
  
  The function that will be called when the next element of the iterator should be retrieved.
  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 int upcall(MemorySegment it, MemorySegment result)
  
  The upcall method is called from native code. The parameters are marshaled and run(org.freedesktop.gstreamer.gst.Iterator, org.gnome.gobject.Value) is executed.
- toCallback
  
  default MemorySegment toCallback(Arena arena)
  
  Creates a native function pointer to the upcall(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