author | hallski <hallski> |
Mon, 02 Aug 2004 23:57:41 +0000 | |
changeset 84 | 7ae7b690aa89 |
parent 83 | 9c89653e79a1 |
child 86 | cb65c1ec57a7 |
permissions | -rw-r--r-- |
83 | 1 |
<!-- ##### SECTION Title ##### --> |
2 |
LmProxy |
|
3 |
||
4 |
<!-- ##### SECTION Short_Description ##### --> |
|
5 |
API for the proxy support in Loudmouth |
|
6 |
||
7 |
<!-- ##### SECTION Long_Description ##### --> |
|
8 |
<para> |
|
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. |
|
10 |
<informalexample><programlisting><![CDATA[ |
|
11 |
LmConnection *connection; |
|
12 |
LmProxy *proxy; |
|
13 |
||
14 |
connection = lm_connection_new ("myserver"); |
|
15 |
proxy = lm_proxy_new_with_server (LM_PROXY_TYPE_HTTP, |
|
16 |
"myproxyserver", |
|
17 |
8080); |
|
18 |
lm_connection_set_proxy (connection, proxy); |
|
19 |
...]]></programlisting></informalexample> |
|
20 |
</para> |
|
21 |
||
22 |
<!-- ##### SECTION See_Also ##### --> |
|
23 |
<para> |
|
24 |
||
25 |
</para> |
|
26 |
||
27 |
<!-- ##### STRUCT LmProxy ##### --> |
|
28 |
<para> |
|
29 |
This should not be accessed directly. Use the accessor functions as described below. |
|
30 |
</para> |
|
31 |
||
32 |
||
33 |
<!-- ##### ENUM LmProxyType ##### --> |
|
34 |
<para> |
|
35 |
The type of the proxy. |
|
36 |
</para> |
|
37 |
||
84
7ae7b690aa89
2004-05-28 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
83
diff
changeset
|
38 |
@LM_PROXY_TYPE_NONE: |
83 | 39 |
@LM_PROXY_TYPE_HTTP: An HTTP proxy. |
40 |
||
41 |
<!-- ##### FUNCTION lm_proxy_new ##### --> |
|
42 |
<para> |
|
43 |
||
44 |
</para> |
|
45 |
||
46 |
@type: |
|
47 |
@Returns: |
|
48 |
||
49 |
||
50 |
<!-- ##### FUNCTION lm_proxy_new_with_server ##### --> |
|
51 |
<para> |
|
52 |
||
53 |
</para> |
|
54 |
||
55 |
@type: |
|
56 |
@server: |
|
57 |
@port: |
|
58 |
@Returns: |
|
59 |
||
60 |
||
61 |
<!-- ##### FUNCTION lm_proxy_get_type ##### --> |
|
62 |
<para> |
|
63 |
||
64 |
</para> |
|
65 |
||
66 |
@proxy: |
|
67 |
@Returns: |
|
68 |
||
69 |
||
70 |
<!-- ##### FUNCTION lm_proxy_set_type ##### --> |
|
71 |
<para> |
|
72 |
||
73 |
</para> |
|
74 |
||
75 |
@proxy: |
|
76 |
@type: |
|
77 |
||
78 |
||
79 |
<!-- ##### FUNCTION lm_proxy_get_server ##### --> |
|
80 |
<para> |
|
81 |
||
82 |
</para> |
|
83 |
||
84 |
@proxy: |
|
85 |
@Returns: |
|
86 |
||
87 |
||
88 |
<!-- ##### FUNCTION lm_proxy_set_server ##### --> |
|
89 |
<para> |
|
90 |
||
91 |
</para> |
|
92 |
||
93 |
@proxy: |
|
94 |
@server: |
|
95 |
||
96 |
||
97 |
<!-- ##### FUNCTION lm_proxy_get_port ##### --> |
|
98 |
<para> |
|
99 |
||
100 |
</para> |
|
101 |
||
102 |
@proxy: |
|
103 |
@Returns: |
|
104 |
||
105 |
||
106 |
<!-- ##### FUNCTION lm_proxy_set_port ##### --> |
|
107 |
<para> |
|
108 |
||
109 |
</para> |
|
110 |
||
111 |
@proxy: |
|
112 |
@port: |
|
113 |
||
114 |
||
115 |
<!-- ##### FUNCTION lm_proxy_get_username ##### --> |
|
116 |
<para> |
|
117 |
||
118 |
</para> |
|
119 |
||
120 |
@proxy: |
|
121 |
@Returns: |
|
122 |
||
123 |
||
124 |
<!-- ##### FUNCTION lm_proxy_set_username ##### --> |
|
125 |
<para> |
|
126 |
||
127 |
</para> |
|
128 |
||
129 |
@proxy: |
|
130 |
@username: |
|
131 |
||
132 |
||
133 |
<!-- ##### FUNCTION lm_proxy_get_password ##### --> |
|
134 |
<para> |
|
135 |
||
136 |
</para> |
|
137 |
||
138 |
@proxy: |
|
139 |
@Returns: |
|
140 |
||
141 |
||
142 |
<!-- ##### FUNCTION lm_proxy_set_password ##### --> |
|
143 |
<para> |
|
144 |
||
145 |
</para> |
|
146 |
||
147 |
@proxy: |
|
148 |
@password: |
|
149 |
||
150 |
||
151 |
<!-- ##### FUNCTION lm_proxy_ref ##### --> |
|
152 |
<para> |
|
153 |
||
154 |
</para> |
|
155 |
||
156 |
@proxy: |
|
157 |
@Returns: |
|
158 |
||
159 |
||
160 |
<!-- ##### FUNCTION lm_proxy_unref ##### --> |
|
161 |
<para> |
|
162 |
||
163 |
</para> |
|
164 |
||
165 |
@proxy: |
|
166 |
||
167 |