gnio/gsocket.h

   1 /* GNIO - GLib Network Layer of GIO
   2  *
   3  * Copyright (C) 2008 Christian Kellner, Samuel Cormier-Iijima
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at 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  */
  23
  24 #ifndef G_SOCKET_H
  25 #define G_SOCKET_H
  26
  27 #include <glib-object.h>
  28 #include <gio/gio.h>
  29
  30 #include "ginetaddress.h"
  31 #include "gsocketaddress.h"
  32
  33 G_BEGIN_DECLS
  34
  35 #define G_TYPE_SOCKET         (g_socket_get_type ())
  36 #define G_SOCKET(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_SOCKET, GSocket))
  37 #define G_SOCKET_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_SOCKET, GSocketClass))
  38 #define G_IS_SOCKET(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_SOCKET))
  39 #define G_IS_SOCKET_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_SOCKET))
  40 #define G_SOCKET_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_SOCKET, GSocket))
  41
  42 typedef struct _GSocket          GSocket;
  43 typedef struct _GSocketClass     GSocketClass;
  44 typedef struct _GSocketPrivate   GSocketPrivate;
  45
  46 struct _GSocket
  47 {
  48   GObject parent;
  49
  50   GSocketPrivate *priv;
  51 };
  52
  53 struct _GSocketClass
  54 {
  55   GObjectClass parent_class;
  56 };
  57
  58 GType          g_socket_get_type         (void) G_GNUC_CONST;
  59
  60 GSocket *      g_socket_new              (gint domain, gint type, gint protocol);
  61
  62 GSocket *      g_socket_new_from_fd      (gint fd);
  63
  64 void           g_socket_set_blocking     (GSocket  *socket,
  65                                           gboolean  blocking);
  66
  67 gboolean       g_socket_bind             (GSocket         *socket,
  68                                           GSocketAddress  *address,
  69                                           GError         **error);
  70
  71 gboolean       g_socket_connect          (GSocket         *socket,
  72                                           GSocketAddress  *address,
  73                                           GCancellable    *cancellable,
  74                                           GError         **error);
  75
  76 void           g_socket_connect_async    (GSocket             *socket,
  77                                           GSocketAddress      *address,
  78                                           GCancellable        *cancellable,
  79                                           GAsyncReadyCallback *callback,
  80                                           gpointer             user_data);
  81
  82 gboolean       g_socket_connect_finish   (GSocket       *socket,
  83                                           GAsyncResult  *result,
  84                                           GError       **error);
  85
  86 GSocket *      g_socket_accept           (GSocket       *socket,
  87                                           GCancellable  *cancellable,
  88                                           GError       **error);
  89
  90 void           g_socket_accept_async     (GSocket             *socket,
  91                                           GCancellable        *cancellable,
  92                                           GAsyncReadyCallback *callback,
  93                                           gpointer             user_data);
  94
  95 GSocket *      g_socket_accept_finish    (GSocket       *socket,
  96                                           GAsyncResult  *result,
  97                                           GError       **error);
  98
  99 void           g_socket_listen           (GSocket *socket,
 100                                           int backlog);
 101
 102 gssize         g_socket_receive          (GSocket       *socket,
 103                                           gchar         *buffer,
 104                                           gsize          size,
 105                                           GCancellable  *cancellable,
 106                                           GError       **error);
 107
 108 void           g_socket_receive_async    (GSocket             *socket,
 109                                           gchar               *buffer,
 110                                           gsize                size,
 111                                           GCancellable        *cancellable,
 112                                           GAsyncReadyCallback *callback,
 113                                           gpointer             user_data);
 114
 115 gssize         g_socket_receive_finish   (GSocket       *socket,
 116                                           GAsyncResult  *result,
 117                                           GError       **error);
 118
 119 gssize         g_socket_send             (GSocket       *socket,
 120                                           gchar         *buffer,
 121                                           gsize          size,
 122                                           GCancellable  *cancellable,
 123                                           GError       **error);
 124
 125 void           g_socket_send_async       (GSocket             *socket,
 126                                           gchar               *buffer,
 127                                           gsize                size,
 128                                           GCancellable        *cancellable,
 129                                           GAsyncReadyCallback *callback,
 130                                           gpointer             user_data);
 131
 132 gssize         g_socket_send_finish      (GSocket       *socket,
 133                                           GAsyncResult  *result,
 134                                           GError       **error);
 135
 136 G_END_DECLS
 137
 138 #endif /* G_SOCKET_H */
 139