docs/reference/gio/html/GProxyAddress.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   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.76.1">
   7 <link rel="home" href="index.html" title="GIO Reference Manual">
   8 <link rel="up" href="networking.html" title="Low-level network support">
   9 <link rel="prev" href="GProxy.html" title="GProxy">
  10 <link rel="next" href="highlevel-socket.html" title="High-level network functionallity">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  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">
  16 <tr valign="middle">
  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>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#GProxyAddress.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GProxyAddress.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GProxyAddress.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#GProxyAddress.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#GProxyAddress.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="GProxyAddress"></a><div class="titlepage"></div>
  37 <div class="refnamediv"><table width="100%"><tr>
  38 <td valign="top">
  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>
  41 </td>
  42 <td valign="top" align="right"></td>
  43 </tr></table></div>
  44 <div class="refsynopsisdiv">
  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 struct              <a class="link" href="GProxyAddress.html#GProxyAddressClass" title="struct GProxyAddressClass">GProxyAddressClass</a>;
  48 const <a href="./../glib/glib/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="./../glib/glib/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="./../glib/glib/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="./../glib/glib/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="./../glib/glib/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="./../glib/glib/glib-Basic-Types.html#guint16"><span class="type">guint16</span></a> port</code></em>,
  57                                                          <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *protocol</code></em>,
  58                                                          <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dest_hostname</code></em>,
  59                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#guint16"><span class="type">guint16</span></a> dest_port</code></em>,
  60                                                          <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *username</code></em>,
  61                                                          <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *password</code></em>);
  62 </pre>
  63 </div>
  64 <div class="refsect1">
  65 <a name="GProxyAddress.object-hierarchy"></a><h2>Object Hierarchy</h2>
  66 <pre class="synopsis">
  67   <a href="./../gobject/gobject/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>
  70                +----GProxyAddress
  71 </pre>
  72 </div>
  73 <div class="refsect1">
  74 <a name="GProxyAddress.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  75 <p>
  76 GProxyAddress implements
  77  <a class="link" href="GSocketConnectable.html" title="GSocketConnectable">GSocketConnectable</a>.</p>
  78 </div>
  79 <div class="refsect1">
  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="./../glib/glib/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="./../glib/glib/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="./../glib/glib/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="./../glib/glib/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="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
  87 </pre>
  88 </div>
  89 <div class="refsect1">
  90 <a name="GProxyAddress.description"></a><h2>Description</h2>
  91 <p>
  92 Support for proxied <a class="link" href="GInetSocketAddress.html" title="GInetSocketAddress"><span class="type">GInetSocketAddress</span></a>.
  93 </p>
  94 </div>
  95 <div class="refsect1">
  96 <a name="GProxyAddress.details"></a><h2>Details</h2>
  97 <div class="refsect2">
  98 <a name="GProxyAddress-struct"></a><h3>GProxyAddress</h3>
  99 <pre class="programlisting">typedef struct _GProxyAddress GProxyAddress;</pre>
 100 <p>
 101 A <a class="link" href="GInetSocketAddress.html" title="GInetSocketAddress"><span class="type">GInetSocketAddress</span></a> representing a connection via a proxy server
 102 </p>
 103 <p class="since">Since 2.26</p>
 104 </div>
 105 <hr>
 106 <div class="refsect2">
 107 <a name="GProxyAddressClass"></a><h3>struct GProxyAddressClass</h3>
 108 <pre class="programlisting">struct GProxyAddressClass {
 109   GInetSocketAddressClass parent_class;
 110 };
 111 </pre>
 112 </div>
 113 <hr>
 114 <div class="refsect2">
 115 <a name="g-proxy-address-get-destination-hostname"></a><h3>g_proxy_address_get_destination_hostname ()</h3>
 116 <pre class="programlisting">const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       g_proxy_address_get_destination_hostname
 117                                                         (<em class="parameter"><code><a class="link" href="GProxyAddress.html" title="GProxyAddress"><span class="type">GProxyAddress</span></a> *proxy</code></em>);</pre>
 118 <p>
 119 Gets <em class="parameter"><code>proxy</code></em>'s destination hostname.
 120 </p>
 121 <div class="variablelist"><table border="0">
 122 <col align="left" valign="top">
 123 <tbody>
 124 <tr>
 125 <td><p><span class="term"><em class="parameter"><code>proxy</code></em> :</span></p></td>
 126 <td>a <a class="link" href="GProxyAddress.html" title="GProxyAddress"><span class="type">GProxyAddress</span></a>
 127 </td>
 128 </tr>
 129 <tr>
 130 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 131 <td>the <em class="parameter"><code>proxy</code></em>'s destination hostname</td>
 132 </tr>
 133 </tbody>
 134 </table></div>
 135 <p class="since">Since 2.26</p>
 136 </div>
 137 <hr>
 138 <div class="refsect2">
 139 <a name="g-proxy-address-get-destination-port"></a><h3>g_proxy_address_get_destination_port ()</h3>
 140 <pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#guint16"><span class="returnvalue">guint16</span></a>             g_proxy_address_get_destination_port
 141                                                         (<em class="parameter"><code><a class="link" href="GProxyAddress.html" title="GProxyAddress"><span class="type">GProxyAddress</span></a> *proxy</code></em>);</pre>
 142 <p>
 143 Gets <em class="parameter"><code>proxy</code></em>'s destination port.
 144 </p>
 145 <div class="variablelist"><table border="0">
 146 <col align="left" valign="top">
 147 <tbody>
 148 <tr>
 149 <td><p><span class="term"><em class="parameter"><code>proxy</code></em> :</span></p></td>
 150 <td>a <a class="link" href="GProxyAddress.html" title="GProxyAddress"><span class="type">GProxyAddress</span></a>
 151 </td>
 152 </tr>
 153 <tr>
 154 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 155 <td>the <em class="parameter"><code>proxy</code></em>'s destination port</td>
 156 </tr>
 157 </tbody>
 158 </table></div>
 159 <p class="since">Since 2.26</p>
 160 </div>
 161 <hr>
 162 <div class="refsect2">
 163 <a name="g-proxy-address-get-password"></a><h3>g_proxy_address_get_password ()</h3>
 164 <pre class="programlisting">const <a href="./../glib/glib/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>
 165 <p>
 166 Gets <em class="parameter"><code>proxy</code></em>'s password.
 167 </p>
 168 <div class="variablelist"><table border="0">
 169 <col align="left" valign="top">
 170 <tbody>
 171 <tr>
 172 <td><p><span class="term"><em class="parameter"><code>proxy</code></em> :</span></p></td>
 173 <td>a <a class="link" href="GProxyAddress.html" title="GProxyAddress"><span class="type">GProxyAddress</span></a>
 174 </td>
 175 </tr>
 176 <tr>
 177 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 178 <td>the <em class="parameter"><code>proxy</code></em>'s password</td>
 179 </tr>
 180 </tbody>
 181 </table></div>
 182 <p class="since">Since 2.26</p>
 183 </div>
 184 <hr>
 185 <div class="refsect2">
 186 <a name="g-proxy-address-get-protocol"></a><h3>g_proxy_address_get_protocol ()</h3>
 187 <pre class="programlisting">const <a href="./../glib/glib/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>
 188 <p>
 189 Gets <em class="parameter"><code>proxy</code></em>'s protocol.
 190 </p>
 191 <div class="variablelist"><table border="0">
 192 <col align="left" valign="top">
 193 <tbody>
 194 <tr>
 195 <td><p><span class="term"><em class="parameter"><code>proxy</code></em> :</span></p></td>
 196 <td>a <a class="link" href="GProxyAddress.html" title="GProxyAddress"><span class="type">GProxyAddress</span></a>
 197 </td>
 198 </tr>
 199 <tr>
 200 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 201 <td>the <em class="parameter"><code>proxy</code></em>'s protocol</td>
 202 </tr>
 203 </tbody>
 204 </table></div>
 205 <p class="since">Since 2.26</p>
 206 </div>
 207 <hr>
 208 <div class="refsect2">
 209 <a name="g-proxy-address-get-username"></a><h3>g_proxy_address_get_username ()</h3>
 210 <pre class="programlisting">const <a href="./../glib/glib/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>
 211 <p>
 212 Gets <em class="parameter"><code>proxy</code></em>'s username.
 213 </p>
 214 <div class="variablelist"><table border="0">
 215 <col align="left" valign="top">
 216 <tbody>
 217 <tr>
 218 <td><p><span class="term"><em class="parameter"><code>proxy</code></em> :</span></p></td>
 219 <td>a <a class="link" href="GProxyAddress.html" title="GProxyAddress"><span class="type">GProxyAddress</span></a>
 220 </td>
 221 </tr>
 222 <tr>
 223 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 224 <td>the <em class="parameter"><code>proxy</code></em>'s username</td>
 225 </tr>
 226 </tbody>
 227 </table></div>
 228 <p class="since">Since 2.26</p>
 229 </div>
 230 <hr>
 231 <div class="refsect2">
 232 <a name="g-proxy-address-new"></a><h3>g_proxy_address_new ()</h3>
 233 <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>,
 234                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#guint16"><span class="type">guint16</span></a> port</code></em>,
 235                                                          <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *protocol</code></em>,
 236                                                          <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dest_hostname</code></em>,
 237                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#guint16"><span class="type">guint16</span></a> dest_port</code></em>,
 238                                                          <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *username</code></em>,
 239                                                          <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *password</code></em>);</pre>
 240 <p>
 241 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
 242 tunnel through <em class="parameter"><code>dest_hostname</code></em> and <em class="parameter"><code>dest_port</code></em>.
 243 </p>
 244 <div class="variablelist"><table border="0">
 245 <col align="left" valign="top">
 246 <tbody>
 247 <tr>
 248 <td><p><span class="term"><em class="parameter"><code>inetaddr</code></em> :</span></p></td>
 249 <td>The proxy server <a class="link" href="GInetAddress.html" title="GInetAddress"><span class="type">GInetAddress</span></a>.</td>
 250 </tr>
 251 <tr>
 252 <td><p><span class="term"><em class="parameter"><code>port</code></em> :</span></p></td>
 253 <td>The proxy server port.</td>
 254 </tr>
 255 <tr>
 256 <td><p><span class="term"><em class="parameter"><code>protocol</code></em> :</span></p></td>
 257 <td>The proxy protocol to support, in lower case (e.g. socks, http).</td>
 258 </tr>
 259 <tr>
 260 <td><p><span class="term"><em class="parameter"><code>dest_hostname</code></em> :</span></p></td>
 261 <td>The destination hostname the the proxy should tunnel to.</td>
 262 </tr>
 263 <tr>
 264 <td><p><span class="term"><em class="parameter"><code>dest_port</code></em> :</span></p></td>
 265 <td>The destination port to tunnel to.</td>
 266 </tr>
 267 <tr>
 268 <td><p><span class="term"><em class="parameter"><code>username</code></em> :</span></p></td>
 269 <td>The username to authenticate to the proxy server
 270 (or <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>). <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 271 </td>
 272 </tr>
 273 <tr>
 274 <td><p><span class="term"><em class="parameter"><code>password</code></em> :</span></p></td>
 275 <td>The password to authenticate to the proxy server
 276 (or <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>). <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 277 </td>
 278 </tr>
 279 <tr>
 280 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 281 <td>a new <a class="link" href="GProxyAddress.html" title="GProxyAddress"><span class="type">GProxyAddress</span></a>
 282 </td>
 283 </tr>
 284 </tbody>
 285 </table></div>
 286 <p class="since">Since 2.26</p>
 287 </div>
 288 </div>
 289 <div class="refsect1">
 290 <a name="GProxyAddress.property-details"></a><h2>Property Details</h2>
 291 <div class="refsect2">
 292 <a name="GProxyAddress--destination-hostname"></a><h3>The <code class="literal">"destination-hostname"</code> property</h3>
 293 <pre class="programlisting">  "destination-hostname"     <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
 294 <p>The proxy destination hostname.</p>
 295 <p>Default value: NULL</p>
 296 </div>
 297 <hr>
 298 <div class="refsect2">
 299 <a name="GProxyAddress--destination-port"></a><h3>The <code class="literal">"destination-port"</code> property</h3>
 300 <pre class="programlisting">  "destination-port"         <a href="./../glib/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct Only</pre>
 301 <p>The proxy destination port.</p>
 302 <p>Allowed values: &lt;= 65535</p>
 303 <p>Default value: 0</p>
 304 </div>
 305 <hr>
 306 <div class="refsect2">
 307 <a name="GProxyAddress--password"></a><h3>The <code class="literal">"password"</code> property</h3>
 308 <pre class="programlisting">  "password"                 <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
 309 <p>The proxy password.</p>
 310 <p>Default value: NULL</p>
 311 </div>
 312 <hr>
 313 <div class="refsect2">
 314 <a name="GProxyAddress--protocol"></a><h3>The <code class="literal">"protocol"</code> property</h3>
 315 <pre class="programlisting">  "protocol"                 <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
 316 <p>The proxy protocol.</p>
 317 <p>Default value: NULL</p>
 318 </div>
 319 <hr>
 320 <div class="refsect2">
 321 <a name="GProxyAddress--username"></a><h3>The <code class="literal">"username"</code> property</h3>
 322 <pre class="programlisting">  "username"                 <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
 323 <p>The proxy username.</p>
 324 <p>Default value: NULL</p>
 325 </div>
 326 </div>
 327 </div>
 328 <div class="footer">
 329 <hr>
 330           Generated by GTK-Doc V1.18</div>
 331 </body>
 332 </html>