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_local_address  (GSocket *socket, GError **error);
  79
  80 GSocketAddress * g_socket_get_remote_address (GSocket *socket, GError **error);
  81
  82 void             g_socket_set_blocking       (GSocket  *socket,
  83                                               gboolean  blocking);
  84
  85 gboolean         g_socket_get_blocking       (GSocket  *socket);
  86
  87 gboolean         g_socket_bind               (GSocket         *socket,
  88                                               GSocketAddress  *address,
  89                                               GError         **error);
  90
  91 gboolean         g_socket_connect            (GSocket         *socket,
  92                                               GSocketAddress  *address,
  93                                               GError         **error);
  94
  95 GSocket *        g_socket_accept             (GSocket       *socket,
  96                                               GError       **error);
  97
  98 void             g_socket_listen             (GSocket *socket,
  99                                               gint backlog);
 100
 101 gssize           g_socket_receive            (GSocket       *socket,
 102                                               gchar         *buffer,
 103                                               gsize          size,
 104                                               GError       **error);
 105
 106 gssize           g_socket_send               (GSocket       *socket,
 107                                               gchar         *buffer,
 108                                               gsize          size,
 109                                               GError       **error);
 110
 111 G_END_DECLS
 112
 113 #endif /* G_SOCKET_H */
 114