GI.Gst.Objects.TaskPool

This object provides an abstraction for creating threads. The default implementation uses a regular GThreadPool to start tasks.

Subclasses can be made to create custom threads.

Exported types

newtype TaskPool

Memory-managed wrapper type.

Constructors

TaskPool (ManagedPtr TaskPool)

Instances

Eq TaskPool

Defined in GI.Gst.Objects.TaskPool

Methods

(==) :: TaskPool -> TaskPool -> Bool

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

GObject TaskPool

Defined in GI.Gst.Objects.TaskPool

ManagedPtrNewtype TaskPool

Defined in GI.Gst.Objects.TaskPool

Methods

toManagedPtr :: TaskPool -> ManagedPtr TaskPool

TypedObject TaskPool

Defined in GI.Gst.Objects.TaskPool

Methods

glibType :: IO GType

HasParentTypes TaskPool

Defined in GI.Gst.Objects.TaskPool

IsGValue (Maybe TaskPool)

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

Defined in GI.Gst.Objects.TaskPool

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes TaskPool

Defined in GI.Gst.Objects.TaskPool

type ParentTypes TaskPool = '[Object, Object]

class (GObject o, IsDescendantOf TaskPool o) => IsTaskPool o

Type class for types which can be safely cast to TaskPool, for instance with toTaskPool.

Instances

(GObject o, IsDescendantOf TaskPool o) => IsTaskPool o

Defined in GI.Gst.Objects.TaskPool

toTaskPool :: (MonadIO m, IsTaskPool o) => o -> m TaskPool

Cast to TaskPool, 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, getName, getParent, getPathString, getProperty, getQdata, getValue.

Setters

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

cleanup

taskPoolCleanup

Arguments

:: (HasCallStack, MonadIO m, IsTaskPool a)

=> a

pool: a TaskPool

-> m ()

Wait for all tasks to be stopped. This is mainly used internally to ensure proper cleanup of internal data structures in test suites.

MT safe.

disposeHandle

taskPoolDisposeHandle

Arguments

:: (HasCallStack, MonadIO m, IsTaskPool a)

=> a

pool: a TaskPool

-> Ptr ()

id: the id

-> m ()

Dispose of the handle returned by taskPoolPush. This does not need to be called with the default implementation as the default TaskPoolClass::push implementation always returns Nothing. This does not need to be called either when calling taskPoolJoin, but should be called when joining is not necessary, but taskPoolPush returned a non-Nothing value.

This method should only be called with the same pool instance that provided id.

Since: 1.20

join

taskPoolJoin

Arguments

:: (HasCallStack, MonadIO m, IsTaskPool a)

=> a

pool: a TaskPool

-> Ptr ()

id: the id

-> m ()

Join a task and/or return it to the pool. id is the id obtained from taskPoolPush. The default implementation does nothing, as the default TaskPoolClass::push implementation always returns Nothing.

This method should only be called with the same pool instance that provided id.

new

taskPoolNew

Arguments

:: (HasCallStack, MonadIO m)

=> m TaskPool

Returns: a new TaskPool. objectUnref after usage.

Create a new default task pool. The default task pool will use a regular GThreadPool for threads.

prepare

taskPoolPrepare

Arguments

:: (HasCallStack, MonadIO m, IsTaskPool a)

=> a

pool: a TaskPool

-> m ()

(Can throw GError)

Prepare the taskpool for accepting taskPoolPush operations.

MT safe.

push

taskPoolPush

Arguments

:: (HasCallStack, MonadIO m, IsTaskPool a)

=> a

pool: a TaskPool

-> TaskPoolFunction

func: the function to call

-> m (Ptr ())

Returns: a pointer that should be used for the gst_task_pool_join function. This pointer can be Nothing, you must check error to detect errors. If the pointer is not Nothing and taskPoolJoin is not used, call taskPoolDisposeHandle instead. (Can throw GError)

Start the execution of a new thread from pool.