GI.GLib.Structs.PollFD

Represents a file descriptor, which events to poll for, and which events occurred.

Exported types

newtype PollFD

Memory-managed wrapper type.

Constructors

PollFD (ManagedPtr PollFD)

Instances

BoxedObject PollFD

Defined in GI.GLib.Structs.PollFD

Methods

boxedType :: PollFD -> IO GType

tag ~ AttrSet => Constructible PollFD tag

Defined in GI.GLib.Structs.PollFD

Methods

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

newZeroPollFD :: MonadIO m => m PollFD

Construct a PollFD struct initialized to zero.

noPollFD :: Maybe PollFD

A convenience alias for Nothing :: Maybe PollFD.

Properties

events

a bitwise combination from IOCondition, specifying which events should be polled for. Typically for reading from a file descriptor you would use IOConditionIn | IOConditionHup | IOConditionErr, and for writing you would use IOConditionOut | IOConditionErr.

getPollFDEvents :: MonadIO m => PollFD -> m Word16

Get the value of the “events” field. When overloading is enabled, this is equivalent to

get pollFD #events

setPollFDEvents :: MonadIO m => PollFD -> Word16 -> m ()

Set the value of the “events” field. When overloading is enabled, this is equivalent to

set pollFD [ #events := value ]

fd

the file descriptor to poll (or a HANDLE on Win32)

getPollFDFd :: MonadIO m => PollFD -> m Int32

Get the value of the “fd” field. When overloading is enabled, this is equivalent to

get pollFD #fd

setPollFDFd :: MonadIO m => PollFD -> Int32 -> m ()

Set the value of the “fd” field. When overloading is enabled, this is equivalent to

set pollFD [ #fd := value ]

revents

a bitwise combination of flags from IOCondition, returned from the poll() function to indicate which events occurred.

getPollFDRevents :: MonadIO m => PollFD -> m Word16

Get the value of the “revents” field. When overloading is enabled, this is equivalent to

get pollFD #revents

setPollFDRevents :: MonadIO m => PollFD -> Word16 -> m ()

Set the value of the “revents” field. When overloading is enabled, this is equivalent to

set pollFD [ #revents := value ]