gio/gsocketconnection.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  * Copyright © 2008 Christian Kellner, Samuel Cormier-Iijima
   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: Christian Kellner <gicmo@gnome.org>
  21  *          Samuel Cormier-Iijima <sciyoshi@gmail.com>
  22  *          Ryan Lortie <desrt@desrt.ca>
  23  *          Alexander Larsson <alexl@redhat.com>
  24  */
  25
  26 #ifndef __G_SOCKET_CONNECTION_H__
  27 #define __G_SOCKET_CONNECTION_H__
  28
  29 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  30 #error "Only <gio/gio.h> can be included directly."
  31 #endif
  32
  33 #include <glib-object.h>
  34 #include <gio/gsocket.h>
  35 #include <gio/giostream.h>
  36
  37 G_BEGIN_DECLS
  38
  39 #define G_TYPE_SOCKET_CONNECTION                            (g_socket_connection_get_type ())
  40 #define G_SOCKET_CONNECTION(inst)                           (G_TYPE_CHECK_INSTANCE_CAST ((inst),                     \
  41                                                              G_TYPE_SOCKET_CONNECTION, GSocketConnection))
  42 #define G_SOCKET_CONNECTION_CLASS(class)                    (G_TYPE_CHECK_CLASS_CAST ((class),                       \
  43                                                              G_TYPE_SOCKET_CONNECTION, GSocketConnectionClass))
  44 #define G_IS_SOCKET_CONNECTION(inst)                        (G_TYPE_CHECK_INSTANCE_TYPE ((inst),                     \
  45                                                              G_TYPE_SOCKET_CONNECTION))
  46 #define G_IS_SOCKET_CONNECTION_CLASS(class)                 (G_TYPE_CHECK_CLASS_TYPE ((class),                       \
  47                                                              G_TYPE_SOCKET_CONNECTION))
  48 #define G_SOCKET_CONNECTION_GET_CLASS(inst)                 (G_TYPE_INSTANCE_GET_CLASS ((inst),                      \
  49                                                              G_TYPE_SOCKET_CONNECTION, GSocketConnectionClass))
  50
  51 typedef struct _GSocketConnectionPrivate                    GSocketConnectionPrivate;
  52 typedef struct _GSocketConnectionClass                      GSocketConnectionClass;
  53
  54 struct _GSocketConnectionClass
  55 {
  56   GIOStreamClass parent_class;
  57
  58   /* Padding for future expansion */
  59   void (*_g_reserved1) (void);
  60   void (*_g_reserved2) (void);
  61   void (*_g_reserved3) (void);
  62   void (*_g_reserved4) (void);
  63   void (*_g_reserved5) (void);
  64   void (*_g_reserved6) (void);
  65 };
  66
  67 struct _GSocketConnection
  68 {
  69   GIOStream parent_instance;
  70   GSocketConnectionPrivate *priv;
  71 };
  72
  73 GLIB_AVAILABLE_IN_ALL
  74 GType              g_socket_connection_get_type                  (void) G_GNUC_CONST;
  75
  76 GLIB_AVAILABLE_IN_2_32
  77 gboolean           g_socket_connection_is_connected              (GSocketConnection  *connection);
  78 GLIB_AVAILABLE_IN_2_32
  79 gboolean           g_socket_connection_connect                   (GSocketConnection  *connection,
  80                                                                   GSocketAddress     *address,
  81                                                                   GCancellable       *cancellable,
  82                                                                   GError            **error);
  83 GLIB_AVAILABLE_IN_2_32
  84 void               g_socket_connection_connect_async             (GSocketConnection  *connection,
  85                                                                   GSocketAddress     *address,
  86                                                                   GCancellable       *cancellable,
  87                                                                   GAsyncReadyCallback callback,
  88                                                                   gpointer            user_data);
  89 GLIB_AVAILABLE_IN_2_32
  90 gboolean           g_socket_connection_connect_finish            (GSocketConnection  *connection,
  91                                                                   GAsyncResult       *result,
  92                                                                   GError            **error);
  93
  94 GLIB_AVAILABLE_IN_ALL
  95 GSocket           *g_socket_connection_get_socket                (GSocketConnection  *connection);
  96 GLIB_AVAILABLE_IN_ALL
  97 GSocketAddress    *g_socket_connection_get_local_address         (GSocketConnection  *connection,
  98                                                                   GError            **error);
  99 GLIB_AVAILABLE_IN_ALL
 100 GSocketAddress    *g_socket_connection_get_remote_address        (GSocketConnection  *connection,
 101                                                                   GError            **error);
 102
 103 GLIB_AVAILABLE_IN_ALL
 104 void               g_socket_connection_factory_register_type     (GType               g_type,
 105                                                                   GSocketFamily       family,
 106                                                                   GSocketType         type,
 107                                                                   gint                protocol);
 108 GLIB_AVAILABLE_IN_ALL
 109 GType              g_socket_connection_factory_lookup_type       (GSocketFamily       family,
 110                                                                   GSocketType         type,
 111                                                                   gint                protocol_id);
 112 GLIB_AVAILABLE_IN_ALL
 113 GSocketConnection *g_socket_connection_factory_create_connection (GSocket            *socket);
 114
 115 G_END_DECLS
 116
 117 #endif /* __G_SOCKET_CONNECTION_H__ */