GI.GLib.Structs.SourceFuncs

The GSourceFuncs struct contains a table of functions used to handle event sources in a generic manner.

For idle sources, the prepare and check functions always return True to indicate that the source is always ready to be processed. The prepare function also returns a timeout value of 0 to ensure that the poll() call doesn't block (since that would be time wasted which could have been spent running the idle function).

For timeout sources, the prepare and check functions both return True if the timeout interval has expired. The prepare function also returns a timeout value to ensure that the poll() call doesn't block too long and miss the next timeout.

For file descriptor sources, the prepare function typically returns False, since it must wait until poll() has been called before it knows whether any events need to be processed. It sets the returned timeout to -1 to indicate that it doesn't mind how long the poll() call blocks. In the check function, it tests the results of the poll() call to see if the required condition has been met, and returns True if so.

Exported types

newtype SourceFuncs

Constructors

SourceFuncs (ManagedPtr SourceFuncs)

Instances

WrappedPtr SourceFuncs

Methods

wrappedPtrCalloc :: IO (Ptr SourceFuncs)

wrappedPtrCopy :: SourceFuncs -> IO SourceFuncs

wrappedPtrFree :: Maybe (FunPtr (Ptr SourceFuncs -> IO ()))

(~) AttrOpTag tag AttrSet => Constructible SourceFuncs tag

Methods

new :: MonadIO m => (ManagedPtr SourceFuncs -> SourceFuncs) -> [AttrOp SourceFuncs tag] -> m SourceFuncs

newZeroSourceFuncs :: MonadIO m => m SourceFuncs

Construct a SourceFuncs struct initialized to zero.

noSourceFuncs :: Maybe SourceFuncs

Properties

check

clearSourceFuncsCheck :: MonadIO m => SourceFuncs -> m ()

getSourceFuncsCheck :: MonadIO m => SourceFuncs -> m (Maybe SourceFuncsCheckFieldCallback)

setSourceFuncsCheck :: MonadIO m => SourceFuncs -> FunPtr C_SourceFuncsCheckFieldCallback -> m ()

finalize

clearSourceFuncsFinalize :: MonadIO m => SourceFuncs -> m ()

getSourceFuncsFinalize :: MonadIO m => SourceFuncs -> m (Maybe SourceFuncsFinalizeFieldCallback)

setSourceFuncsFinalize :: MonadIO m => SourceFuncs -> FunPtr C_SourceFuncsFinalizeFieldCallback -> m ()

prepare

clearSourceFuncsPrepare :: MonadIO m => SourceFuncs -> m ()

getSourceFuncsPrepare :: MonadIO m => SourceFuncs -> m (Maybe SourceFuncsPrepareFieldCallback)

setSourceFuncsPrepare :: MonadIO m => SourceFuncs -> FunPtr C_SourceFuncsPrepareFieldCallback -> m ()