docs/reference/tmpl/lm-proxy.sgml
author hallski <hallski>
Mon, 02 Aug 2004 23:57:41 +0000
changeset 84 7ae7b690aa89
parent 83 9c89653e79a1
child 86 cb65c1ec57a7
permissions -rw-r--r--
2004-05-28 Mikael Hallendal <micke@imendio.com> * configure.in: - Correctly inform whether SSL support was enabled or not. 2004-05-28 Mikael Hallendal <micke@imendio.com> * src/lm-sha.c: Fixed lvalue cast that wasn't approved by newer GCC. 2004-05-10 Mikael Hallendal <micke@imendio.com> * configure.in: Enable Mono on request * mono/*: - Updated the bindings some. - Removed the autogenerated, it's such a small API that I figured it was easier to wrap it manually. 2004-04-30 Mikael Hallendal <micke@imendio.com> * loudmouth/lm-parser.c (parser_end_node_cb): Unref the message node. 2004-04-29 Mikael Hallendal <micke@imendio.com> * examples/lm-change-password.c: * examples/Makefile.am: - Added a small tool to change the password on a jabber account. 2004-04-27 Mikael Hallendal <micke@imendio.com> * Ignore on autogenerated files. 2004-04-20 Mikael Hallendal <micke@imendio.com> * loudmouth/*.[ch]: Updated copyright information 2004-04-20 Mikael Hallendal <micke@imendio.com> * configure.in: Now depend on Glib 2.4 * loudmouth/lm-queue.[ch]: Removed, use the new GQueue in Glib 2.4 * loudmouth/lm-connection.[ch]: Use GQueue instead of LmQueue. 2004-04-16 Mikael Hallendal <micke@imendio.com> * configure.in: Added libtasn1 requirement * loudmouth.spec.in: Added requirement on libtasn if built with SSL. 2004-04-04 Mikael Hallendal <micke@imendio.com> * loudmouth/lm-sha.c: Commited compile fix from Sjoerd. 2004-03-20 Mikael Hallendal <micke@imendio.com> * docs/reference/loudmouth-sections.txt: - Added lm_connection_get_state - Added LmConnectionState
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
83
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
     1
<!-- ##### SECTION Title ##### -->
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
     2
LmProxy
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
     3
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
     4
<!-- ##### SECTION Short_Description ##### -->
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
     5
API for the proxy support in Loudmouth
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
     6
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
     7
<!-- ##### SECTION Long_Description ##### -->
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
     8
<para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
     9
Use this together with an #LmConnection to get the connection to use connect through a proxy. Example of how to use the #LmProxy API.
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    10
<informalexample><programlisting><![CDATA[
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    11
LmConnection *connection;
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    12
LmProxy      *proxy;
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    13
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    14
connection = lm_connection_new ("myserver");
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    15
proxy = lm_proxy_new_with_server (LM_PROXY_TYPE_HTTP,
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    16
				  "myproxyserver",
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    17
				  8080);
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    18
lm_connection_set_proxy (connection, proxy);
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    19
...]]></programlisting></informalexample>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    20
</para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    21
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    22
<!-- ##### SECTION See_Also ##### -->
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    23
<para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    24
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    25
</para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    26
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    27
<!-- ##### STRUCT LmProxy ##### -->
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    28
<para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    29
This should not be accessed directly. Use the accessor functions as described below.
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    30
</para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    31
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    32
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    33
<!-- ##### ENUM LmProxyType ##### -->
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    34
<para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    35
The type of the proxy.
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    36
</para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    37
84
7ae7b690aa89 2004-05-28 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents: 83
diff changeset
    38
@LM_PROXY_TYPE_NONE: 
83
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    39
@LM_PROXY_TYPE_HTTP: An HTTP proxy.
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    40
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    41
<!-- ##### FUNCTION lm_proxy_new ##### -->
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    42
<para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    43
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    44
</para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    45
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    46
@type: 
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    47
@Returns: 
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    48
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    49
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    50
<!-- ##### FUNCTION lm_proxy_new_with_server ##### -->
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    51
<para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    52
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    53
</para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    54
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    55
@type: 
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    56
@server: 
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    57
@port: 
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    58
@Returns: 
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    59
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    60
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    61
<!-- ##### FUNCTION lm_proxy_get_type ##### -->
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    62
<para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    63
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    64
</para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    65
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    66
@proxy: 
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    67
@Returns: 
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    68
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    69
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    70
<!-- ##### FUNCTION lm_proxy_set_type ##### -->
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    71
<para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    72
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    73
</para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    74
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    75
@proxy: 
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    76
@type: 
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    77
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    78
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    79
<!-- ##### FUNCTION lm_proxy_get_server ##### -->
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    80
<para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    81
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    82
</para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    83
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    84
@proxy: 
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    85
@Returns: 
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    86
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    87
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    88
<!-- ##### FUNCTION lm_proxy_set_server ##### -->
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    89
<para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    90
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    91
</para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    92
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    93
@proxy: 
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    94
@server: 
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    95
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    96
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    97
<!-- ##### FUNCTION lm_proxy_get_port ##### -->
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    98
<para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
    99
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   100
</para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   101
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   102
@proxy: 
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   103
@Returns: 
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   104
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   105
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   106
<!-- ##### FUNCTION lm_proxy_set_port ##### -->
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   107
<para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   108
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   109
</para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   110
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   111
@proxy: 
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   112
@port: 
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   113
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   114
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   115
<!-- ##### FUNCTION lm_proxy_get_username ##### -->
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   116
<para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   117
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   118
</para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   119
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   120
@proxy: 
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   121
@Returns: 
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   122
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   123
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   124
<!-- ##### FUNCTION lm_proxy_set_username ##### -->
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   125
<para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   126
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   127
</para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   128
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   129
@proxy: 
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   130
@username: 
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   131
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   132
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   133
<!-- ##### FUNCTION lm_proxy_get_password ##### -->
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   134
<para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   135
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   136
</para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   137
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   138
@proxy: 
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   139
@Returns: 
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   140
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   141
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   142
<!-- ##### FUNCTION lm_proxy_set_password ##### -->
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   143
<para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   144
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   145
</para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   146
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   147
@proxy: 
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   148
@password: 
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   149
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   150
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   151
<!-- ##### FUNCTION lm_proxy_ref ##### -->
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   152
<para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   153
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   154
</para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   155
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   156
@proxy: 
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   157
@Returns: 
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   158
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   159
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   160
<!-- ##### FUNCTION lm_proxy_unref ##### -->
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   161
<para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   162
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   163
</para>
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   164
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   165
@proxy: 
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   166
9c89653e79a1 added files
hallski <hallski>
parents:
diff changeset
   167