GI.Gst.Objects.SharedTaskPool

The SharedTaskPool object.

Since: 1.20

Exported types

newtype SharedTaskPool

Memory-managed wrapper type.

Constructors

SharedTaskPool (ManagedPtr SharedTaskPool)

Instances

Eq SharedTaskPool

Defined in GI.Gst.Objects.SharedTaskPool

Methods

(==) :: SharedTaskPool -> SharedTaskPool -> Bool

(/=) :: SharedTaskPool -> SharedTaskPool -> Bool

GObject SharedTaskPool

Defined in GI.Gst.Objects.SharedTaskPool

ManagedPtrNewtype SharedTaskPool

Defined in GI.Gst.Objects.SharedTaskPool

Methods

toManagedPtr :: SharedTaskPool -> ManagedPtr SharedTaskPool

TypedObject SharedTaskPool

Defined in GI.Gst.Objects.SharedTaskPool

Methods

glibType :: IO GType

HasParentTypes SharedTaskPool

Defined in GI.Gst.Objects.SharedTaskPool

IsGValue (Maybe SharedTaskPool)

Convert SharedTaskPool to and from GValue. See toGValue and fromGValue.

Defined in GI.Gst.Objects.SharedTaskPool

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe SharedTaskPool -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe SharedTaskPool)

type ParentTypes SharedTaskPool

Defined in GI.Gst.Objects.SharedTaskPool

type ParentTypes SharedTaskPool = '[TaskPool, Object, Object]

class (GObject o, IsDescendantOf SharedTaskPool o) => IsSharedTaskPool o

Type class for types which can be safely cast to SharedTaskPool, for instance with toSharedTaskPool.

Instances

(GObject o, IsDescendantOf SharedTaskPool o) => IsSharedTaskPool o

Defined in GI.Gst.Objects.SharedTaskPool

toSharedTaskPool :: (MonadIO m, IsSharedTaskPool o) => o -> m SharedTaskPool

Cast to SharedTaskPool, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

addControlBinding, bindProperty, bindPropertyFull, cleanup, defaultError, disposeHandle, forceFloating, freezeNotify, getv, hasActiveControlBindings, hasAncestor, hasAsAncestor, hasAsParent, isFloating, join, notify, notifyByPspec, prepare, push, ref, refSink, removeControlBinding, runDispose, stealData, stealQdata, suggestNextSync, syncValues, thawNotify, unparent, unref, watchClosure.

Getters

getControlBinding, getControlRate, getData, getGValueArray, getMaxThreads, getName, getParent, getPathString, getProperty, getQdata, getValue.

Setters

setControlBindingDisabled, setControlBindingsDisabled, setControlRate, setData, setDataFull, setMaxThreads, setName, setParent, setProperty.

getMaxThreads

sharedTaskPoolGetMaxThreads

Arguments

:: (HasCallStack, MonadIO m, IsSharedTaskPool a)

=> a

pool: a SharedTaskPool

-> m Word32

Returns: the maximum number of threads pool is configured to spawn

No description available in the introspection data.

Since: 1.20

new

sharedTaskPoolNew

Arguments

:: (HasCallStack, MonadIO m)

=> m SharedTaskPool

Returns: a new SharedTaskPool. objectUnref after usage.

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 SharedTaskPool 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.

Since: 1.20

setMaxThreads

sharedTaskPoolSetMaxThreads

Arguments

:: (HasCallStack, MonadIO m, IsSharedTaskPool a)

=> a

pool: a SharedTaskPool

-> Word32

maxThreads: Maximum number of threads to spawn.

-> m ()

Update the maximal number of threads the pool may spawn. When the maximal number of threads is reduced, existing threads are not immediately shut down, see threadPoolSetMaxThreads.

Setting maxThreads to 0 effectively freezes the pool.

Since: 1.20