blob: 8bf64fd58444d58b63b8f4dbc6f47ffc6bfa0c1a [file] [log] [blame]
/* GStreamer
* Copyright (C) 1999 Erik Walthinsen <>
* Copyright (C) 2004 Wim Taymans <>
* Copyright (C) 2007 Peter Kjellerstedt <>
* gstpoll.h: File descriptor set
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* Library General Public License for more details.
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
#ifndef __GST_POLL_H__
#define __GST_POLL_H__
#include <glib.h>
#include <glib-object.h>
#include <gst/gstclock.h>
* GstPoll:
* A set of file/network descriptors.
typedef struct _GstPoll GstPoll;
* GstPollFD:
* @fd: a file descriptor
* A file descriptor object.
typedef struct {
int fd;
/*< private >*/
gint idx;
} GstPollFD;
* A #GstPollFD must be initialized with this macro, before it can be
* used. This macro can used be to initialize a variable, but it cannot
* be assigned to a variable. In that case you have to use
* gst_poll_fd_init().
#define GST_POLL_FD_INIT { -1, -1 }
GstPoll* gst_poll_new (gboolean controllable) G_GNUC_MALLOC;
GstPoll* gst_poll_new_timer (void) G_GNUC_MALLOC;
void gst_poll_free (GstPoll *set);
void gst_poll_get_read_gpollfd (GstPoll *set, GPollFD *fd);
void gst_poll_fd_init (GstPollFD *fd);
gboolean gst_poll_add_fd (GstPoll *set, GstPollFD *fd);
gboolean gst_poll_remove_fd (GstPoll *set, GstPollFD *fd);
gboolean gst_poll_fd_ctl_write (GstPoll *set, GstPollFD *fd, gboolean active);
gboolean gst_poll_fd_ctl_read (GstPoll *set, GstPollFD *fd, gboolean active);
void gst_poll_fd_ignored (GstPoll *set, GstPollFD *fd);
gboolean gst_poll_fd_has_closed (const GstPoll *set, GstPollFD *fd);
gboolean gst_poll_fd_has_error (const GstPoll *set, GstPollFD *fd);
gboolean gst_poll_fd_can_read (const GstPoll *set, GstPollFD *fd);
gboolean gst_poll_fd_can_write (const GstPoll *set, GstPollFD *fd);
gint gst_poll_wait (GstPoll *set, GstClockTime timeout);
gboolean gst_poll_set_controllable (GstPoll *set, gboolean controllable);
void gst_poll_restart (GstPoll *set);
void gst_poll_set_flushing (GstPoll *set, gboolean flushing);
gboolean gst_poll_write_control (GstPoll *set);
gboolean gst_poll_read_control (GstPoll *set);
#endif /* __GST_POLL_H__ */