1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="loudmouth-lm-proxy">
<refmeta>
<refentrytitle>LmProxy</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LOUDMOUTH Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>LmProxy</refname><refpurpose>API for the proxy support in Loudmouth</refpurpose>
</refnamediv>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
struct <link linkend="LmProxy">LmProxy</link>;
enum <link linkend="LmProxyType">LmProxyType</link>;
<link linkend="LmProxy">LmProxy</link>* <link linkend="lm-proxy-new">lm_proxy_new</link> (<link linkend="LmProxyType">LmProxyType</link> type);
<link linkend="LmProxy">LmProxy</link>* <link linkend="lm-proxy-new-with-server">lm_proxy_new_with_server</link> (<link linkend="LmProxyType">LmProxyType</link> type,
const <link linkend="gchar">gchar</link> *server,
<link linkend="guint">guint</link> port);
<link linkend="LmProxyType">LmProxyType</link> <link linkend="lm-proxy-get-type">lm_proxy_get_type</link> (<link linkend="LmProxy">LmProxy</link> *proxy);
<link linkend="void">void</link> <link linkend="lm-proxy-set-type">lm_proxy_set_type</link> (<link linkend="LmProxy">LmProxy</link> *proxy,
<link linkend="LmProxyType">LmProxyType</link> type);
const <link linkend="gchar">gchar</link>* <link linkend="lm-proxy-get-server">lm_proxy_get_server</link> (<link linkend="LmProxy">LmProxy</link> *proxy);
<link linkend="void">void</link> <link linkend="lm-proxy-set-server">lm_proxy_set_server</link> (<link linkend="LmProxy">LmProxy</link> *proxy,
const <link linkend="gchar">gchar</link> *server);
<link linkend="guint">guint</link> <link linkend="lm-proxy-get-port">lm_proxy_get_port</link> (<link linkend="LmProxy">LmProxy</link> *proxy);
<link linkend="void">void</link> <link linkend="lm-proxy-set-port">lm_proxy_set_port</link> (<link linkend="LmProxy">LmProxy</link> *proxy,
<link linkend="guint">guint</link> port);
const <link linkend="gchar">gchar</link>* <link linkend="lm-proxy-get-username">lm_proxy_get_username</link> (<link linkend="LmProxy">LmProxy</link> *proxy);
<link linkend="void">void</link> <link linkend="lm-proxy-set-username">lm_proxy_set_username</link> (<link linkend="LmProxy">LmProxy</link> *proxy,
const <link linkend="gchar">gchar</link> *username);
const <link linkend="gchar">gchar</link>* <link linkend="lm-proxy-get-password">lm_proxy_get_password</link> (<link linkend="LmProxy">LmProxy</link> *proxy);
<link linkend="void">void</link> <link linkend="lm-proxy-set-password">lm_proxy_set_password</link> (<link linkend="LmProxy">LmProxy</link> *proxy,
const <link linkend="gchar">gchar</link> *password);
<link linkend="LmProxy">LmProxy</link>* <link linkend="lm-proxy-ref">lm_proxy_ref</link> (<link linkend="LmProxy">LmProxy</link> *proxy);
<link linkend="void">void</link> <link linkend="lm-proxy-unref">lm_proxy_unref</link> (<link linkend="LmProxy">LmProxy</link> *proxy);
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Use this together with an <link linkend="LmConnection"><type>LmConnection</type></link> to get the connection to use connect through a proxy. Example of how to use the <link linkend="LmProxy"><type>LmProxy</type></link> 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>
</refsect1>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="LmProxy"/>struct LmProxy</title>
<indexterm><primary>LmProxy</primary></indexterm><programlisting>struct LmProxy;</programlisting>
<para>
This should not be accessed directly. Use the accessor functions as described below.
</para></refsect2>
<refsect2>
<title><anchor id="LmProxyType"/>enum LmProxyType</title>
<indexterm><primary>LmProxyType</primary></indexterm><programlisting>typedef enum {
LM_PROXY_TYPE_NONE = 0,
LM_PROXY_TYPE_HTTP
} LmProxyType;
</programlisting>
<para>
The type of the proxy.
</para><variablelist role="enum">
<varlistentry>
<term><literal>LM_PROXY_TYPE_NONE</literal></term>
<listitem><simpara>Use this to unset the proxy on an <link linkend="LmConnection"><type>LmConnection</type></link>.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>LM_PROXY_TYPE_HTTP</literal></term>
<listitem><simpara>An HTTP proxy.
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="lm-proxy-new"/>lm_proxy_new ()</title>
<indexterm><primary>lm_proxy_new</primary></indexterm><programlisting><link linkend="LmProxy">LmProxy</link>* lm_proxy_new (<link linkend="LmProxyType">LmProxyType</link> type);</programlisting>
<para>
Creates a new Proxy. Used <link linkend="lm-connection-set-proxy"><type>lm_connection_set_proxy</type></link> to make a connection
user this proxy.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>type</parameter> :</term>
<listitem><simpara> the type of the new proxy
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a newly create proxy
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="lm-proxy-new-with-server"/>lm_proxy_new_with_server ()</title>
<indexterm><primary>lm_proxy_new_with_server</primary></indexterm><programlisting><link linkend="LmProxy">LmProxy</link>* lm_proxy_new_with_server (<link linkend="LmProxyType">LmProxyType</link> type,
const <link linkend="gchar">gchar</link> *server,
<link linkend="guint">guint</link> port);</programlisting>
<para>
Creates a new Proxy. Use <link linkend="lm-connection-set-proxy"><type>lm_connection_set_proxy</type></link> to make a connection
user this proxy.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>type</parameter> :</term>
<listitem><simpara> the type of the new proxy
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>server</parameter> :</term>
<listitem><simpara> the proxy server
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>port</parameter> :</term>
<listitem><simpara> the proxy server port
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a newly create proxy
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="lm-proxy-get-type"/>lm_proxy_get_type ()</title>
<indexterm><primary>lm_proxy_get_type</primary></indexterm><programlisting><link linkend="LmProxyType">LmProxyType</link> lm_proxy_get_type (<link linkend="LmProxy">LmProxy</link> *proxy);</programlisting>
<para>
Fetches the proxy type</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>proxy</parameter> :</term>
<listitem><simpara> an <link linkend="LmProxy"><type>LmProxy</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the type
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="lm-proxy-set-type"/>lm_proxy_set_type ()</title>
<indexterm><primary>lm_proxy_set_type</primary></indexterm><programlisting><link linkend="void">void</link> lm_proxy_set_type (<link linkend="LmProxy">LmProxy</link> *proxy,
<link linkend="LmProxyType">LmProxyType</link> type);</programlisting>
<para>
Sets the proxy type for <parameter>proxy</parameter> to <parameter>type</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>proxy</parameter> :</term>
<listitem><simpara> an <link linkend="LmProxy"><type>LmProxy</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter> :</term>
<listitem><simpara> an LmProxyType
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="lm-proxy-get-server"/>lm_proxy_get_server ()</title>
<indexterm><primary>lm_proxy_get_server</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* lm_proxy_get_server (<link linkend="LmProxy">LmProxy</link> *proxy);</programlisting>
<para>
Fetches the server address that <parameter>proxy</parameter> is using.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>proxy</parameter> :</term>
<listitem><simpara> an <link linkend="LmProxy"><type>LmProxy</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the proxy server address
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="lm-proxy-set-server"/>lm_proxy_set_server ()</title>
<indexterm><primary>lm_proxy_set_server</primary></indexterm><programlisting><link linkend="void">void</link> lm_proxy_set_server (<link linkend="LmProxy">LmProxy</link> *proxy,
const <link linkend="gchar">gchar</link> *server);</programlisting>
<para>
Sets the server address for <parameter>proxy</parameter> to <parameter>server</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>proxy</parameter> :</term>
<listitem><simpara> an <link linkend="LmProxy"><type>LmProxy</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>server</parameter> :</term>
<listitem><simpara> Address of the proxy server
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="lm-proxy-get-port"/>lm_proxy_get_port ()</title>
<indexterm><primary>lm_proxy_get_port</primary></indexterm><programlisting><link linkend="guint">guint</link> lm_proxy_get_port (<link linkend="LmProxy">LmProxy</link> *proxy);</programlisting>
<para>
Fetches the port that <parameter>proxy</parameter> is using.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>proxy</parameter> :</term>
<listitem><simpara> an <link linkend="LmProxy"><type>LmProxy</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The port
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="lm-proxy-set-port"/>lm_proxy_set_port ()</title>
<indexterm><primary>lm_proxy_set_port</primary></indexterm><programlisting><link linkend="void">void</link> lm_proxy_set_port (<link linkend="LmProxy">LmProxy</link> *proxy,
<link linkend="guint">guint</link> port);</programlisting>
<para>
Sets the server port that <parameter>proxy</parameter> will be using.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>proxy</parameter> :</term>
<listitem><simpara> an <link linkend="LmProxy"><type>LmProxy</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>port</parameter> :</term>
<listitem><simpara> proxy server port
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="lm-proxy-get-username"/>lm_proxy_get_username ()</title>
<indexterm><primary>lm_proxy_get_username</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* lm_proxy_get_username (<link linkend="LmProxy">LmProxy</link> *proxy);</programlisting>
<para>
Fetches the username that <parameter>proxy</parameter> is using.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>proxy</parameter> :</term>
<listitem><simpara> an <link linkend="LmProxy"><type>LmProxy</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the username
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="lm-proxy-set-username"/>lm_proxy_set_username ()</title>
<indexterm><primary>lm_proxy_set_username</primary></indexterm><programlisting><link linkend="void">void</link> lm_proxy_set_username (<link linkend="LmProxy">LmProxy</link> *proxy,
const <link linkend="gchar">gchar</link> *username);</programlisting>
<para>
Sets the username for <parameter>proxy</parameter> to <parameter>username</parameter> or <literal>NULL</literal> to unset.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>proxy</parameter> :</term>
<listitem><simpara> an <link linkend="LmProxy"><type>LmProxy</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>username</parameter> :</term>
<listitem><simpara> Username
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="lm-proxy-get-password"/>lm_proxy_get_password ()</title>
<indexterm><primary>lm_proxy_get_password</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* lm_proxy_get_password (<link linkend="LmProxy">LmProxy</link> *proxy);</programlisting>
<para>
Fetches the password that <parameter>proxy</parameter> is using.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>proxy</parameter> :</term>
<listitem><simpara> an <link linkend="LmProxy"><type>LmProxy</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the proxy password
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="lm-proxy-set-password"/>lm_proxy_set_password ()</title>
<indexterm><primary>lm_proxy_set_password</primary></indexterm><programlisting><link linkend="void">void</link> lm_proxy_set_password (<link linkend="LmProxy">LmProxy</link> *proxy,
const <link linkend="gchar">gchar</link> *password);</programlisting>
<para>
Sets the password for <parameter>proxy</parameter> to <parameter>password</parameter> or <literal>NULL</literal> to unset.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>proxy</parameter> :</term>
<listitem><simpara> an <link linkend="LmProxy"><type>LmProxy</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>password</parameter> :</term>
<listitem><simpara> Password
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="lm-proxy-ref"/>lm_proxy_ref ()</title>
<indexterm><primary>lm_proxy_ref</primary></indexterm><programlisting><link linkend="LmProxy">LmProxy</link>* lm_proxy_ref (<link linkend="LmProxy">LmProxy</link> *proxy);</programlisting>
<para>
Adds a reference to <parameter>proxy</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>proxy</parameter> :</term>
<listitem><simpara> an <link linkend="LmProxy"><type>LmProxy</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the proxy
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="lm-proxy-unref"/>lm_proxy_unref ()</title>
<indexterm><primary>lm_proxy_unref</primary></indexterm><programlisting><link linkend="void">void</link> lm_proxy_unref (<link linkend="LmProxy">LmProxy</link> *proxy);</programlisting>
<para>
Removes a reference from <parameter>proxy</parameter>. When no more references are present
<parameter>proxy</parameter> is freed.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>proxy</parameter> :</term>
<listitem><simpara> an <link linkend="LmProxy"><type>LmProxy</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
