docs/reference/tmpl/lm-proxy.sgml
author Dafydd Harries <daf@rhydd.org>
Tue, 23 Oct 2007 16:23:05 +0100
changeset 287 fb0f9a524963
parent 140 103227122f45
permissions -rw-r--r--
commit doc change side-effects

<!-- ##### SECTION Title ##### -->
LmProxy

<!-- ##### SECTION Short_Description ##### -->
API for the proxy support in Loudmouth

<!-- ##### SECTION Long_Description ##### -->
<para>
Use this together with an #LmConnection to get the connection to use connect through a proxy. Example of how to use the #LmProxy API.
<informalexample><programlisting><![CDATA[
LmConnection *connection;
LmProxy      *proxy;

connection = lm_connection_new ("myserver");
proxy = lm_proxy_new_with_server (LM_PROXY_TYPE_HTTP,
				  "myproxyserver",
				  8080);
lm_connection_set_proxy (connection, proxy);
...]]></programlisting></informalexample>
</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### STRUCT LmProxy ##### -->
<para>
This should not be accessed directly. Use the accessor functions as described below.
</para>


<!-- ##### ENUM LmProxyType ##### -->
<para>
The type of the proxy.
</para>

@LM_PROXY_TYPE_NONE: Unused
@LM_PROXY_TYPE_HTTP: An HTTP proxy.

<!-- ##### FUNCTION lm_proxy_new ##### -->
<para>

</para>

@type: 
@Returns: 


<!-- ##### FUNCTION lm_proxy_new_with_server ##### -->
<para>

</para>

@type: 
@server: 
@port: 
@Returns: 


<!-- ##### FUNCTION lm_proxy_get_type ##### -->
<para>

</para>

@proxy: 
@Returns: 


<!-- ##### FUNCTION lm_proxy_set_type ##### -->
<para>

</para>

@proxy: 
@type: 


<!-- ##### FUNCTION lm_proxy_get_server ##### -->
<para>

</para>

@proxy: 
@Returns: 


<!-- ##### FUNCTION lm_proxy_set_server ##### -->
<para>

</para>

@proxy: 
@server: 


<!-- ##### FUNCTION lm_proxy_get_port ##### -->
<para>

</para>

@proxy: 
@Returns: 


<!-- ##### FUNCTION lm_proxy_set_port ##### -->
<para>

</para>

@proxy: 
@port: 


<!-- ##### FUNCTION lm_proxy_get_username ##### -->
<para>

</para>

@proxy: 
@Returns: 


<!-- ##### FUNCTION lm_proxy_set_username ##### -->
<para>

</para>

@proxy: 
@username: 


<!-- ##### FUNCTION lm_proxy_get_password ##### -->
<para>

</para>

@proxy: 
@Returns: 


<!-- ##### FUNCTION lm_proxy_set_password ##### -->
<para>

</para>

@proxy: 
@password: 


<!-- ##### FUNCTION lm_proxy_ref ##### -->
<para>

</para>

@proxy: 
@Returns: 


<!-- ##### FUNCTION lm_proxy_unref ##### -->
<para>

</para>

@proxy: