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 <gnio/gsocketaddress.h>
  31
  32 G_BEGIN_DECLS
  33
  34 #define G_TYPE_SOCKET         (g_socket_get_type ())
  35 #define G_SOCKET(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_SOCKET, GSocket))
  36 #define G_SOCKET_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_SOCKET, GSocketClass))
  37 #define G_IS_SOCKET(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_SOCKET))
  38 #define G_IS_SOCKET_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_SOCKET))
  39 #define G_SOCKET_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_SOCKET, GSocket))
  40
  41 typedef struct _GSocket          GSocket;
  42 typedef struct _GSocketClass     GSocketClass;
  43 typedef struct _GSocketPrivate   GSocketPrivate;
  44
  45 struct _GSocket
  46 {
  47   GObject parent;
  48
  49   GSocketPrivate *priv;
  50 };
  51
  52 struct _GSocketClass
  53 {
  54   GObjectClass parent_class;
  55 };
  56
  57 typedef enum
  58 {
  59   G_SOCKET_DOMAIN_INET,
  60   G_SOCKET_DOMAIN_INET6,
  61   G_SOCKET_DOMAIN_UNIX
  62 } GSocketDomain;
  63
  64 typedef enum
  65 {
  66   G_SOCKET_TYPE_STREAM,
  67   G_SOCKET_TYPE_DATAGRAM,
  68   G_SOCKET_TYPE_SEQPACKET
  69 } GSocketType;
  70
  71 GType            g_socket_get_type           (void) G_GNUC_CONST;
  72
  73 GSocket *        g_socket_new                (GSocketDomain   domain,
  74                                               GSocketType     type,
  75                                               const gchar    *protocol);
  76
  77 GSocket *        g_socket_new_from_fd        (gint fd);
  78
  79 GSocketAddress * g_socket_get_local_address  (GSocket *socket, GError **error);
  80
  81 GSocketAddress * g_socket_get_remote_address (GSocket *socket, GError **error);
  82
  83 void             g_socket_set_blocking       (GSocket  *socket,
  84                                               gboolean  blocking);
  85
  86 gboolean         g_socket_get_blocking       (GSocket  *socket);
  87
  88 void             g_socket_set_reuse_address  (GSocket  *socket,
  89                                               gboolean  reuse);
  90
  91 gboolean         g_socket_get_reuse_address  (GSocket  *socket);
  92
  93 gboolean         g_socket_has_socket_error   (GSocket  *socket,
  94                                               GError  **error);
  95
  96 gboolean         g_socket_bind               (GSocket         *socket,
  97                                               GSocketAddress  *address,
  98                                               GError         **error);
  99
 100 gboolean         g_socket_connect            (GSocket         *socket,
 101                                               GSocketAddress  *address,
 102                                               GError         **error);
 103
 104 GSocket *        g_socket_accept             (GSocket       *socket,
 105                                               GError       **error);
 106
 107 gboolean         g_socket_listen             (GSocket  *socket,
 108                                               GError  **error);
 109
 110 gssize           g_socket_receive            (GSocket       *socket,
 111                                               gchar         *buffer,
 112                                               gsize          size,
 113                                               GError       **error);
 114
 115 gssize           g_socket_send               (GSocket       *socket,
 116                                               const gchar   *buffer,
 117                                               gsize          size,
 118                                               GError       **error);
 119
 120 void             g_socket_close              (GSocket *socket);
 121
 122 GSource *        g_socket_create_source      (GSocket      *socket,
 123                                               GIOCondition  condition,
 124                                               GCancellable *cancellable);
 125
 126 G_END_DECLS
 127
 128 #endif /* G_SOCKET_H */
 129