Copyright	Will Thompson, Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.Gst.Structs.AtomicQueue

Contents

Exported types
Methods
- length
- new
- peek
- pop
- push
- ref
- unref

Description

The AtomicQueue object implements a queue that can be used from multiple threads without performing any blocking operations.

Synopsis

Exported types

newtype AtomicQueue Source #

Constructors

AtomicQueue (ManagedPtr AtomicQueue)

Instances

BoxedObject AtomicQueue Source #
Methods boxedType :: AtomicQueue -> IO GType #
((~) * info (ResolveAtomicQueueMethod t AtomicQueue), MethodInfo * info AtomicQueue p) => IsLabel t (AtomicQueue -> p) Source #
Methods fromLabel :: Proxy# Symbol t -> AtomicQueue -> p #
((~) * info (ResolveAtomicQueueMethod t AtomicQueue), MethodInfo * info AtomicQueue p) => IsLabelProxy t (AtomicQueue -> p) Source #
Methods fromLabelProxy :: Proxy Symbol t -> AtomicQueue -> p #
HasAttributeList * AtomicQueue Source #

((~) * signature (m ()), MonadIO m) => MethodInfo * AtomicQueueUnrefMethodInfo AtomicQueue signature Source #
Methods overloadedMethod :: MethodProxy AtomicQueueUnrefMethodInfo AtomicQueue -> signature -> s #
((~) * signature (m ()), MonadIO m) => MethodInfo * AtomicQueueRefMethodInfo AtomicQueue signature Source #
Methods overloadedMethod :: MethodProxy AtomicQueueRefMethodInfo AtomicQueue -> signature -> s #
((~) * signature (Ptr () -> m ()), MonadIO m) => MethodInfo * AtomicQueuePushMethodInfo AtomicQueue signature Source #
Methods overloadedMethod :: MethodProxy AtomicQueuePushMethodInfo AtomicQueue -> signature -> s #
((~) * signature (m (Ptr ())), MonadIO m) => MethodInfo * AtomicQueuePopMethodInfo AtomicQueue signature Source #
Methods overloadedMethod :: MethodProxy AtomicQueuePopMethodInfo AtomicQueue -> signature -> s #
((~) * signature (m (Ptr ())), MonadIO m) => MethodInfo * AtomicQueuePeekMethodInfo AtomicQueue signature Source #
Methods overloadedMethod :: MethodProxy AtomicQueuePeekMethodInfo AtomicQueue -> signature -> s #
((~) * signature (m Word32), MonadIO m) => MethodInfo * AtomicQueueLengthMethodInfo AtomicQueue signature Source #
Methods overloadedMethod :: MethodProxy AtomicQueueLengthMethodInfo AtomicQueue -> signature -> s #
type AttributeList AtomicQueue Source #
type AttributeList AtomicQueue

noAtomicQueue :: Maybe AtomicQueue Source #

Methods

length

data AtomicQueueLengthMethodInfo Source #

Instances

((~) * signature (m Word32), MonadIO m) => MethodInfo * AtomicQueueLengthMethodInfo AtomicQueue signature Source #
Methods overloadedMethod :: MethodProxy AtomicQueueLengthMethodInfo AtomicQueue -> signature -> s #

atomicQueueLength Source #

Arguments

:: (HasCallStack, MonadIO m)
=> AtomicQueue	`queue`: a `AtomicQueue`
-> m Word32	Returns: the number of elements in the queue.

Get the amount of items in the queue.

new

atomicQueueNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Word32	`initialSize`: initial queue size
-> m AtomicQueue	Returns: a new `AtomicQueue`

Create a new atomic queue instance. initialSize will be rounded up to the nearest power of 2 and used as the initial size of the queue.

peek

data AtomicQueuePeekMethodInfo Source #

Instances

((~) * signature (m (Ptr ())), MonadIO m) => MethodInfo * AtomicQueuePeekMethodInfo AtomicQueue signature Source #
Methods overloadedMethod :: MethodProxy AtomicQueuePeekMethodInfo AtomicQueue -> signature -> s #

atomicQueuePeek Source #

Arguments

:: (HasCallStack, MonadIO m)
=> AtomicQueue	`queue`: a `AtomicQueue`
-> m (Ptr ())	Returns: the head element of `queue` or `Nothing` when the queue is empty.

Peek the head element of the queue without removing it from the queue.

pop

data AtomicQueuePopMethodInfo Source #

Instances

((~) * signature (m (Ptr ())), MonadIO m) => MethodInfo * AtomicQueuePopMethodInfo AtomicQueue signature Source #
Methods overloadedMethod :: MethodProxy AtomicQueuePopMethodInfo AtomicQueue -> signature -> s #

atomicQueuePop Source #

Arguments

:: (HasCallStack, MonadIO m)
=> AtomicQueue	`queue`: a `AtomicQueue`
-> m (Ptr ())	Returns: the head element of `queue` or `Nothing` when the queue is empty.

Get the head element of the queue.

push

data AtomicQueuePushMethodInfo Source #

Instances

((~) * signature (Ptr () -> m ()), MonadIO m) => MethodInfo * AtomicQueuePushMethodInfo AtomicQueue signature Source #
Methods overloadedMethod :: MethodProxy AtomicQueuePushMethodInfo AtomicQueue -> signature -> s #

atomicQueuePush Source #

Arguments

:: (HasCallStack, MonadIO m)
=> AtomicQueue	`queue`: a `AtomicQueue`
-> Ptr ()	`data`: the data
-> m ()

Append data to the tail of the queue.

ref

data AtomicQueueRefMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * AtomicQueueRefMethodInfo AtomicQueue signature Source #
Methods overloadedMethod :: MethodProxy AtomicQueueRefMethodInfo AtomicQueue -> signature -> s #

atomicQueueRef Source #

Arguments

:: (HasCallStack, MonadIO m)
=> AtomicQueue	`queue`: a `AtomicQueue`
-> m ()

Increase the refcount of queue.

unref

data AtomicQueueUnrefMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * AtomicQueueUnrefMethodInfo AtomicQueue signature Source #
Methods overloadedMethod :: MethodProxy AtomicQueueUnrefMethodInfo AtomicQueue -> signature -> s #

atomicQueueUnref Source #

Arguments

:: (HasCallStack, MonadIO m)
=> AtomicQueue	`queue`: a `AtomicQueue`
-> m ()

Unref queue and free the memory when the refcount reaches 0.