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

Constructors

TaskPool (ManagedPtr TaskPool)

Instances

GObject TaskPool

Methods

gobjectType :: TaskPool -> IO GType

IsObject TaskPool

IsTaskPool TaskPool

IsObject TaskPool

((~) * info (ResolveTaskPoolMethod t TaskPool), MethodInfo * info TaskPool p) => IsLabel t (TaskPool -> p)

Methods

fromLabel :: Proxy# Symbol t -> TaskPool -> p

((~) * info (ResolveTaskPoolMethod t TaskPool), MethodInfo * info TaskPool p) => IsLabelProxy t (TaskPool -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> TaskPool -> p

HasAttributeList * TaskPool

type AttributeList TaskPool

type AttributeList TaskPool

type SignalList TaskPool

type SignalList TaskPool

class GObject o => IsTaskPool o

Instances

(GObject a, UnknownAncestorError Constraint TaskPool a) => IsTaskPool a

IsTaskPool TaskPool

toTaskPool :: IsTaskPool o => o -> IO TaskPool

noTaskPool :: Maybe TaskPool

Methods

cleanup

data TaskPoolCleanupMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsTaskPool a) => MethodInfo * TaskPoolCleanupMethodInfo a signature

Methods

overloadedMethod :: MethodProxy TaskPoolCleanupMethodInfo a -> signature -> s

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.

join

data TaskPoolJoinMethodInfo

Instances

((~) * signature (Ptr () -> m ()), MonadIO m, IsTaskPool a) => MethodInfo * TaskPoolJoinMethodInfo a signature

Methods

overloadedMethod :: MethodProxy TaskPoolJoinMethodInfo a -> signature -> s

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.

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

data TaskPoolPrepareMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsTaskPool a) => MethodInfo * TaskPoolPrepareMethodInfo a signature

Methods

overloadedMethod :: MethodProxy TaskPoolPrepareMethodInfo a -> signature -> s

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

data TaskPoolPushMethodInfo

Instances

((~) * signature (TaskPoolFunction -> m (Ptr ())), MonadIO m, IsTaskPool a) => MethodInfo * TaskPoolPushMethodInfo a signature

Methods

overloadedMethod :: MethodProxy TaskPoolPushMethodInfo a -> signature -> s

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. (Can throw GError)

Start the execution of a new thread from pool.