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 typedef enum
  59 {
  60   G_SOCKET_DOMAIN_INET,
  61   G_SOCKET_DOMAIN_INET6,
  62   G_SOCKET_DOMAIN_UNIX
  63 } GSocketDomain;
  64
  65 typedef enum
  66 {
  67   G_SOCKET_TYPE_STREAM,
  68   G_SOCKET_TYPE_DATAGRAM,
  69   G_SOCKET_TYPE_SEQPACKET
  70 } GSocketType;
  71
  72 GType            g_socket_get_type         (void) G_GNUC_CONST;
  73
  74 GSocket *        g_socket_new              (GSocketDomain domain, GSocketType type, const gchar *protocol, GError **error);
  75
  76 GSocket *        g_socket_new_from_fd      (gint fd);
  77
  78 GSocketAddress * g_socket_get_peer_address (GSocket *socket, GError **error);
  79
  80 void             g_socket_set_blocking     (GSocket  *socket,
  81                                             gboolean  blocking);
  82
  83 gboolean         g_socket_get_blocking     (GSocket  *socket);
  84
  85 gboolean         g_socket_bind             (GSocket         *socket,
  86                                             GSocketAddress  *address,
  87                                             GError         **error);
  88
  89 gboolean         g_socket_connect          (GSocket         *socket,
  90                                             GSocketAddress  *address,
  91                                             GCancellable    *cancellable,
  92                                             GError         **error);
  93
  94 void             g_socket_connect_async    (GSocket             *socket,
  95                                             GSocketAddress      *address,
  96                                             GCancellable        *cancellable,
  97                                             GAsyncReadyCallback  callback,
  98                                             gpointer             user_data);
  99
 100 gboolean         g_socket_connect_finish   (GSocket       *socket,
 101                                             GAsyncResult  *result,
 102                                             GError       **error);
 103
 104 GSocket *        g_socket_accept           (GSocket       *socket,
 105                                             GCancellable  *cancellable,
 106                                             GError       **error);
 107
 108 void             g_socket_accept_async     (GSocket             *socket,
 109                                             GCancellable        *cancellable,
 110                                             GAsyncReadyCallback  callback,
 111                                             gpointer             user_data);
 112
 113 GSocket *        g_socket_accept_finish    (GSocket       *socket,
 114                                             GAsyncResult  *result,
 115                                             GError       **error);
 116
 117 void             g_socket_listen           (GSocket *socket,
 118                                             gint backlog);
 119
 120 gssize           g_socket_receive          (GSocket       *socket,
 121                                             gchar         *buffer,
 122                                             gsize          size,
 123                                             GCancellable  *cancellable,
 124                                             GError       **error);
 125
 126 void             g_socket_receive_async    (GSocket             *socket,
 127                                             gchar               *buffer,
 128                                             gsize                size,
 129                                             GCancellable        *cancellable,
 130                                             GAsyncReadyCallback  callback,
 131                                             gpointer             user_data);
 132
 133 gssize           g_socket_receive_finish   (GSocket       *socket,
 134                                             GAsyncResult  *result,
 135                                             GError       **error);
 136
 137 gssize           g_socket_send             (GSocket       *socket,
 138                                             gchar         *buffer,
 139                                             gsize          size,
 140                                             GCancellable  *cancellable,
 141                                             GError       **error);
 142
 143 void             g_socket_send_async       (GSocket             *socket,
 144                                             gchar               *buffer,
 145                                             gsize                size,
 146                                             GCancellable        *cancellable,
 147                                             GAsyncReadyCallback  callback,
 148                                             gpointer             user_data);
 149
 150 gssize           g_socket_send_finish      (GSocket       *socket,
 151                                             GAsyncResult  *result,
 152                                             GError       **error);
 153
 154 G_END_DECLS
 155
 156 #endif /* G_SOCKET_H */
 157