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

Contents

Exported types
Methods

Description

A #GstPoll keeps track of file descriptors much like fd_set (used with select()) or a struct pollfd array (used with poll()). Once created with gst_poll_new(), the set can be used to wait for file descriptors to be readable and/or writable. It is possible to make this wait be controlled by specifying %TRUE for the @controllable flag when creating the set (or later calling gst_poll_set_controllable()).

New file descriptors are added to the set using gst_poll_add_fd(), and removed using gst_poll_remove_fd(). Controlling which file descriptors should be waited for to become readable and/or writable are done using gst_poll_fd_ctl_read() and gst_poll_fd_ctl_write().

Use gst_poll_wait() to wait for the file descriptors to actually become readable and/or writable, or to timeout if no file descriptor is available in time. The wait can be controlled by calling gst_poll_restart() and gst_poll_set_flushing().

Once the file descriptor set has been waited for, one can use gst_poll_fd_has_closed() to see if the file descriptor has been closed, gst_poll_fd_has_error() to see if it has generated an error, gst_poll_fd_can_read() to see if it is possible to read from the file descriptor, and gst_poll_fd_can_write() to see if it is possible to write to it.

Synopsis

Exported types

newtype Poll Source

Constructors

Poll (ForeignPtr Poll)

Instances

((~) * info (ResolvePollMethod t Poll), MethodInfo * info Poll p) => IsLabel t (Poll -> p) Source
Methods fromLabel :: Proxy# Symbol t -> Poll -> p
((~) * info (ResolvePollMethod t Poll), MethodInfo * info Poll p) => IsLabelProxy t (Poll -> p) Source
Methods fromLabelProxy :: Proxy Symbol t -> Poll -> p
((~) (TYPE Lifted) signature (m Bool), MonadIO m) => MethodInfo (TYPE Lifted) PollWriteControlMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollWriteControlMethodInfo Poll -> signature -> s
((~) (TYPE Lifted) signature (Word64 -> m Int32), MonadIO m) => MethodInfo (TYPE Lifted) PollWaitMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollWaitMethodInfo Poll -> signature -> s
((~) (TYPE Lifted) signature (Bool -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) PollSetFlushingMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollSetFlushingMethodInfo Poll -> signature -> s
((~) (TYPE Lifted) signature (Bool -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) PollSetControllableMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollSetControllableMethodInfo Poll -> signature -> s
((~) (TYPE Lifted) signature (m ()), MonadIO m) => MethodInfo (TYPE Lifted) PollRestartMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollRestartMethodInfo Poll -> signature -> s
((~) (TYPE Lifted) signature (PollFD -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) PollRemoveFdMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollRemoveFdMethodInfo Poll -> signature -> s
((~) (TYPE Lifted) signature (m Bool), MonadIO m) => MethodInfo (TYPE Lifted) PollReadControlMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollReadControlMethodInfo Poll -> signature -> s
((~) (TYPE Lifted) signature (PollFD -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) PollGetReadGpollfdMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollGetReadGpollfdMethodInfo Poll -> signature -> s
((~) (TYPE Lifted) signature (m ()), MonadIO m) => MethodInfo (TYPE Lifted) PollFreeMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollFreeMethodInfo Poll -> signature -> s
((~) (TYPE Lifted) signature (PollFD -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) PollFdIgnoredMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollFdIgnoredMethodInfo Poll -> signature -> s
((~) (TYPE Lifted) signature (PollFD -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) PollFdHasErrorMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollFdHasErrorMethodInfo Poll -> signature -> s
((~) (TYPE Lifted) signature (PollFD -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) PollFdHasClosedMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollFdHasClosedMethodInfo Poll -> signature -> s
((~) (TYPE Lifted) signature (PollFD -> Bool -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) PollFdCtlWriteMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollFdCtlWriteMethodInfo Poll -> signature -> s
((~) (TYPE Lifted) signature (PollFD -> Bool -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) PollFdCtlReadMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollFdCtlReadMethodInfo Poll -> signature -> s
((~) (TYPE Lifted) signature (PollFD -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) PollFdCanWriteMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollFdCanWriteMethodInfo Poll -> signature -> s
((~) (TYPE Lifted) signature (PollFD -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) PollFdCanReadMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollFdCanReadMethodInfo Poll -> signature -> s
((~) (TYPE Lifted) signature (PollFD -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) PollAddFdMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollAddFdMethodInfo Poll -> signature -> s

noPoll :: Maybe Poll Source

Methods

pollAddFd

data PollAddFdMethodInfo Source

Instances

((~) (TYPE Lifted) signature (PollFD -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) PollAddFdMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollAddFdMethodInfo Poll -> signature -> s

pollAddFd :: MonadIO m => Poll -> PollFD -> m Bool Source

pollFdCanRead

data PollFdCanReadMethodInfo Source

Instances

((~) (TYPE Lifted) signature (PollFD -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) PollFdCanReadMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollFdCanReadMethodInfo Poll -> signature -> s

pollFdCanRead :: MonadIO m => Poll -> PollFD -> m Bool Source

pollFdCanWrite

data PollFdCanWriteMethodInfo Source

Instances

((~) (TYPE Lifted) signature (PollFD -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) PollFdCanWriteMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollFdCanWriteMethodInfo Poll -> signature -> s

pollFdCanWrite :: MonadIO m => Poll -> PollFD -> m Bool Source

pollFdCtlRead

data PollFdCtlReadMethodInfo Source

Instances

((~) (TYPE Lifted) signature (PollFD -> Bool -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) PollFdCtlReadMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollFdCtlReadMethodInfo Poll -> signature -> s

pollFdCtlRead :: MonadIO m => Poll -> PollFD -> Bool -> m Bool Source

pollFdCtlWrite

data PollFdCtlWriteMethodInfo Source

Instances

((~) (TYPE Lifted) signature (PollFD -> Bool -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) PollFdCtlWriteMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollFdCtlWriteMethodInfo Poll -> signature -> s

pollFdCtlWrite :: MonadIO m => Poll -> PollFD -> Bool -> m Bool Source

pollFdHasClosed

data PollFdHasClosedMethodInfo Source

Instances

((~) (TYPE Lifted) signature (PollFD -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) PollFdHasClosedMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollFdHasClosedMethodInfo Poll -> signature -> s

pollFdHasClosed :: MonadIO m => Poll -> PollFD -> m Bool Source

pollFdHasError

data PollFdHasErrorMethodInfo Source

Instances

((~) (TYPE Lifted) signature (PollFD -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) PollFdHasErrorMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollFdHasErrorMethodInfo Poll -> signature -> s

pollFdHasError :: MonadIO m => Poll -> PollFD -> m Bool Source

pollFdIgnored

data PollFdIgnoredMethodInfo Source

Instances

((~) (TYPE Lifted) signature (PollFD -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) PollFdIgnoredMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollFdIgnoredMethodInfo Poll -> signature -> s

pollFdIgnored :: MonadIO m => Poll -> PollFD -> m () Source

pollFree

data PollFreeMethodInfo Source

Instances

((~) (TYPE Lifted) signature (m ()), MonadIO m) => MethodInfo (TYPE Lifted) PollFreeMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollFreeMethodInfo Poll -> signature -> s

pollFree :: MonadIO m => Poll -> m () Source

pollGetReadGpollfd

data PollGetReadGpollfdMethodInfo Source

Instances

((~) (TYPE Lifted) signature (PollFD -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) PollGetReadGpollfdMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollGetReadGpollfdMethodInfo Poll -> signature -> s

pollGetReadGpollfd :: MonadIO m => Poll -> PollFD -> m () Source

pollReadControl

data PollReadControlMethodInfo Source

Instances

((~) (TYPE Lifted) signature (m Bool), MonadIO m) => MethodInfo (TYPE Lifted) PollReadControlMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollReadControlMethodInfo Poll -> signature -> s

pollReadControl :: MonadIO m => Poll -> m Bool Source

pollRemoveFd

data PollRemoveFdMethodInfo Source

Instances

((~) (TYPE Lifted) signature (PollFD -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) PollRemoveFdMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollRemoveFdMethodInfo Poll -> signature -> s

pollRemoveFd :: MonadIO m => Poll -> PollFD -> m Bool Source

pollRestart

data PollRestartMethodInfo Source

Instances

((~) (TYPE Lifted) signature (m ()), MonadIO m) => MethodInfo (TYPE Lifted) PollRestartMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollRestartMethodInfo Poll -> signature -> s

pollRestart :: MonadIO m => Poll -> m () Source

pollSetControllable

data PollSetControllableMethodInfo Source

Instances

((~) (TYPE Lifted) signature (Bool -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) PollSetControllableMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollSetControllableMethodInfo Poll -> signature -> s

pollSetControllable :: MonadIO m => Poll -> Bool -> m Bool Source

pollSetFlushing

data PollSetFlushingMethodInfo Source

Instances

((~) (TYPE Lifted) signature (Bool -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) PollSetFlushingMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollSetFlushingMethodInfo Poll -> signature -> s

pollSetFlushing :: MonadIO m => Poll -> Bool -> m () Source

pollWait

data PollWaitMethodInfo Source

Instances

((~) (TYPE Lifted) signature (Word64 -> m Int32), MonadIO m) => MethodInfo (TYPE Lifted) PollWaitMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollWaitMethodInfo Poll -> signature -> s

pollWait :: MonadIO m => Poll -> Word64 -> m Int32 Source

pollWriteControl

data PollWriteControlMethodInfo Source

Instances

((~) (TYPE Lifted) signature (m Bool), MonadIO m) => MethodInfo (TYPE Lifted) PollWriteControlMethodInfo Poll signature Source
Methods overloadedMethod :: MethodProxy PollWriteControlMethodInfo Poll -> signature -> s

pollWriteControl :: MonadIO m => Poll -> m Bool Source