Package org.freedesktop.gstreamer.gst

Class SharedTaskPool

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.freedesktop.gstreamer.gst.GstObject

org.freedesktop.gstreamer.gst.TaskPool

org.freedesktop.gstreamer.gst.SharedTaskPool

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class SharedTaskPool
extends TaskPool

The GstSharedTaskPool object.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SharedTaskPool.Builder<B extends SharedTaskPool.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	SharedTaskPool.SharedTaskPoolClass	The GstSharedTaskPoolClass object.

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.gst.TaskPool

TaskPool.TaskPoolClass

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.gst.GstObject

GstObject.DeepNotifyCallback, GstObject.ObjectClass, GstObject.ObjectImpl

Nested classes/interfaces inherited from class org.gnome.gobject.InitiallyUnowned

InitiallyUnowned.InitiallyUnownedClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback

Constructor Summary

Constructors

Constructor	Description
SharedTaskPool()	Create a new shared task pool.
SharedTaskPool(MemorySegment address)	Create a SharedTaskPool proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected SharedTaskPool	asParent()	Returns this instance as if it were its parent type.
static SharedTaskPool.Builder<? extends SharedTaskPool.Builder>	builder()	A SharedTaskPool.Builder object constructs a SharedTaskPool with the specified properties.
int	getMaxThreads()
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static Type	getType()	Get the GType of the SharedTaskPool class
void	setMaxThreads(int maxThreads)	Update the maximal number of threads the this SharedTaskPool may spawn.

Methods inherited from class org.freedesktop.gstreamer.gst.TaskPool

cleanup, disposeHandle, join, prepare, push

Methods inherited from class org.freedesktop.gstreamer.gst.GstObject

addControlBinding, checkUniqueness, deepNotify, defaultDeepNotify, defaultError, emitDeepNotify, getControlBinding, getControlRate, getGValueArray, getName, getParent, getPathString, getValue, getValueArray, hasActiveControlBindings, hasAncestor, hasAsAncestor, hasAsParent, onDeepNotify, ref, refSink, removeControlBinding, replace, setControlBindingDisabled, setControlBindingsDisabled, setControlRate, setName, setParent, suggestNextSync, syncValues, unparent, unref

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newInstance, newInstance, newv, notify_, notify_, notifyByPspec, onNotify, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SharedTaskPool

public SharedTaskPool(MemorySegment address)

Create a SharedTaskPool proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

SharedTaskPool

public SharedTaskPool()

Create a new shared task pool. The shared task pool will queue tasks on a maximum number of threads, 1 by default.

Do not use a GstSharedTaskPool to manage potentially inter-dependent tasks such as pad tasks, as having one task waiting on another to return before returning would cause obvious deadlocks if they happen to share the same thread.

Method Details

getType

public static Type getType()

Get the GType of the SharedTaskPool class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected SharedTaskPool asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class TaskPool

getMaxThreads

public int getMaxThreads()

setMaxThreads

public void setMaxThreads(int maxThreads)

Update the maximal number of threads the this SharedTaskPool may spawn. When the maximal number of threads is reduced, existing threads are not immediately shut down, see g_thread_pool_set_max_threads().

Setting maxThreads to 0 effectively freezes the pool.

Parameters:

maxThreads - Maximum number of threads to spawn.

builder

public static SharedTaskPool.Builder<? extends SharedTaskPool.Builder> builder()

A SharedTaskPool.Builder object constructs a SharedTaskPool with the specified properties. Use the various set...() methods to set properties, and finish construction with SharedTaskPool.Builder.build().