| 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
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.
- newtype Poll = Poll (ManagedPtr Poll)
- noPoll :: Maybe Poll
- data PollAddFdMethodInfo
- pollAddFd :: MonadIO m => Poll -> PollFD -> m Bool
- data PollFdCanReadMethodInfo
- pollFdCanRead :: MonadIO m => Poll -> PollFD -> m Bool
- data PollFdCanWriteMethodInfo
- pollFdCanWrite :: MonadIO m => Poll -> PollFD -> m Bool
- data PollFdCtlReadMethodInfo
- pollFdCtlRead :: MonadIO m => Poll -> PollFD -> Bool -> m Bool
- data PollFdCtlWriteMethodInfo
- pollFdCtlWrite :: MonadIO m => Poll -> PollFD -> Bool -> m Bool
- data PollFdHasClosedMethodInfo
- pollFdHasClosed :: MonadIO m => Poll -> PollFD -> m Bool
- data PollFdHasErrorMethodInfo
- pollFdHasError :: MonadIO m => Poll -> PollFD -> m Bool
- data PollFdIgnoredMethodInfo
- pollFdIgnored :: MonadIO m => Poll -> PollFD -> m ()
- data PollGetReadGpollfdMethodInfo
- pollGetReadGpollfd :: MonadIO m => Poll -> PollFD -> m ()
- data PollReadControlMethodInfo
- pollReadControl :: MonadIO m => Poll -> m Bool
- data PollRemoveFdMethodInfo
- pollRemoveFd :: MonadIO m => Poll -> PollFD -> m Bool
- data PollRestartMethodInfo
- pollRestart :: MonadIO m => Poll -> m ()
- data PollSetControllableMethodInfo
- pollSetControllable :: MonadIO m => Poll -> Bool -> m Bool
- data PollSetFlushingMethodInfo
- pollSetFlushing :: MonadIO m => Poll -> Bool -> m ()
- data PollWaitMethodInfo
- pollWait :: MonadIO m => Poll -> Word64 -> m Int32
- data PollWriteControlMethodInfo
- pollWriteControl :: MonadIO m => Poll -> m Bool
Exported types
Instances
| WrappedPtr Poll Source # | |
| ((~) * info (ResolvePollMethod t Poll), MethodInfo * info Poll p) => IsLabel t (Poll -> p) Source # | |
| ((~) * info (ResolvePollMethod t Poll), MethodInfo * info Poll p) => IsLabelProxy t (Poll -> p) Source # | |
| HasAttributeList * Poll Source # | |
| ((~) * signature (m Bool), MonadIO m) => MethodInfo * PollWriteControlMethodInfo Poll signature Source # | |
| ((~) * signature (Word64 -> m Int32), MonadIO m) => MethodInfo * PollWaitMethodInfo Poll signature Source # | |
| ((~) * signature (Bool -> m ()), MonadIO m) => MethodInfo * PollSetFlushingMethodInfo Poll signature Source # | |
| ((~) * signature (Bool -> m Bool), MonadIO m) => MethodInfo * PollSetControllableMethodInfo Poll signature Source # | |
| ((~) * signature (m ()), MonadIO m) => MethodInfo * PollRestartMethodInfo Poll signature Source # | |
| ((~) * signature (PollFD -> m Bool), MonadIO m) => MethodInfo * PollRemoveFdMethodInfo Poll signature Source # | |
| ((~) * signature (m Bool), MonadIO m) => MethodInfo * PollReadControlMethodInfo Poll signature Source # | |
| ((~) * signature (PollFD -> m ()), MonadIO m) => MethodInfo * PollGetReadGpollfdMethodInfo Poll signature Source # | |
| ((~) * signature (PollFD -> m ()), MonadIO m) => MethodInfo * PollFdIgnoredMethodInfo Poll signature Source # | |
| ((~) * signature (PollFD -> m Bool), MonadIO m) => MethodInfo * PollFdHasErrorMethodInfo Poll signature Source # | |
| ((~) * signature (PollFD -> m Bool), MonadIO m) => MethodInfo * PollFdHasClosedMethodInfo Poll signature Source # | |
| ((~) * signature (PollFD -> Bool -> m Bool), MonadIO m) => MethodInfo * PollFdCtlWriteMethodInfo Poll signature Source # | |
| ((~) * signature (PollFD -> Bool -> m Bool), MonadIO m) => MethodInfo * PollFdCtlReadMethodInfo Poll signature Source # | |
| ((~) * signature (PollFD -> m Bool), MonadIO m) => MethodInfo * PollFdCanWriteMethodInfo Poll signature Source # | |
| ((~) * signature (PollFD -> m Bool), MonadIO m) => MethodInfo * PollFdCanReadMethodInfo Poll signature Source # | |
| ((~) * signature (PollFD -> m Bool), MonadIO m) => MethodInfo * PollAddFdMethodInfo Poll signature Source # | |
| type AttributeList Poll Source # | |
Methods
addFd
data PollAddFdMethodInfo Source #
fdCanRead
fdCanWrite
fdCtlRead
fdCtlWrite
fdHasClosed
fdHasError
fdIgnored
getReadGpollfd
pollGetReadGpollfd :: MonadIO m => Poll -> PollFD -> m () Source #
readControl
removeFd
restart
data PollRestartMethodInfo Source #
pollRestart :: MonadIO m => Poll -> m () Source #
setControllable
setFlushing
wait
data PollWaitMethodInfo Source #