d8259b3a62e4da2a18803137f99e635ad1484c7e
[platform/upstream/glib.git] / gio / gsocketclient.h
1 /* GIO - GLib Input, Output and Streaming Library
2  *
3  * Copyright © 2008, 2009 Codethink Limited
4  * Copyright © 2009 Red Hat, Inc
5  *
6  * This program is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU Lesser General Public License as published
8  * by the Free Software Foundation; either version 2 of the licence or (at
9  * your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General
17  * Public License along with this library; if not, write to the
18  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
19  * Boston, MA 02111-1307, USA.
20  *
21  * Authors: Ryan Lortie <desrt@desrt.ca>
22  *          Alexander Larsson <alexl@redhat.com>
23  */
24
25 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
26 #error "Only <gio/gio.h> can be included directly."
27 #endif
28
29 #ifndef __G_SOCKET_CLIENT_H__
30 #define __G_SOCKET_CLIENT_H__
31
32 #include <gio/giotypes.h>
33
34 G_BEGIN_DECLS
35
36 #define G_TYPE_SOCKET_CLIENT                                (g_socket_client_get_type ())
37 #define G_SOCKET_CLIENT(inst)                               (G_TYPE_CHECK_INSTANCE_CAST ((inst),                     \
38                                                              G_TYPE_SOCKET_CLIENT, GSocketClient))
39 #define G_SOCKET_CLIENT_CLASS(class)                        (G_TYPE_CHECK_CLASS_CAST ((class),                       \
40                                                              G_TYPE_SOCKET_CLIENT, GSocketClientClass))
41 #define G_IS_SOCKET_CLIENT(inst)                            (G_TYPE_CHECK_INSTANCE_TYPE ((inst),                     \
42                                                              G_TYPE_SOCKET_CLIENT))
43 #define G_IS_SOCKET_CLIENT_CLASS(class)                     (G_TYPE_CHECK_CLASS_TYPE ((class),                       \
44                                                              G_TYPE_SOCKET_CLIENT))
45 #define G_SOCKET_CLIENT_GET_CLASS(inst)                     (G_TYPE_INSTANCE_GET_CLASS ((inst),                      \
46                                                              G_TYPE_SOCKET_CLIENT, GSocketClientClass))
47
48 typedef struct _GSocketClientPrivate                        GSocketClientPrivate;
49 typedef struct _GSocketClientClass                          GSocketClientClass;
50
51 struct _GSocketClientClass
52 {
53   GObjectClass parent_class;
54
55   /* Padding for future expansion */
56   void (*_g_reserved1) (void);
57   void (*_g_reserved2) (void);
58   void (*_g_reserved3) (void);
59   void (*_g_reserved4) (void);
60   void (*_g_reserved5) (void);
61 };
62
63 struct _GSocketClient
64 {
65   GObject parent_instance;
66   GSocketClientPrivate *priv;
67 };
68
69 GType                   g_socket_client_get_type                        (void) G_GNUC_CONST;
70
71 GSocketClient          *g_socket_client_new                             (void);
72
73 GSocketFamily           g_socket_client_get_family                      (GSocketClient        *client);
74 void                    g_socket_client_set_family                      (GSocketClient        *client,
75                                                                          GSocketFamily         family);
76 GSocketType             g_socket_client_get_socket_type                 (GSocketClient        *client);
77 void                    g_socket_client_set_socket_type                 (GSocketClient        *client,
78                                                                          GSocketType           type);
79 const char             *g_socket_client_get_protocol                    (GSocketClient        *client);
80 void                    g_socket_client_set_protocol                    (GSocketClient        *client,
81                                                                          const char           *protocol);
82 GSocketAddress         *g_socket_client_get_local_address               (GSocketClient        *client);
83 void                    g_socket_client_set_local_address               (GSocketClient        *client,
84                                                                          GSocketAddress       *address);
85
86 GSocketConnection *     g_socket_client_connect                         (GSocketClient        *client,
87                                                                          GSocketConnectable   *connectable,
88                                                                          GCancellable         *cancellable,
89                                                                          GError              **error);
90 GSocketConnection *     g_socket_client_connect_to_host                 (GSocketClient        *client,
91                                                                          const char           *hostname,
92                                                                          int                   port,
93                                                                          GCancellable         *cancellable,
94                                                                          GError              **error);
95 void                    g_socket_client_connect_async                   (GSocketClient        *client,
96                                                                          GSocketConnectable   *connectable,
97                                                                          GCancellable         *cancellable,
98                                                                          GAsyncReadyCallback   callback,
99                                                                          gpointer              user_data);
100 GSocketConnection *     g_socket_client_connect_finish                  (GSocketClient        *client,
101                                                                          GAsyncResult         *result,
102                                                                          GError              **error);
103 void                    g_socket_client_connect_to_host_async           (GSocketClient        *client,
104                                                                          const char           *hostname,
105                                                                          int                   port,
106                                                                          GCancellable         *cancellable,
107                                                                          GAsyncReadyCallback   callback,
108                                                                          gpointer              user_data);
109 GSocketConnection *     g_socket_client_connect_to_host_finish          (GSocketClient        *client,
110                                                                          GAsyncResult         *result,
111                                                                          GError              **error);
112
113 G_END_DECLS
114
115 #endif /* __G_SOCKET_CLIENT_H___ */