gio/gunixconnection.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright © 2009 Codethink Limited
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU Lesser General Public License as published
   7  * by the Free Software Foundation; either version 2 of the licence or (at
   8  * your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General
  16  * Public License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Authors: Ryan Lortie <desrt@desrt.ca>
  21  */
  22
  23 #ifndef __G_UNIX_CONNECTION_H__
  24 #define __G_UNIX_CONNECTION_H__
  25
  26 #include <gio/gio.h>
  27
  28 G_BEGIN_DECLS
  29
  30 #define G_TYPE_UNIX_CONNECTION                              (g_unix_connection_get_type ())
  31 #define G_UNIX_CONNECTION(inst)                             (G_TYPE_CHECK_INSTANCE_CAST ((inst),                     \
  32                                                              G_TYPE_UNIX_CONNECTION, GUnixConnection))
  33 #define G_UNIX_CONNECTION_CLASS(class)                      (G_TYPE_CHECK_CLASS_CAST ((class),                       \
  34                                                              G_TYPE_UNIX_CONNECTION, GUnixConnectionClass))
  35 #define G_IS_UNIX_CONNECTION(inst)                          (G_TYPE_CHECK_INSTANCE_TYPE ((inst),                     \
  36                                                              G_TYPE_UNIX_CONNECTION))
  37 #define G_IS_UNIX_CONNECTION_CLASS(class)                   (G_TYPE_CHECK_CLASS_TYPE ((class),                       \
  38                                                              G_TYPE_UNIX_CONNECTION))
  39 #define G_UNIX_CONNECTION_GET_CLASS(inst)                   (G_TYPE_INSTANCE_GET_CLASS ((inst),                      \
  40                                                              G_TYPE_UNIX_CONNECTION, GUnixConnectionClass))
  41
  42 /**
  43  * GTcpConnection:
  44  *
  45  * A #GSocketConnection for UNIX domain socket connections.
  46  *
  47  * Since: 2.22
  48  */
  49 typedef struct _GUnixConnection                             GUnixConnection;
  50 typedef struct _GUnixConnectionPrivate                      GUnixConnectionPrivate;
  51 typedef struct _GUnixConnectionClass                        GUnixConnectionClass;
  52
  53 struct _GUnixConnectionClass
  54 {
  55   GSocketConnectionClass parent_class;
  56 };
  57
  58 struct _GUnixConnection
  59 {
  60   GSocketConnection parent_instance;
  61   GUnixConnectionPrivate *priv;
  62 };
  63
  64 GType                   g_unix_connection_get_type                      (void);
  65
  66 gboolean                g_unix_connection_send_fd                       (GUnixConnection      *connection,
  67                                                                          gint                  fd,
  68                                                                          GCancellable         *cancellable,
  69                                                                          GError              **error);
  70 gint                    g_unix_connection_receive_fd                    (GUnixConnection      *connection,
  71                                                                          GCancellable         *cancellable,
  72                                                                          GError              **error);
  73
  74 gboolean                g_unix_connection_send_credentials              (GUnixConnection      *connection,
  75                                                                          GCancellable         *cancellable,
  76                                                                          GError              **error);
  77 void                    g_unix_connection_send_credentials_async        (GUnixConnection      *connection,
  78                                                                          GCancellable         *cancellable,
  79                                                                          GAsyncReadyCallback   callback,
  80                                                                          gpointer              user_data);
  81 gboolean                g_unix_connection_send_credentials_finish       (GUnixConnection      *connection,
  82                                                                          GAsyncResult         *result,
  83                                                                          GError              **error);
  84
  85 GCredentials           *g_unix_connection_receive_credentials           (GUnixConnection      *connection,
  86                                                                          GCancellable         *cancellable,
  87                                                                          GError              **error);
  88 void                    g_unix_connection_receive_credentials_async     (GUnixConnection      *connection,
  89                                                                          GCancellable         *cancellable,
  90                                                                          GAsyncReadyCallback   callback,
  91                                                                          gpointer              user_data);
  92 GCredentials           *g_unix_connection_receive_credentials_finish    (GUnixConnection      *connection,
  93                                                                          GAsyncResult         *result,
  94                                                                          GError              **error);
  95
  96 G_END_DECLS
  97
  98 #endif /* __G_UNIX_CONNECTION_H__ */