org.freedesktop.gstreamer.gst.IteratorItemFunction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gst Show documentation
Java language bindings for Gst, generated with Java-GI
There is a newer version: 0.10.2
// Java-GI - Java language bindings for GObject-Introspection-based libraries
// Copyright (C) 2022-2024 Jan-Willem Harmannij
//
// SPDX-License-Identifier: LGPL-2.1-or-later
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, see .
//
// This file has been generated with Java-GI.
// Do not edit this file directly!
// Visit  for more information.
//
package org.freedesktop.gstreamer.gst;

import io.github.jwharm.javagi.base.FunctionPointer;
import io.github.jwharm.javagi.interop.Interop;
import java.lang.FunctionalInterface;
import java.lang.foreign.Arena;
import java.lang.foreign.FunctionDescriptor;
import java.lang.foreign.Linker;
import java.lang.foreign.MemorySegment;
import java.lang.foreign.ValueLayout;
import java.lang.invoke.MethodHandle;
import java.lang.invoke.MethodHandles;
import javax.annotation.processing.Generated;
import org.gnome.gobject.Value;

/**
 * Functional interface declaration of the {@code IteratorItemFunction} callback.
 * 
 * @see IteratorItemFunction#run
 */
@FunctionalInterface
@Generated("io.github.jwharm.JavaGI")
public interface IteratorItemFunction extends FunctionPointer {
    /**
     * The function that will be called after the next item of the iterator
     * has been retrieved. This function can be used to skip items or stop
     * the iterator.
     * 
     * The function will be called with the iterator lock held.
     */
    IteratorItem run(Iterator it, Value item);

    /**
     * The {@code upcall} method is called from native code. The parameters
     * are marshaled and {@link #run} is executed.
     */
    default int upcall(MemorySegment it, MemorySegment item) {
        Arena _arena = Arena.ofAuto();
        var _result = run(MemorySegment.NULL.equals(it) ? null : new Iterator(it), MemorySegment.NULL.equals(item) ? null : new Value(item));
        return _result.getValue();
    }

    /**
     * Creates a native function pointer to the {@link #upcall} method.
     *
     * @return the native function pointer
     */
    default MemorySegment toCallback(Arena arena) {
        FunctionDescriptor _fdesc = FunctionDescriptor.of(ValueLayout.JAVA_INT, ValueLayout.ADDRESS,
                ValueLayout.ADDRESS);
        MethodHandle _handle = Interop.upcallHandle(MethodHandles.lookup(), IteratorItemFunction.class, _fdesc);
        return Linker.nativeLinker().upcallStub(_handle.bindTo(this), _fdesc, arena);
    }
}