741a79bf82a7b979a720a63c3523330009a0f72f
1 /* GStreamer
2 * Copyright (C) 1999 Erik Walthinsen <omega@cse.ogi.edu>
3 * Copyright (C) 2004 Wim Taymans <wim.taymans@gmail.com>
4 * Copyright (C) 2007 Peter Kjellerstedt <pkj@axis.com>
5 *
6 * gstpoll.h: File descriptor set
7 *
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
12 *
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
17 *
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
22 */
24 #ifndef __GST_POLL_H__
25 #define __GST_POLL_H__
27 #include <glib.h>
28 #include <glib-object.h>
30 #include <gst/gstclock.h>
32 G_BEGIN_DECLS
34 /**
35 * GstPoll:
36 *
37 * A set of file/network descriptors.
38 */
39 typedef struct _GstPoll GstPoll;
41 /**
42 * GstPollFD:
43 * @fd: a file descriptor
44 *
45 * A file descriptor object.
46 */
47 typedef struct {
48 int fd;
50 /*< private >*/
51 gint idx;
52 } GstPollFD;
54 /**
55 * GST_POLL_FD_INIT:
56 *
57 * A #GstPollFD must be initialized with this macro, before it can be
58 * used. This macro can used be to initialize a variable, but it cannot
59 * be assigned to a variable. In that case you have to use
60 * gst_poll_fd_init().
61 *
62 * Since: 0.10.18
63 */
64 #define GST_POLL_FD_INIT { -1, -1 }
66 GstPoll* gst_poll_new (gboolean controllable);
67 GstPoll* gst_poll_new_timer (void);
68 void gst_poll_free (GstPoll *set);
70 void gst_poll_get_read_gpollfd (GstPoll *set, GPollFD *fd);
72 void gst_poll_fd_init (GstPollFD *fd);
74 gboolean gst_poll_add_fd (GstPoll *set, GstPollFD *fd);
75 gboolean gst_poll_remove_fd (GstPoll *set, GstPollFD *fd);
77 gboolean gst_poll_fd_ctl_write (GstPoll *set, GstPollFD *fd, gboolean active);
78 gboolean gst_poll_fd_ctl_read (GstPoll *set, GstPollFD *fd, gboolean active);
79 void gst_poll_fd_ignored (GstPoll *set, GstPollFD *fd);
81 gboolean gst_poll_fd_has_closed (const GstPoll *set, GstPollFD *fd);
82 gboolean gst_poll_fd_has_error (const GstPoll *set, GstPollFD *fd);
83 gboolean gst_poll_fd_can_read (const GstPoll *set, GstPollFD *fd);
84 gboolean gst_poll_fd_can_write (const GstPoll *set, GstPollFD *fd);
86 gint gst_poll_wait (GstPoll *set, GstClockTime timeout);
88 gboolean gst_poll_set_controllable (GstPoll *set, gboolean controllable);
89 void gst_poll_restart (GstPoll *set);
90 void gst_poll_set_flushing (GstPoll *set, gboolean flushing);
92 gboolean gst_poll_write_control (GstPoll *set);
93 gboolean gst_poll_read_control (GstPoll *set);
95 G_END_DECLS
97 #endif /* __GST_POLL_H__ */