new gsocket.h
[cascardo/gnio.git] / 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
45 struct _GSocket
46 {
47   GObject parent;
48 };
49
50 struct _GSocketClass
51 {
52   GObjectClass parent_class;
53 };
54
55 GType          g_socket_get_type (void) G_GNUC_CONST;
56
57 GSocket *      g_socket_new ();
58
59 void           g_socket_bind             (GSocket        *socket,
60                                           GSocketAddress *address);
61
62 void           g_socket_connect          (GSocket        *socket,
63                                           GSocketAddress *address,
64                                           GCancellable   *cancellable);
65
66 void           g_socket_connect_async    (GSocket             *socket,
67                                           GSocketAddress      *address,
68                                           GCancellable        *cancellable,
69                                           GAsyncReadyCallback *callback,
70                                           gpointer             user_data);
71
72 void           g_socket_connect_finish   (GSocket       *socket,
73                                           GAsyncResult  *result,
74                                           GError       **error);
75
76 GSocket *      g_socket_accept           (GSocket       *socket,
77                                           GCancellable  *cancellable,
78                                           GError       **error);
79
80 void           g_socket_accept_async     (GSocket             *socket,
81                                           GCancellable        *cancellable,
82                                           GAsyncReadyCallback *callback,
83                                           gpointer             user_data);
84
85 GSocket *      g_socket_accept_finish    (GSocket       *socket,
86                                           GAsyncResult  *result,
87                                           GError       **error);
88
89 void           g_socket_listen           (GSocket *socket,
90                                           int backlog);
91
92 gssize         g_socket_receive          (GSocket       *socket,
93                                           gchar         *buffer,
94                                           gsize          size,
95                                           GCancellable  *cancellable,
96                                           GError       **error);
97
98 void           g_socket_receive_async    (GSocket             *socket,
99                                           gchar               *buffer,
100                                           gsize                size,
101                                           GCancellable        *cancellable,
102                                           GAsyncReadyCallback *callback,
103                                           gpointer             user_data);
104
105 gssize         g_socket_receive_finish   (GSocket       *socket,
106                                           GAsyncResult  *result,
107                                           GError       **error);
108
109 gssize         g_socket_send             (GSocket       *socket,
110                                           gchar         *buffer,
111                                           gsize          size,
112                                           GCancellable  *cancellable,
113                                           GError       **error);
114
115 void           g_socket_send_async       (GSocket             *socket,
116                                           gchar               *buffer,
117                                           gsize                size,
118                                           GCancellable        *cancellable,
119                                           GAsyncReadyCallback *callback,
120                                           gpointer             user_data);
121
122 gssize         g_socket_send_finish      (GSocket       *socket,
123                                           GAsyncResult  *result,
124                                           GError       **error);
125
126 G_END_DECLS
127
128 #endif /* G_SOCKET_H */
129