glib-unix: add function to ensure an fd is sealed

[platform/upstream/glib.git] / glib / glib-unix.h

diff --git a/glib/glib-unix.h b/glib/glib-unix.h
index 9642b5c..ab1cd1c 100644 (file)
--- a/glib/glib-unix.h
+++ b/glib/glib-unix.h
@@ -12,9 +12,7 @@
  * 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., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  */
 
 #ifndef __G_UNIX_H__
@@ -38,43 +36,87 @@
 #error "This header may only be used on UNIX"
 #endif
 
+G_BEGIN_DECLS
+
 /**
  * G_UNIX_ERROR:
  *
- * Error domain for API in the "g_unix_" namespace.  Note that there is
- * no exported enumeration mapping %errno.  Instead, all functions
- * ensure that %errno is relevant.  The code for all #G_UNIX_ERROR is
- * always <literal>0</literal>, and the error message is always
- * generated via g_strerror().
+ * Error domain for API in the g_unix_ namespace. Note that there is no
+ * exported enumeration mapping %errno. Instead, all functions ensure that
+ * %errno is relevant. The code for all #G_UNIX_ERROR is always 0, and the
+ * error message is always generated via g_strerror().
  *
- * It is expected that most code will not look at %errno from these
- * APIs. Important cases where one would want to differentiate between
- * errors are already covered by existing cross-platform GLib API,
- * such as e.g. #GFile wrapping %ENOENT.  However, it is provided for
- * completeness, at least.
+ * It is expected that most code will not look at %errno from these APIs.
+ * Important cases where one would want to differentiate between errors are
+ * already covered by existing cross-platform GLib API, such as e.g. #GFile
+ * wrapping `ENOENT`. However, it is provided for completeness, at least.
  */
 #define G_UNIX_ERROR (g_unix_error_quark())
 
+GLIB_AVAILABLE_IN_2_30
 GQuark g_unix_error_quark (void);
 
+GLIB_AVAILABLE_IN_2_30
 gboolean g_unix_open_pipe (gint    *fds,
                            gint     flags,
                            GError **error);
 
+GLIB_AVAILABLE_IN_2_30
 gboolean g_unix_set_fd_nonblocking (gint       fd,
                                     gboolean   nonblock,
                                     GError   **error);
 
+GLIB_AVAILABLE_IN_2_30
 GSource *g_unix_signal_source_new  (gint signum);
 
+GLIB_AVAILABLE_IN_2_30
 guint    g_unix_signal_add_full    (gint           priority,
                                     gint           signum,
                                     GSourceFunc    handler,
                                     gpointer       user_data,
                                     GDestroyNotify notify);
 
+GLIB_AVAILABLE_IN_2_30
 guint    g_unix_signal_add         (gint        signum,
                                     GSourceFunc handler,
                                     gpointer    user_data);
 
-#endif
+/**
+ * GUnixFDSourceFunc:
+ * @fd: the fd that triggered the event
+ * @condition: the IO conditions reported on @fd
+ * @user_data: user data passed to g_unix_fd_add()
+ *
+ * The type of functions to be called when a UNIX fd watch source
+ * triggers.
+ *
+ * Returns: %FALSE if the source should be removed
+ **/
+typedef gboolean (*GUnixFDSourceFunc) (gint         fd,
+                                       GIOCondition condition,
+                                       gpointer     user_data);
+
+GLIB_AVAILABLE_IN_2_36
+GSource *g_unix_fd_source_new      (gint         fd,
+                                    GIOCondition condition);
+
+GLIB_AVAILABLE_IN_2_36
+guint    g_unix_fd_add_full        (gint              priority,
+                                    gint              fd,
+                                    GIOCondition      condition,
+                                    GUnixFDSourceFunc function,
+                                    gpointer          user_data,
+                                    GDestroyNotify    notify);
+
+GLIB_AVAILABLE_IN_2_36
+guint    g_unix_fd_add             (gint              fd,
+                                    GIOCondition      condition,
+                                    GUnixFDSourceFunc function,
+                                    gpointer          user_data);
+
+GLIB_AVAILABLE_IN_2_44
+gboolean g_unix_fd_ensure_zero_copy_safe (gint fd);
+
+G_END_DECLS
+
+#endif  /* __G_UNIX_H__ */