gio/gsocketlistener.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright © 2008 Christian Kellner, Samuel Cormier-Iijima
   4  * Copyright © 2009 Codethink Limited
   5  * Copyright © 2009 Red Hat, Inc
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Lesser General Public License as published
   9  * by the Free Software Foundation; either version 2 of the licence or (at
  10  * your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General
  18  * Public License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  *
  22  * Authors: Christian Kellner <gicmo@gnome.org>
  23  *          Samuel Cormier-Iijima <sciyoshi@gmail.com>
  24  *          Ryan Lortie <desrt@desrt.ca>
  25  *          Alexander Larsson <alexl@redhat.com>
  26  */
  27
  28 #ifndef __G_SOCKET_LISTENER_H__
  29 #define __G_SOCKET_LISTENER_H__
  30
  31 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  32 #error "Only <gio/gio.h> can be included directly."
  33 #endif
  34
  35 #include <gio/giotypes.h>
  36
  37 G_BEGIN_DECLS
  38
  39 #define G_TYPE_SOCKET_LISTENER                              (g_socket_listener_get_type ())
  40 #define G_SOCKET_LISTENER(inst)                             (G_TYPE_CHECK_INSTANCE_CAST ((inst),                     \
  41                                                              G_TYPE_SOCKET_LISTENER, GSocketListener))
  42 #define G_SOCKET_LISTENER_CLASS(class)                      (G_TYPE_CHECK_CLASS_CAST ((class),                       \
  43                                                              G_TYPE_SOCKET_LISTENER, GSocketListenerClass))
  44 #define G_IS_SOCKET_LISTENER(inst)                          (G_TYPE_CHECK_INSTANCE_TYPE ((inst),                     \
  45                                                              G_TYPE_SOCKET_LISTENER))
  46 #define G_IS_SOCKET_LISTENER_CLASS(class)                   (G_TYPE_CHECK_CLASS_TYPE ((class),                       \
  47                                                              G_TYPE_SOCKET_LISTENER))
  48 #define G_SOCKET_LISTENER_GET_CLASS(inst)                   (G_TYPE_INSTANCE_GET_CLASS ((inst),                      \
  49                                                              G_TYPE_SOCKET_LISTENER, GSocketListenerClass))
  50
  51 typedef struct _GSocketListenerPrivate                      GSocketListenerPrivate;
  52 typedef struct _GSocketListenerClass                        GSocketListenerClass;
  53
  54 /**
  55  * GSocketListenerClass:
  56  * @changed: virtual method called when the set of socket listened to changes
  57  **/
  58 struct _GSocketListenerClass
  59 {
  60   GObjectClass parent_class;
  61
  62   void (* changed) (GSocketListener *listener);
  63
  64   /* Padding for future expansion */
  65   void (*_g_reserved1) (void);
  66   void (*_g_reserved2) (void);
  67   void (*_g_reserved3) (void);
  68   void (*_g_reserved4) (void);
  69   void (*_g_reserved5) (void);
  70   void (*_g_reserved6) (void);
  71 };
  72
  73 struct _GSocketListener
  74 {
  75   GObject parent_instance;
  76   GSocketListenerPrivate *priv;
  77 };
  78
  79 GLIB_AVAILABLE_IN_ALL
  80 GType                   g_socket_listener_get_type                      (void) G_GNUC_CONST;
  81
  82 GLIB_AVAILABLE_IN_ALL
  83 GSocketListener *       g_socket_listener_new                           (void);
  84
  85 GLIB_AVAILABLE_IN_ALL
  86 void                    g_socket_listener_set_backlog                   (GSocketListener     *listener,
  87                                                                          int                  listen_backlog);
  88
  89 GLIB_AVAILABLE_IN_ALL
  90 gboolean                g_socket_listener_add_socket                    (GSocketListener     *listener,
  91                                                                          GSocket             *socket,
  92                                                                          GObject             *source_object,
  93                                                                          GError             **error);
  94 GLIB_AVAILABLE_IN_ALL
  95 gboolean                g_socket_listener_add_address                   (GSocketListener     *listener,
  96                                                                          GSocketAddress      *address,
  97                                                                          GSocketType          type,
  98                                                                          GSocketProtocol      protocol,
  99                                                                          GObject             *source_object,
 100                                                                          GSocketAddress     **effective_address,
 101                                                                          GError             **error);
 102 GLIB_AVAILABLE_IN_ALL
 103 gboolean                g_socket_listener_add_inet_port                 (GSocketListener     *listener,
 104                                                                          guint16              port,
 105                                                                          GObject             *source_object,
 106                                                                          GError             **error);
 107 GLIB_AVAILABLE_IN_ALL
 108 guint16                 g_socket_listener_add_any_inet_port             (GSocketListener     *listener,
 109                                                                          GObject             *source_object,
 110                                                                          GError             **error);
 111
 112 GLIB_AVAILABLE_IN_ALL
 113 GSocket *               g_socket_listener_accept_socket                 (GSocketListener      *listener,
 114                                                                          GObject             **source_object,
 115                                                                          GCancellable         *cancellable,
 116                                                                          GError              **error);
 117 GLIB_AVAILABLE_IN_ALL
 118 void                    g_socket_listener_accept_socket_async           (GSocketListener      *listener,
 119                                                                          GCancellable         *cancellable,
 120                                                                          GAsyncReadyCallback   callback,
 121                                                                          gpointer              user_data);
 122 GLIB_AVAILABLE_IN_ALL
 123 GSocket *               g_socket_listener_accept_socket_finish          (GSocketListener      *listener,
 124                                                                          GAsyncResult         *result,
 125                                                                          GObject             **source_object,
 126                                                                          GError              **error);
 127
 128
 129 GLIB_AVAILABLE_IN_ALL
 130 GSocketConnection *     g_socket_listener_accept                        (GSocketListener      *listener,
 131                                                                          GObject             **source_object,
 132                                                                          GCancellable         *cancellable,
 133                                                                          GError              **error);
 134
 135 GLIB_AVAILABLE_IN_ALL
 136 void                    g_socket_listener_accept_async                  (GSocketListener      *listener,
 137                                                                          GCancellable         *cancellable,
 138                                                                          GAsyncReadyCallback   callback,
 139                                                                          gpointer              user_data);
 140
 141 GLIB_AVAILABLE_IN_ALL
 142 GSocketConnection *     g_socket_listener_accept_finish                 (GSocketListener      *listener,
 143                                                                          GAsyncResult         *result,
 144                                                                          GObject             **source_object,
 145                                                                          GError              **error);
 146
 147 GLIB_AVAILABLE_IN_ALL
 148 void                    g_socket_listener_close                         (GSocketListener      *listener);
 149
 150 G_END_DECLS
 151
 152 #endif /* __G_SOCKET_LISTENER_H__ */