Merge branch '896-variant-type-docs' into 'master'
[glib.git] / gio / gproxyaddress.h
blob21b1992ea77510f634bb1c8042d70db639752abf
1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2010 Collabora, Ltd.
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.1 of the License, or (at your option) any later version.
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.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
18 * Authors: Nicolas Dufresne <nicolas.dufresne@collabora.co.uk>
21 #ifndef __G_PROXY_ADDRESS_H__
22 #define __G_PROXY_ADDRESS_H__
24 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
25 #error "Only <gio/gio.h> can be included directly."
26 #endif
28 #include <gio/ginetsocketaddress.h>
30 G_BEGIN_DECLS
32 #define G_TYPE_PROXY_ADDRESS (g_proxy_address_get_type ())
33 #define G_PROXY_ADDRESS(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_PROXY_ADDRESS, GProxyAddress))
34 #define G_PROXY_ADDRESS_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_PROXY_ADDRESS, GProxyAddressClass))
35 #define G_IS_PROXY_ADDRESS(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_PROXY_ADDRESS))
36 #define G_IS_PROXY_ADDRESS_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_PROXY_ADDRESS))
37 #define G_PROXY_ADDRESS_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_PROXY_ADDRESS, GProxyAddressClass))
39 typedef struct _GProxyAddressClass GProxyAddressClass;
40 typedef struct _GProxyAddressPrivate GProxyAddressPrivate;
42 struct _GProxyAddress
44 GInetSocketAddress parent_instance;
46 /*< private >*/
47 GProxyAddressPrivate *priv;
50 struct _GProxyAddressClass
52 GInetSocketAddressClass parent_class;
56 GLIB_AVAILABLE_IN_ALL
57 GType g_proxy_address_get_type (void) G_GNUC_CONST;
59 GLIB_AVAILABLE_IN_ALL
60 GSocketAddress *g_proxy_address_new (GInetAddress *inetaddr,
61 guint16 port,
62 const gchar *protocol,
63 const gchar *dest_hostname,
64 guint16 dest_port,
65 const gchar *username,
66 const gchar *password);
68 GLIB_AVAILABLE_IN_ALL
69 const gchar *g_proxy_address_get_protocol (GProxyAddress *proxy);
70 GLIB_AVAILABLE_IN_2_34
71 const gchar *g_proxy_address_get_destination_protocol (GProxyAddress *proxy);
72 GLIB_AVAILABLE_IN_ALL
73 const gchar *g_proxy_address_get_destination_hostname (GProxyAddress *proxy);
74 GLIB_AVAILABLE_IN_ALL
75 guint16 g_proxy_address_get_destination_port (GProxyAddress *proxy);
76 GLIB_AVAILABLE_IN_ALL
77 const gchar *g_proxy_address_get_username (GProxyAddress *proxy);
78 GLIB_AVAILABLE_IN_ALL
79 const gchar *g_proxy_address_get_password (GProxyAddress *proxy);
81 GLIB_AVAILABLE_IN_2_34
82 const gchar *g_proxy_address_get_uri (GProxyAddress *proxy);
84 G_END_DECLS
86 #endif /* __G_PROXY_ADDRESS_H__ */