Merge remote branch 'gvdb/master'
[platform/upstream/glib.git] / gio / gproxy.h
1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2
3 /* GIO - GLib Input, Output and Streaming Library
4  *
5  * Copyright (C) 2010 Collabora Ltd.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General
18  * Public License along with this library; if not, write to the
19  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
20  * Boston, MA 02111-1307, USA.
21  *
22  * Author: Nicolas Dufresne <nicolas.dufresne@collabora.co.uk>
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_PROXY_H__
30 #define __G_PROXY_H__
31
32 #include <gio/giotypes.h>
33
34 G_BEGIN_DECLS
35
36 #define G_TYPE_PROXY            (g_proxy_get_type ())
37 #define G_PROXY(o)              (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_PROXY, GProxy))
38 #define G_IS_PROXY(o)           (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_PROXY))
39 #define G_PROXY_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_PROXY, GProxyInterface))
40
41 /**
42  * G_PROXY_EXTENSION_POINT_NAME:
43  *
44  * Extension point for proxy functionality.
45  * See <link linkend="extending-gio">Extending GIO</link>.
46  *
47  * Since: 2.26
48  */
49 #define G_PROXY_EXTENSION_POINT_NAME "gio-proxy"
50
51 /**
52  * GProxy:
53  *
54  * Interface that handles proxy connection and payload.
55  *
56  * Since: 2.26
57  */
58 typedef struct _GProxyInterface GProxyInterface;
59
60 /**
61  * GProxyInterface:
62  * @g_iface: The parent interface.
63  * @connect: Connect to proxy server and wrap (if required) the #connection
64  *           to handle payload.
65  * @connect_async: Same has connect() but asynchronous.
66  * @connect_finish: Returns the result of connect_async()
67  *
68  * Provides an interface for handling proxy connection and payload.
69  *
70  * Since: 2.26
71  */
72 struct _GProxyInterface
73 {
74   GTypeInterface g_iface;
75
76   /* Virtual Table */
77
78   GIOStream * (* connect)           (GProxy               *proxy,
79                                      GIOStream            *connection,
80                                      GProxyAddress        *proxy_address,
81                                      GCancellable         *cancellable,
82                                      GError              **error);
83
84   void        (* connect_async)     (GProxy               *proxy,
85                                      GIOStream            *connection,
86                                      GProxyAddress        *proxy_address,
87                                      GCancellable         *cancellable,
88                                      GAsyncReadyCallback   callback,
89                                      gpointer              user_data);
90
91   GIOStream * (* connect_finish)    (GProxy               *proxy,
92                                      GAsyncResult         *result,
93                                      GError              **error);
94
95   gboolean    (* supports_hostname) (GProxy             *proxy);
96 };
97
98 GType      g_proxy_get_type                 (void) G_GNUC_CONST;
99
100 GProxy    *g_proxy_get_default_for_protocol (const gchar *protocol);
101
102 GIOStream *g_proxy_connect           (GProxy               *proxy,
103                                       GIOStream            *connection,
104                                       GProxyAddress        *proxy_address,
105                                       GCancellable         *cancellable,
106                                       GError              **error);
107
108 void       g_proxy_connect_async     (GProxy               *proxy,
109                                       GIOStream            *connection,
110                                       GProxyAddress        *proxy_address,
111                                       GCancellable         *cancellable,
112                                       GAsyncReadyCallback   callback,
113                                       gpointer              user_data);
114
115 GIOStream *g_proxy_connect_finish    (GProxy               *proxy,
116                                       GAsyncResult         *result,
117                                       GError              **error);
118
119 gboolean   g_proxy_supports_hostname (GProxy               *proxy);
120
121 G_END_DECLS
122
123 #endif /* __G_PROXY_H__ */