Poll

Object Hierarchy:

Description:

[ CCode ( has_type_id = false ) ]
[ Compact ]
public class Poll

A Poll keeps track of file descriptors much like fd_set (used with select) or a struct pollfd array (used with poll).

Once created with Poll, 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 set_controllable).

New file descriptors are added to the set using add_fd, and removed using remove_fd. Controlling which file descriptors should be waited for to become readable and/or writable are done using fd_ctl_read, fd_ctl_write and fd_ctl_pri.

Use 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 restart and set_flushing.

Once the file descriptor set has been waited for, one can use fd_has_closed to see if the file descriptor has been closed, fd_has_error to see if it has generated an error, fd_can_read to see if it is possible to read from the file descriptor, and fd_can_write to see if it is possible to write to it.

Namespace: Gst

Package: gstreamer-1.0

Content:

Creation methods:

public Poll (bool controllable)
Create a new file descriptor set.
public Poll.timer ()
Create a new poll object that can be used for scheduling cancellable timeouts.

Methods:

public bool add_fd (PollFD fd)
Add a file descriptor to the file descriptor set.
public bool fd_can_read (PollFD fd)
Check if fd in this has data to be read.
public bool fd_can_write (PollFD fd)
Check if fd in this can be used for writing.
public bool fd_ctl_pri (PollFD fd, bool active)
Control whether the descriptor fd in this will be monitored for exceptional conditions (POLLPRI).
public bool fd_ctl_read (PollFD fd, bool active)
Control whether the descriptor fd in this will be monitored for readability.
public bool fd_ctl_write (PollFD fd, bool active)
Control whether the descriptor fd in this will be monitored for writability.
public bool fd_has_closed (PollFD fd)
Check if fd in this has closed the connection.
public bool fd_has_error (PollFD fd)
Check if fd in this has an error.
public bool fd_has_pri (PollFD fd)
Check if fd in this has an exceptional condition (POLLPRI).
public void fd_ignored (PollFD fd)
Mark fd as ignored so that the next call to wait will yield the same result for fd as last time.
public void free ()
Free a file descriptor set.
public void get_read_gpollfd (PollFD fd)
Get a GPollFD for the reading part of the control socket.
public bool read_control ()
Read a byte from the control socket of the controllable this.
public bool remove_fd (PollFD fd)
Remove a file descriptor from the file descriptor set.
public void restart ()
Restart any wait that is in progress.
public bool set_controllable (bool controllable)
When controllable is true, this function ensures that future calls to wait will be affected by restart and set_flushing.
public void set_flushing (bool flushing)
When flushing is true, this function ensures that current and future calls to wait will return -1, with errno set to EBUSY.
public int wait (ClockTime timeout)
Wait for activity on the file descriptors in this.
public bool write_control ()
Write a byte to the control socket of the controllable this.