1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>GProxyAddress</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
<link rel="home" href="index.html" title="GIO Reference Manual">
8
<link rel="up" href="networking.html" title="Lowlevel network support">
9
<link rel="prev" href="GProxy.html" title="GProxy">
10
<link rel="next" href="highlevel-socket.html" title="Highlevel network functionallity">
11
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17
<td><a accesskey="p" href="GProxy.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
<td><a accesskey="u" href="networking.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
<th width="100%" align="center">GIO Reference Manual</th>
21
<td><a accesskey="n" href="highlevel-socket.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23
<tr><td colspan="5" class="shortcuts">
24
<a href="#GProxyAddress.synopsis" class="shortcut">Top</a>
26
<a href="#GProxyAddress.description" class="shortcut">Description</a>
28
<a href="#GProxyAddress.object-hierarchy" class="shortcut">Object Hierarchy</a>
30
<a href="#GProxyAddress.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
32
<a href="#GProxyAddress.properties" class="shortcut">Properties</a>
35
<div class="refentry" title="GProxyAddress">
36
<a name="GProxyAddress"></a><div class="titlepage"></div>
37
<div class="refnamediv"><table width="100%"><tr>
39
<h2><span class="refentrytitle"><a name="GProxyAddress.top_of_page"></a>GProxyAddress</span></h2>
40
<p>GProxyAddress — An internet address with proxy information</p>
42
<td valign="top" align="right"></td>
44
<div class="refsynopsisdiv" title="Synopsis">
45
<a name="GProxyAddress.synopsis"></a><h2>Synopsis</h2>
46
<pre class="synopsis"> <a class="link" href="GProxyAddress.html#GProxyAddress-struct" title="GProxyAddress">GProxyAddress</a>;
47
<a class="link" href="GProxyAddress.html#GProxyAddressClass" title="GProxyAddressClass">GProxyAddressClass</a>;
48
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GProxyAddress.html#g-proxy-address-get-destination-hostname" title="g_proxy_address_get_destination_hostname ()">g_proxy_address_get_destination_hostname</a>
49
(<em class="parameter"><code><a class="link" href="GProxyAddress.html" title="GProxyAddress"><span class="type">GProxyAddress</span></a> *proxy</code></em>);
50
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint16"><span class="returnvalue">guint16</span></a> <a class="link" href="GProxyAddress.html#g-proxy-address-get-destination-port" title="g_proxy_address_get_destination_port ()">g_proxy_address_get_destination_port</a>
51
(<em class="parameter"><code><a class="link" href="GProxyAddress.html" title="GProxyAddress"><span class="type">GProxyAddress</span></a> *proxy</code></em>);
52
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GProxyAddress.html#g-proxy-address-get-password" title="g_proxy_address_get_password ()">g_proxy_address_get_password</a> (<em class="parameter"><code><a class="link" href="GProxyAddress.html" title="GProxyAddress"><span class="type">GProxyAddress</span></a> *proxy</code></em>);
53
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GProxyAddress.html#g-proxy-address-get-protocol" title="g_proxy_address_get_protocol ()">g_proxy_address_get_protocol</a> (<em class="parameter"><code><a class="link" href="GProxyAddress.html" title="GProxyAddress"><span class="type">GProxyAddress</span></a> *proxy</code></em>);
54
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GProxyAddress.html#g-proxy-address-get-username" title="g_proxy_address_get_username ()">g_proxy_address_get_username</a> (<em class="parameter"><code><a class="link" href="GProxyAddress.html" title="GProxyAddress"><span class="type">GProxyAddress</span></a> *proxy</code></em>);
55
<a class="link" href="GSocketAddress.html" title="GSocketAddress"><span class="returnvalue">GSocketAddress</span></a> * <a class="link" href="GProxyAddress.html#g-proxy-address-new" title="g_proxy_address_new ()">g_proxy_address_new</a> (<em class="parameter"><code><a class="link" href="GInetAddress.html" title="GInetAddress"><span class="type">GInetAddress</span></a> *inetaddr</code></em>,
56
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint16"><span class="type">guint16</span></a> port</code></em>,
57
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *protocol</code></em>,
58
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dest_hostname</code></em>,
59
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint16"><span class="type">guint16</span></a> dest_port</code></em>,
60
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *username</code></em>,
61
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *password</code></em>);
64
<div class="refsect1" title="Object Hierarchy">
65
<a name="GProxyAddress.object-hierarchy"></a><h2>Object Hierarchy</h2>
66
<pre class="synopsis">
67
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
68
+----<a class="link" href="GSocketAddress.html" title="GSocketAddress">GSocketAddress</a>
69
+----<a class="link" href="GInetSocketAddress.html" title="GInetSocketAddress">GInetSocketAddress</a>
73
<div class="refsect1" title="Implemented Interfaces">
74
<a name="GProxyAddress.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
76
GProxyAddress implements
77
<a class="link" href="GSocketConnectable.html" title="GSocketConnectable">GSocketConnectable</a>.</p>
79
<div class="refsect1" title="Properties">
80
<a name="GProxyAddress.properties"></a><h2>Properties</h2>
81
<pre class="synopsis">
82
"<a class="link" href="GProxyAddress.html#GProxyAddress--destination-hostname" title='The "destination-hostname" property'>destination-hostname</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only
83
"<a class="link" href="GProxyAddress.html#GProxyAddress--destination-port" title='The "destination-port" property'>destination-port</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct Only
84
"<a class="link" href="GProxyAddress.html#GProxyAddress--password" title='The "password" property'>password</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only
85
"<a class="link" href="GProxyAddress.html#GProxyAddress--protocol" title='The "protocol" property'>protocol</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only
86
"<a class="link" href="GProxyAddress.html#GProxyAddress--username" title='The "username" property'>username</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only
89
<div class="refsect1" title="Description">
90
<a name="GProxyAddress.description"></a><h2>Description</h2>
92
Support for proxied <a class="link" href="GInetSocketAddress.html" title="GInetSocketAddress"><span class="type">GInetSocketAddress</span></a>.
95
<div class="refsect1" title="Details">
96
<a name="GProxyAddress.details"></a><h2>Details</h2>
97
<div class="refsect2" title="GProxyAddress">
98
<a name="GProxyAddress-struct"></a><h3>GProxyAddress</h3>
99
<pre class="programlisting">typedef struct _GProxyAddress GProxyAddress;</pre>
101
A <a class="link" href="GInetSocketAddress.html" title="GInetSocketAddress"><span class="type">GInetSocketAddress</span></a> representing a connection via a proxy server
103
<p class="since">Since 2.26</p>
106
<div class="refsect2" title="GProxyAddressClass">
107
<a name="GProxyAddressClass"></a><h3>GProxyAddressClass</h3>
108
<pre class="programlisting">typedef struct {
109
GInetSocketAddressClass parent_class;
110
} GProxyAddressClass;
116
<div class="refsect2" title="g_proxy_address_get_destination_hostname ()">
117
<a name="g-proxy-address-get-destination-hostname"></a><h3>g_proxy_address_get_destination_hostname ()</h3>
118
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * g_proxy_address_get_destination_hostname
119
(<em class="parameter"><code><a class="link" href="GProxyAddress.html" title="GProxyAddress"><span class="type">GProxyAddress</span></a> *proxy</code></em>);</pre>
121
Gets <em class="parameter"><code>proxy</code></em>'s destination hostname.
123
<div class="variablelist"><table border="0">
124
<col align="left" valign="top">
127
<td><p><span class="term"><em class="parameter"><code>proxy</code></em> :</span></p></td>
128
<td>a <a class="link" href="GProxyAddress.html" title="GProxyAddress"><span class="type">GProxyAddress</span></a>
132
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
133
<td> the <em class="parameter"><code>proxy</code></em>'s destination hostname
139
<p class="since">Since 2.26</p>
142
<div class="refsect2" title="g_proxy_address_get_destination_port ()">
143
<a name="g-proxy-address-get-destination-port"></a><h3>g_proxy_address_get_destination_port ()</h3>
144
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint16"><span class="returnvalue">guint16</span></a> g_proxy_address_get_destination_port
145
(<em class="parameter"><code><a class="link" href="GProxyAddress.html" title="GProxyAddress"><span class="type">GProxyAddress</span></a> *proxy</code></em>);</pre>
147
Gets <em class="parameter"><code>proxy</code></em>'s destination port.
149
<div class="variablelist"><table border="0">
150
<col align="left" valign="top">
153
<td><p><span class="term"><em class="parameter"><code>proxy</code></em> :</span></p></td>
154
<td>a <a class="link" href="GProxyAddress.html" title="GProxyAddress"><span class="type">GProxyAddress</span></a>
158
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
159
<td> the <em class="parameter"><code>proxy</code></em>'s destination port
165
<p class="since">Since 2.26</p>
168
<div class="refsect2" title="g_proxy_address_get_password ()">
169
<a name="g-proxy-address-get-password"></a><h3>g_proxy_address_get_password ()</h3>
170
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * g_proxy_address_get_password (<em class="parameter"><code><a class="link" href="GProxyAddress.html" title="GProxyAddress"><span class="type">GProxyAddress</span></a> *proxy</code></em>);</pre>
172
Gets <em class="parameter"><code>proxy</code></em>'s password.
174
<div class="variablelist"><table border="0">
175
<col align="left" valign="top">
178
<td><p><span class="term"><em class="parameter"><code>proxy</code></em> :</span></p></td>
179
<td>a <a class="link" href="GProxyAddress.html" title="GProxyAddress"><span class="type">GProxyAddress</span></a>
183
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
184
<td> the <em class="parameter"><code>proxy</code></em>'s password
190
<p class="since">Since 2.26</p>
193
<div class="refsect2" title="g_proxy_address_get_protocol ()">
194
<a name="g-proxy-address-get-protocol"></a><h3>g_proxy_address_get_protocol ()</h3>
195
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * g_proxy_address_get_protocol (<em class="parameter"><code><a class="link" href="GProxyAddress.html" title="GProxyAddress"><span class="type">GProxyAddress</span></a> *proxy</code></em>);</pre>
197
Gets <em class="parameter"><code>proxy</code></em>'s protocol.
199
<div class="variablelist"><table border="0">
200
<col align="left" valign="top">
203
<td><p><span class="term"><em class="parameter"><code>proxy</code></em> :</span></p></td>
204
<td>a <a class="link" href="GProxyAddress.html" title="GProxyAddress"><span class="type">GProxyAddress</span></a>
208
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
209
<td> the <em class="parameter"><code>proxy</code></em>'s protocol
215
<p class="since">Since 2.26</p>
218
<div class="refsect2" title="g_proxy_address_get_username ()">
219
<a name="g-proxy-address-get-username"></a><h3>g_proxy_address_get_username ()</h3>
220
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * g_proxy_address_get_username (<em class="parameter"><code><a class="link" href="GProxyAddress.html" title="GProxyAddress"><span class="type">GProxyAddress</span></a> *proxy</code></em>);</pre>
222
Gets <em class="parameter"><code>proxy</code></em>'s username.
224
<div class="variablelist"><table border="0">
225
<col align="left" valign="top">
228
<td><p><span class="term"><em class="parameter"><code>proxy</code></em> :</span></p></td>
229
<td>a <a class="link" href="GProxyAddress.html" title="GProxyAddress"><span class="type">GProxyAddress</span></a>
233
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
234
<td> the <em class="parameter"><code>proxy</code></em>'s username
240
<p class="since">Since 2.26</p>
243
<div class="refsect2" title="g_proxy_address_new ()">
244
<a name="g-proxy-address-new"></a><h3>g_proxy_address_new ()</h3>
245
<pre class="programlisting"><a class="link" href="GSocketAddress.html" title="GSocketAddress"><span class="returnvalue">GSocketAddress</span></a> * g_proxy_address_new (<em class="parameter"><code><a class="link" href="GInetAddress.html" title="GInetAddress"><span class="type">GInetAddress</span></a> *inetaddr</code></em>,
246
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint16"><span class="type">guint16</span></a> port</code></em>,
247
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *protocol</code></em>,
248
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dest_hostname</code></em>,
249
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint16"><span class="type">guint16</span></a> dest_port</code></em>,
250
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *username</code></em>,
251
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *password</code></em>);</pre>
253
Creates a new <a class="link" href="GProxyAddress.html" title="GProxyAddress"><span class="type">GProxyAddress</span></a> for <em class="parameter"><code>inetaddr</code></em> with <em class="parameter"><code>protocol</code></em> that should
254
tunnel through <em class="parameter"><code>dest_hostname</code></em> and <em class="parameter"><code>dest_port</code></em>.
256
<div class="variablelist"><table border="0">
257
<col align="left" valign="top">
260
<td><p><span class="term"><em class="parameter"><code>inetaddr</code></em> :</span></p></td>
261
<td>The proxy server <a class="link" href="GInetAddress.html" title="GInetAddress"><span class="type">GInetAddress</span></a>.
265
<td><p><span class="term"><em class="parameter"><code>port</code></em> :</span></p></td>
266
<td>The proxy server port.
270
<td><p><span class="term"><em class="parameter"><code>protocol</code></em> :</span></p></td>
271
<td>The proxy protocol to support, in lower case (e.g. socks, http).
275
<td><p><span class="term"><em class="parameter"><code>dest_hostname</code></em> :</span></p></td>
276
<td>The destination hostname the the proxy should tunnel to.
280
<td><p><span class="term"><em class="parameter"><code>dest_port</code></em> :</span></p></td>
281
<td>The destination port to tunnel to.
285
<td><p><span class="term"><em class="parameter"><code>username</code></em> :</span></p></td>
286
<td>The username to authenticate to the proxy server (or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>).
290
<td><p><span class="term"><em class="parameter"><code>password</code></em> :</span></p></td>
291
<td>The password to authenticate to the proxy server (or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>).
295
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
296
<td> a new <a class="link" href="GProxyAddress.html" title="GProxyAddress"><span class="type">GProxyAddress</span></a>
302
<p class="since">Since 2.26</p>
305
<div class="refsect1" title="Property Details">
306
<a name="GProxyAddress.property-details"></a><h2>Property Details</h2>
307
<div class="refsect2" title='The "destination-hostname" property'>
308
<a name="GProxyAddress--destination-hostname"></a><h3>The <code class="literal">"destination-hostname"</code> property</h3>
309
<pre class="programlisting"> "destination-hostname" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only</pre>
310
<p>The proxy destination hostname.</p>
311
<p>Default value: NULL</p>
314
<div class="refsect2" title='The "destination-port" property'>
315
<a name="GProxyAddress--destination-port"></a><h3>The <code class="literal">"destination-port"</code> property</h3>
316
<pre class="programlisting"> "destination-port" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct Only</pre>
317
<p>The proxy destination port.</p>
318
<p>Allowed values: <= 65535</p>
319
<p>Default value: 0</p>
322
<div class="refsect2" title='The "password" property'>
323
<a name="GProxyAddress--password"></a><h3>The <code class="literal">"password"</code> property</h3>
324
<pre class="programlisting"> "password" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only</pre>
325
<p>The proxy password.</p>
326
<p>Default value: NULL</p>
329
<div class="refsect2" title='The "protocol" property'>
330
<a name="GProxyAddress--protocol"></a><h3>The <code class="literal">"protocol"</code> property</h3>
331
<pre class="programlisting"> "protocol" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only</pre>
332
<p>The proxy protocol.</p>
333
<p>Default value: NULL</p>
336
<div class="refsect2" title='The "username" property'>
337
<a name="GProxyAddress--username"></a><h3>The <code class="literal">"username"</code> property</h3>
338
<pre class="programlisting"> "username" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only</pre>
339
<p>The proxy username.</p>
340
<p>Default value: NULL</p>
346
Generated by GTK-Doc V1.15</div>
b'\\ No newline at end of file'