source-git / mingw-gstreamer1

Clone
Source Code
GIT

Blame docs/gst/html/gstreamer-GstPoll.html

c8 c8s master
  1.   9633508fe3a0cd76fc2337761b104a98cc169ca8
  2.   docs
  3.   gst
  4.   html
  5.   gstreamer-GstPoll.html
Blob History Raw
Packit Service 963350
Packit Service 963350 
<html>
Packit Service 963350 
<head>
Packit Service 963350 
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit Service 963350 
<title>GstPoll: GStreamer 1.0 Core Reference Manual</title>
Packit Service 963350 
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
Packit Service 963350 
<link rel="home" href="index.html" title="GStreamer 1.0 Core Reference Manual">
Packit Service 963350 
<link rel="up" href="libgstreamer.html" title="GStreamer Core Library">
Packit Service 963350 
<link rel="prev" href="GstPluginFeature.html" title="GstPluginfeature">
Packit Service 963350 
<link rel="next" href="GstPreset.html" title="GstPreset">
Packit Service 963350 
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
Packit Service 963350 
<link rel="stylesheet" href="style.css" type="text/css">
Packit Service 963350 
</head>
Packit Service 963350 
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit Service 963350
Packit Service 963350
Packit Service 963350 
Top  | 
Packit Service 963350 
                  Description
Packit Service 963350
Packit Service 963350 
Home
Packit Service 963350 
Up
Packit Service 963350 
Prev
Packit Service 963350 
Next
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
GstPoll
Packit Service 963350 
GstPoll — Keep track of file descriptors and make it possible
Packit Service 963350 
                    to wait on them in a cancellable way
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
Functions
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gboolean
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_add_fd ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gboolean
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_fd_can_read ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gboolean
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_fd_can_write ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gboolean
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_fd_ctl_read ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gboolean
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_fd_ctl_write ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gboolean
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_fd_has_closed ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gboolean
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_fd_has_error ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
void
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_fd_ignored ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
void
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_fd_init ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
void
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_free ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
GstPoll *
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_new ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
GstPoll *
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_new_timer ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
void
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_get_read_gpollfd ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gboolean
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_remove_fd ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
void
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_restart ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gboolean
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_set_controllable ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
void
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_set_flushing ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gint
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_wait ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gboolean
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_read_control ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gboolean
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_write_control ()
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
Types and Values
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
 
Packit Service 963350 
GstPoll
Packit Service 963350
Packit Service 963350
Packit Service 963350 
 
Packit Service 963350 
GstPollFD
Packit Service 963350
Packit Service 963350
Packit Service 963350 
#define
Packit Service 963350 
GST_POLL_FD_INIT
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
Includes
Packit Service 963350 
#include <gst/gst.h>
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
Description
Packit Service 963350 
A GstPoll keeps track of file descriptors much like fd_set (used with
Packit Service 963350 
select()) or a struct pollfd array (used with poll()). Once created with
Packit Service 963350 
gst_poll_new(), the set can be used to wait for file descriptors to be
Packit Service 963350 
readable and/or writable. It is possible to make this wait be controlled
Packit Service 963350 
by specifying TRUE for the controllable
Packit Service 963350 
 flag when creating the set (or
Packit Service 963350 
later calling gst_poll_set_controllable()).
Packit Service 963350 
New file descriptors are added to the set using gst_poll_add_fd(), and
Packit Service 963350 
removed using gst_poll_remove_fd(). Controlling which file descriptors
Packit Service 963350 
should be waited for to become readable and/or writable are done using
Packit Service 963350 
gst_poll_fd_ctl_read() and gst_poll_fd_ctl_write().
Packit Service 963350 
Use gst_poll_wait() to wait for the file descriptors to actually become
Packit Service 963350 
readable and/or writable, or to timeout if no file descriptor is available
Packit Service 963350 
in time. The wait can be controlled by calling gst_poll_restart() and
Packit Service 963350 
gst_poll_set_flushing().
Packit Service 963350 
Once the file descriptor set has been waited for, one can use
Packit Service 963350 
gst_poll_fd_has_closed() to see if the file descriptor has been closed,
Packit Service 963350 
gst_poll_fd_has_error() to see if it has generated an error,
Packit Service 963350 
gst_poll_fd_can_read() to see if it is possible to read from the file
Packit Service 963350 
descriptor, and gst_poll_fd_can_write() to see if it is possible to
Packit Service 963350 
write to it.
Packit Service 963350
Packit Service 963350
Packit Service 963350 
Functions
Packit Service 963350
Packit Service 963350 
gst_poll_add_fd ()
Packit Service 963350 
gboolean
Packit Service 963350 
gst_poll_add_fd (GstPoll *set,
Packit Service 963350 
                 GstPollFD *fd);
Packit Service 963350 
Add a file descriptor to the file descriptor set.
Packit Service 963350
Packit Service 963350 
Parameters
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
set
Packit Service 963350 
a file descriptor set.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350 
fd
Packit Service 963350 
a file descriptor.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
Returns
Packit Service 963350 
 TRUE if the file descriptor was successfully added to the set.
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_fd_can_read ()
Packit Service 963350 
gboolean
Packit Service 963350 
gst_poll_fd_can_read (const GstPoll *set,
Packit Service 963350 
                      GstPollFD *fd);
Packit Service 963350 
Check if fd
Packit Service 963350 
 in set
Packit Service 963350 
 has data to be read.
Packit Service 963350
Packit Service 963350 
Parameters
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
set
Packit Service 963350 
a file descriptor set.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350 
fd
Packit Service 963350 
a file descriptor.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
Returns
Packit Service 963350 
 TRUE if the descriptor has data to be read.
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_fd_can_write ()
Packit Service 963350 
gboolean
Packit Service 963350 
gst_poll_fd_can_write (const GstPoll *set,
Packit Service 963350 
                       GstPollFD *fd);
Packit Service 963350 
Check if fd
Packit Service 963350 
 in set
Packit Service 963350 
 can be used for writing.
Packit Service 963350
Packit Service 963350 
Parameters
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
set
Packit Service 963350 
a file descriptor set.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350 
fd
Packit Service 963350 
a file descriptor.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
Returns
Packit Service 963350 
 TRUE if the descriptor can be used for writing.
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_fd_ctl_read ()
Packit Service 963350 
gboolean
Packit Service 963350 
gst_poll_fd_ctl_read (GstPoll *set,
Packit Service 963350 
                      GstPollFD *fd,
Packit Service 963350 
                      gboolean active);
Packit Service 963350 
Control whether the descriptor fd
Packit Service 963350 
 in set
Packit Service 963350 
 will be monitored for
Packit Service 963350 
readability.
Packit Service 963350
Packit Service 963350 
Parameters
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
set
Packit Service 963350 
a file descriptor set.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350 
fd
Packit Service 963350 
a file descriptor.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350 
active
Packit Service 963350 
a new status.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
Returns
Packit Service 963350 
 TRUE if the descriptor was successfully updated.
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_fd_ctl_write ()
Packit Service 963350 
gboolean
Packit Service 963350 
gst_poll_fd_ctl_write (GstPoll *set,
Packit Service 963350 
                       GstPollFD *fd,
Packit Service 963350 
                       gboolean active);
Packit Service 963350 
Control whether the descriptor fd
Packit Service 963350 
 in set
Packit Service 963350 
 will be monitored for
Packit Service 963350 
writability.
Packit Service 963350
Packit Service 963350 
Parameters
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
set
Packit Service 963350 
a file descriptor set.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350 
fd
Packit Service 963350 
a file descriptor.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350 
active
Packit Service 963350 
a new status.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
Returns
Packit Service 963350 
 TRUE if the descriptor was successfully updated.
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_fd_has_closed ()
Packit Service 963350 
gboolean
Packit Service 963350 
gst_poll_fd_has_closed (const GstPoll *set,
Packit Service 963350 
                        GstPollFD *fd);
Packit Service 963350 
Check if fd
Packit Service 963350 
 in set
Packit Service 963350 
 has closed the connection.
Packit Service 963350
Packit Service 963350 
Parameters
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
set
Packit Service 963350 
a file descriptor set.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350 
fd
Packit Service 963350 
a file descriptor.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
Returns
Packit Service 963350 
 TRUE if the connection was closed.
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_fd_has_error ()
Packit Service 963350 
gboolean
Packit Service 963350 
gst_poll_fd_has_error (const GstPoll *set,
Packit Service 963350 
                       GstPollFD *fd);
Packit Service 963350 
Check if fd
Packit Service 963350 
 in set
Packit Service 963350 
 has an error.
Packit Service 963350
Packit Service 963350 
Parameters
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
set
Packit Service 963350 
a file descriptor set.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350 
fd
Packit Service 963350 
a file descriptor.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
Returns
Packit Service 963350 
 TRUE if the descriptor has an error.
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_fd_ignored ()
Packit Service 963350 
void
Packit Service 963350 
gst_poll_fd_ignored (GstPoll *set,
Packit Service 963350 
                     GstPollFD *fd);
Packit Service 963350 
Mark fd
Packit Service 963350 
 as ignored so that the next call to gst_poll_wait() will yield
Packit Service 963350 
the same result for fd
Packit Service 963350 
 as last time. This function must be called if no
Packit Service 963350 
operation (read/write/recv/send/etc.) will be performed on fd
Packit Service 963350 
 before
Packit Service 963350 
the next call to gst_poll_wait().
Packit Service 963350 
The reason why this is needed is because the underlying implementation
Packit Service 963350 
might not allow querying the fd more than once between calls to one of
Packit Service 963350 
the re-enabling operations.
Packit Service 963350
Packit Service 963350 
Parameters
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
set
Packit Service 963350 
a file descriptor set.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350 
fd
Packit Service 963350 
a file descriptor.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_fd_init ()
Packit Service 963350 
void
Packit Service 963350 
gst_poll_fd_init (GstPollFD *fd);
Packit Service 963350 
Initializes fd
Packit Service 963350 
. Alternatively you can initialize it with
Packit Service 963350 
GST_POLL_FD_INIT.
Packit Service 963350
Packit Service 963350 
Parameters
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
fd
Packit Service 963350 
a GstPollFD
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_free ()
Packit Service 963350 
void
Packit Service 963350 
gst_poll_free (GstPoll *set);
Packit Service 963350 
Free a file descriptor set.
Packit Service 963350
Packit Service 963350 
Parameters
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
set
Packit Service 963350 
a file descriptor set.
Packit Service 963350 
[transfer full]
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_new ()
Packit Service 963350 
GstPoll *
Packit Service 963350 
gst_poll_new (gboolean controllable);
Packit Service 963350 
Create a new file descriptor set. If controllable
Packit Service 963350 
, it
Packit Service 963350 
is possible to restart or flush a call to gst_poll_wait() with
Packit Service 963350 
gst_poll_restart() and gst_poll_set_flushing() respectively.
Packit Service 963350 
Free-function: gst_poll_free
Packit Service 963350 
[skip]
Packit Service 963350
Packit Service 963350 
Parameters
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
controllable
Packit Service 963350 
whether it should be possible to control a wait.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
Returns
Packit Service 963350 
a new GstPoll, or NULL in
Packit Service 963350 
case of an error.  Free with gst_poll_free().
Packit Service 963350 
[transfer full][nullable]
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_new_timer ()
Packit Service 963350 
GstPoll *
Packit Service 963350 
gst_poll_new_timer (void);
Packit Service 963350 
Create a new poll object that can be used for scheduling cancellable
Packit Service 963350 
timeouts.
Packit Service 963350 
A timeout is performed with gst_poll_wait(). Multiple timeouts can be
Packit Service 963350 
performed from different threads.
Packit Service 963350 
Free-function: gst_poll_free
Packit Service 963350 
[skip]
Packit Service 963350
Packit Service 963350 
Returns
Packit Service 963350 
a new GstPoll, or NULL in
Packit Service 963350 
case of an error.  Free with gst_poll_free().
Packit Service 963350 
[transfer full][nullable]
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_get_read_gpollfd ()
Packit Service 963350 
void
Packit Service 963350 
gst_poll_get_read_gpollfd (GstPoll *set,
Packit Service 963350 
                           GPollFD *fd);
Packit Service 963350 
Get a GPollFD for the reading part of the control socket. This is useful when
Packit Service 963350 
integrating with a GSource and GMainLoop.
Packit Service 963350
Packit Service 963350 
Parameters
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
set
Packit Service 963350 
a GstPoll
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350 
fd
Packit Service 963350 
a GPollFD
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_remove_fd ()
Packit Service 963350 
gboolean
Packit Service 963350 
gst_poll_remove_fd (GstPoll *set,
Packit Service 963350 
                    GstPollFD *fd);
Packit Service 963350 
Remove a file descriptor from the file descriptor set.
Packit Service 963350
Packit Service 963350 
Parameters
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
set
Packit Service 963350 
a file descriptor set.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350 
fd
Packit Service 963350 
a file descriptor.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
Returns
Packit Service 963350 
 TRUE if the file descriptor was successfully removed from the set.
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_restart ()
Packit Service 963350 
void
Packit Service 963350 
gst_poll_restart (GstPoll *set);
Packit Service 963350 
Restart any gst_poll_wait() that is in progress. This function is typically
Packit Service 963350 
used after adding or removing descriptors to set
Packit Service 963350 
.
Packit Service 963350 
If set
Packit Service 963350 
 is not controllable, then this call will have no effect.
Packit Service 963350 
This function only works for non-timer GstPoll objects created with
Packit Service 963350 
gst_poll_new().
Packit Service 963350
Packit Service 963350 
Parameters
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
set
Packit Service 963350 
a GstPoll.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_set_controllable ()
Packit Service 963350 
gboolean
Packit Service 963350 
gst_poll_set_controllable (GstPoll *set,
Packit Service 963350 
                           gboolean controllable);
Packit Service 963350 
When controllable
Packit Service 963350 
 is TRUE, this function ensures that future calls to
Packit Service 963350 
gst_poll_wait() will be affected by gst_poll_restart() and
Packit Service 963350 
gst_poll_set_flushing().
Packit Service 963350 
This function only works for non-timer GstPoll objects created with
Packit Service 963350 
gst_poll_new().
Packit Service 963350
Packit Service 963350 
Parameters
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
set
Packit Service 963350 
a GstPoll.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350 
controllable
Packit Service 963350 
new controllable state.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
Returns
Packit Service 963350 
 TRUE if the controllability of set
Packit Service 963350 
could be updated.
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_set_flushing ()
Packit Service 963350 
void
Packit Service 963350 
gst_poll_set_flushing (GstPoll *set,
Packit Service 963350 
                       gboolean flushing);
Packit Service 963350 
When flushing
Packit Service 963350 
 is TRUE, this function ensures that current and future calls
Packit Service 963350 
to gst_poll_wait() will return -1, with errno set to EBUSY.
Packit Service 963350 
Unsetting the flushing state will restore normal operation of set
Packit Service 963350 
.
Packit Service 963350 
This function only works for non-timer GstPoll objects created with
Packit Service 963350 
gst_poll_new().
Packit Service 963350
Packit Service 963350 
Parameters
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
set
Packit Service 963350 
a GstPoll.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350 
flushing
Packit Service 963350 
new flushing state.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_wait ()
Packit Service 963350 
gint
Packit Service 963350 
gst_poll_wait (GstPoll *set,
Packit Service 963350 
               GstClockTime timeout);
Packit Service 963350 
Wait for activity on the file descriptors in set
Packit Service 963350 
. This function waits up to
Packit Service 963350 
the specified timeout
Packit Service 963350 
.  A timeout of GST_CLOCK_TIME_NONE waits forever.
Packit Service 963350 
For GstPoll objects created with gst_poll_new(), this function can only be
Packit Service 963350 
called from a single thread at a time.  If called from multiple threads,
Packit Service 963350 
-1 will be returned with errno set to EPERM.
Packit Service 963350 
This is not true for timer GstPoll objects created with
Packit Service 963350 
gst_poll_new_timer(), where it is allowed to have multiple threads waiting
Packit Service 963350 
simultaneously.
Packit Service 963350
Packit Service 963350 
Parameters
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
set
Packit Service 963350 
a GstPoll.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350 
timeout
Packit Service 963350 
a timeout in nanoseconds.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
Returns
Packit Service 963350 
 The number of GstPollFD in set
Packit Service 963350 
that have activity or 0 when no
Packit Service 963350 
activity was detected after timeout
Packit Service 963350 
. If an error occurs, -1 is returned
Packit Service 963350 
and errno is set.
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_read_control ()
Packit Service 963350 
gboolean
Packit Service 963350 
gst_poll_read_control (GstPoll *set);
Packit Service 963350 
Read a byte from the control socket of the controllable set
Packit Service 963350 
.
Packit Service 963350 
This function only works for timer GstPoll objects created with
Packit Service 963350 
gst_poll_new_timer().
Packit Service 963350
Packit Service 963350 
Parameters
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
set
Packit Service 963350 
a GstPoll.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
Returns
Packit Service 963350 
 TRUE on success. FALSE when when there was no byte to read or
Packit Service 963350 
reading the byte failed. If there was no byte to read, and only then, errno
Packit Service 963350 
will contain EWOULDBLOCK or EAGAIN. For all other values of errno this always signals a
Packit Service 963350 
critical error.
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
gst_poll_write_control ()
Packit Service 963350 
gboolean
Packit Service 963350 
gst_poll_write_control (GstPoll *set);
Packit Service 963350 
Write a byte to the control socket of the controllable set
Packit Service 963350 
.
Packit Service 963350 
This function is mostly useful for timer GstPoll objects created with
Packit Service 963350 
gst_poll_new_timer().
Packit Service 963350 
It will make any current and future gst_poll_wait() function return with
Packit Service 963350 
1, meaning the control socket is set. After an equal amount of calls to
Packit Service 963350 
gst_poll_read_control() have been performed, calls to gst_poll_wait() will
Packit Service 963350 
block again until their timeout expired.
Packit Service 963350 
This function only works for timer GstPoll objects created with
Packit Service 963350 
gst_poll_new_timer().
Packit Service 963350
Packit Service 963350 
Parameters
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
set
Packit Service 963350 
a GstPoll.
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
Returns
Packit Service 963350 
 TRUE on success. FALSE when when the byte could not be written.
Packit Service 963350 
errno contains the detailed error code but will never be EAGAIN, EINTR or
Packit Service 963350 
EWOULDBLOCK. FALSE always signals a critical error.
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
Types and Values
Packit Service 963350
Packit Service 963350 
GstPoll
Packit Service 963350 
typedef struct _GstPoll GstPoll;
Packit Service 963350 
A set of file/network descriptors.
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
GstPollFD
Packit Service 963350 
typedef struct {
Packit Service 963350 
  int fd;
Packit Service 963350 
} GstPollFD;
Packit Service 963350
Packit Service 963350 
A file descriptor object.
Packit Service 963350
Packit Service 963350 
Members
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
int fd;
Packit Service 963350 
a file descriptor
Packit Service 963350 
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
GST_POLL_FD_INIT
Packit Service 963350 
#define GST_POLL_FD_INIT  { -1, -1 }
Packit Service 963350
Packit Service 963350 
A GstPollFD must be initialized with this macro, before it can be
Packit Service 963350 
used. This macro can used be to initialize a variable, but it cannot
Packit Service 963350 
be assigned to a variable. In that case you have to use
Packit Service 963350 
gst_poll_fd_init().
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350 
Generated by GTK-Doc V1.27
Packit Service 963350 
</body>
Packit Service 963350 
</html>

Powered by Pagure 5.13.3

SSH Hostkey/Fingerprint | Documentation