Debian Codegraph @

docs/api/html/libprelude-prelude-connection.html

raw
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>prelude-connection: libprelude Reference Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7 <link rel="home" href="index.html" title="libprelude Reference Manual">
8 <link rel="up" href="ch01.html" title="[Insert title here]">
9 <link rel="prev" href="libprelude-prelude-option.html" title="prelude-option">
10 <link rel="next" href="libprelude-prelude-string.html" title="prelude-string">
11 <meta name="generator" content="GTK-Doc V1.28 (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="5"><tr valign="middle">
16 <td width="100%" align="left" class="shortcuts">
17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
18 <a href="#libprelude-prelude-connection.description" class="shortcut">Description</a></span>
19 </td>
20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
21 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
22 <td><a accesskey="p" href="libprelude-prelude-option.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
23 <td><a accesskey="n" href="libprelude-prelude-string.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
24 </tr></table>
25 <div class="refentry">
26 <a name="libprelude-prelude-connection"></a><div class="titlepage"></div>
27 <div class="refnamediv"><table width="100%"><tr>
28 <td valign="top">
29 <h2><span class="refentrytitle"><a name="libprelude-prelude-connection.top_of_page"></a>prelude-connection</span></h2>
30 <p>prelude-connection</p>
31 </td>
32 <td class="gallery_image" valign="top" align="right"></td>
33 </tr></table></div>
34 <div class="refsect1">
35 <a name="libprelude-prelude-connection.functions"></a><h2>Functions</h2>
36 <div class="informaltable"><table width="100%" border="0">
37 <colgroup>
38 <col width="150px" class="functions_return">
39 <col class="functions_name">
40 </colgroup>
41 <tbody>
42 <tr>
43 <td class="function_type">
44 <span class="returnvalue">void</span>
45 </td>
46 <td class="function_name">
47 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-destroy" title="prelude_connection_destroy ()">prelude_connection_destroy</a> <span class="c_punctuation">()</span>
48 </td>
49 </tr>
50 <tr>
51 <td class="function_type">
52 <span class="returnvalue">int</span>
53 </td>
54 <td class="function_name">
55 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-send" title="prelude_connection_send ()">prelude_connection_send</a> <span class="c_punctuation">()</span>
56 </td>
57 </tr>
58 <tr>
59 <td class="function_type">
60 <span class="returnvalue">int</span>
61 </td>
62 <td class="function_name">
63 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-recv" title="prelude_connection_recv ()">prelude_connection_recv</a> <span class="c_punctuation">()</span>
64 </td>
65 </tr>
66 <tr>
67 <td class="function_type">
68 <span class="returnvalue">int</span>
69 </td>
70 <td class="function_name">
71 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-recv-idmef" title="prelude_connection_recv_idmef ()">prelude_connection_recv_idmef</a> <span class="c_punctuation">()</span>
72 </td>
73 </tr>
74 <tr>
75 <td class="function_type">
76 <span class="returnvalue">int</span>
77 </td>
78 <td class="function_name">
79 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-connect" title="prelude_connection_connect ()">prelude_connection_connect</a> <span class="c_punctuation">()</span>
80 </td>
81 </tr>
82 <tr>
83 <td class="function_type">
84 <span class="returnvalue">ssize_t</span>
85 </td>
86 <td class="function_name">
87 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-forward" title="prelude_connection_forward ()">prelude_connection_forward</a> <span class="c_punctuation">()</span>
88 </td>
89 </tr>
90 <tr>
91 <td class="function_type">const <span class="returnvalue">char</span> *
92 </td>
93 <td class="function_name">
94 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-get-local-addr" title="prelude_connection_get_local_addr ()">prelude_connection_get_local_addr</a> <span class="c_punctuation">()</span>
95 </td>
96 </tr>
97 <tr>
98 <td class="function_type">unsigned <span class="returnvalue">int</span>
99 </td>
100 <td class="function_name">
101 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-get-local-port" title="prelude_connection_get_local_port ()">prelude_connection_get_local_port</a> <span class="c_punctuation">()</span>
102 </td>
103 </tr>
104 <tr>
105 <td class="function_type">const <span class="returnvalue">char</span> *
106 </td>
107 <td class="function_name">
108 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-get-peer-addr" title="prelude_connection_get_peer_addr ()">prelude_connection_get_peer_addr</a> <span class="c_punctuation">()</span>
109 </td>
110 </tr>
111 <tr>
112 <td class="function_type">unsigned <span class="returnvalue">int</span>
113 </td>
114 <td class="function_name">
115 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-get-peer-port" title="prelude_connection_get_peer_port ()">prelude_connection_get_peer_port</a> <span class="c_punctuation">()</span>
116 </td>
117 </tr>
118 <tr>
119 <td class="function_type">
120 <a class="link" href="libprelude-prelude-inttypes.html#prelude-bool-t" title="enum prelude_bool_t"><span class="returnvalue">prelude_bool_t</span></a>
121 </td>
122 <td class="function_name">
123 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-is-alive" title="prelude_connection_is_alive ()">prelude_connection_is_alive</a> <span class="c_punctuation">()</span>
124 </td>
125 </tr>
126 <tr>
127 <td class="function_type">
128 <a class="link" href="libprelude-prelude-io.html#prelude-io-t" title="prelude_io_t"><span class="returnvalue">prelude_io_t</span></a> *
129 </td>
130 <td class="function_name">
131 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-get-fd" title="prelude_connection_get_fd ()">prelude_connection_get_fd</a> <span class="c_punctuation">()</span>
132 </td>
133 </tr>
134 <tr>
135 <td class="function_type">
136 <span class="returnvalue">int</span>
137 </td>
138 <td class="function_name">
139 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-close" title="prelude_connection_close ()">prelude_connection_close</a> <span class="c_punctuation">()</span>
140 </td>
141 </tr>
142 <tr>
143 <td class="function_type">
144 <span class="returnvalue">void</span>
145 </td>
146 <td class="function_name">
147 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-set-fd-ref" title="prelude_connection_set_fd_ref ()">prelude_connection_set_fd_ref</a> <span class="c_punctuation">()</span>
148 </td>
149 </tr>
150 <tr>
151 <td class="function_type">
152 <span class="returnvalue">void</span>
153 </td>
154 <td class="function_name">
155 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-set-fd-nodup" title="prelude_connection_set_fd_nodup ()">prelude_connection_set_fd_nodup</a> <span class="c_punctuation">()</span>
156 </td>
157 </tr>
158 <tr>
159 <td class="function_type">
160 <span class="returnvalue">void</span>
161 </td>
162 <td class="function_name">
163 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-set-state" title="prelude_connection_set_state ()">prelude_connection_set_state</a> <span class="c_punctuation">()</span>
164 </td>
165 </tr>
166 <tr>
167 <td class="function_type">
168 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-state-t" title="enum prelude_connection_state_t"><span class="returnvalue">prelude_connection_state_t</span></a>
169 </td>
170 <td class="function_name">
171 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-get-state" title="prelude_connection_get_state ()">prelude_connection_get_state</a> <span class="c_punctuation">()</span>
172 </td>
173 </tr>
174 <tr>
175 <td class="function_type">
176 <span class="returnvalue">void</span>
177 </td>
178 <td class="function_name">
179 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-set-data" title="prelude_connection_set_data ()">prelude_connection_set_data</a> <span class="c_punctuation">()</span>
180 </td>
181 </tr>
182 <tr>
183 <td class="function_type">
184 <span class="returnvalue">void</span> *
185 </td>
186 <td class="function_name">
187 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-get-data" title="prelude_connection_get_data ()">prelude_connection_get_data</a> <span class="c_punctuation">()</span>
188 </td>
189 </tr>
190 <tr>
191 <td class="function_type">const <span class="returnvalue">char</span> *
192 </td>
193 <td class="function_name">
194 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-get-default-socket-filename" title="prelude_connection_get_default_socket_filename ()">prelude_connection_get_default_socket_filename</a> <span class="c_punctuation">()</span>
195 </td>
196 </tr>
197 <tr>
198 <td class="function_type">
199 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-permission-t" title="enum prelude_connection_permission_t"><span class="returnvalue">prelude_connection_permission_t</span></a>
200 </td>
201 <td class="function_name">
202 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-get-permission" title="prelude_connection_get_permission ()">prelude_connection_get_permission</a> <span class="c_punctuation">()</span>
203 </td>
204 </tr>
205 <tr>
206 <td class="function_type">
207 <a class="link" href="libprelude-prelude-inttypes.html#uint64-t" title="uint64_t"><span class="returnvalue">uint64_t</span></a>
208 </td>
209 <td class="function_name">
210 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-get-peer-analyzerid" title="prelude_connection_get_peer_analyzerid ()">prelude_connection_get_peer_analyzerid</a> <span class="c_punctuation">()</span>
211 </td>
212 </tr>
213 <tr>
214 <td class="function_type">
215 <span class="returnvalue">void</span>
216 </td>
217 <td class="function_name">
218 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-set-peer-analyzerid" title="prelude_connection_set_peer_analyzerid ()">prelude_connection_set_peer_analyzerid</a> <span class="c_punctuation">()</span>
219 </td>
220 </tr>
221 <tr>
222 <td class="function_type">
223 <span class="returnvalue">int</span>
224 </td>
225 <td class="function_name">
226 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-new" title="prelude_connection_new ()">prelude_connection_new</a> <span class="c_punctuation">()</span>
227 </td>
228 </tr>
229 <tr>
230 <td class="function_type">
231 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="returnvalue">prelude_connection_t</span></a> *
232 </td>
233 <td class="function_name">
234 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-ref" title="prelude_connection_ref ()">prelude_connection_ref</a> <span class="c_punctuation">()</span>
235 </td>
236 </tr>
237 <tr>
238 <td class="function_type">
239 <span class="returnvalue">int</span>
240 </td>
241 <td class="function_name">
242 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-new-msgbuf" title="prelude_connection_new_msgbuf ()">prelude_connection_new_msgbuf</a> <span class="c_punctuation">()</span>
243 </td>
244 </tr>
245 <tr>
246 <td class="function_type">
247 <span class="returnvalue">int</span>
248 </td>
249 <td class="function_name">
250 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-permission-to-string" title="prelude_connection_permission_to_string ()">prelude_connection_permission_to_string</a> <span class="c_punctuation">()</span>
251 </td>
252 </tr>
253 <tr>
254 <td class="function_type">
255 <span class="returnvalue">int</span>
256 </td>
257 <td class="function_name">
258 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-permission-new-from-string" title="prelude_connection_permission_new_from_string ()">prelude_connection_permission_new_from_string</a> <span class="c_punctuation">()</span>
259 </td>
260 </tr>
261 </tbody>
262 </table></div>
263 </div>
264 <div class="refsect1">
265 <a name="libprelude-prelude-connection.other"></a><h2>Types and Values</h2>
266 <div class="informaltable"><table width="100%" border="0">
267 <colgroup>
268 <col width="150px" class="name">
269 <col class="description">
270 </colgroup>
271 <tbody>
272 <tr>
273 <td class="datatype_keyword">enum</td>
274 <td class="function_name"><a class="link" href="libprelude-prelude-connection.html#prelude-connection-permission-t" title="enum prelude_connection_permission_t">prelude_connection_permission_t</a></td>
275 </tr>
276 <tr>
277 <td class="datatype_keyword">enum</td>
278 <td class="function_name"><a class="link" href="libprelude-prelude-connection.html#prelude-connection-state-t" title="enum prelude_connection_state_t">prelude_connection_state_t</a></td>
279 </tr>
280 <tr>
281 <td class="typedef_keyword">typedef</td>
282 <td class="function_name"><a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t">prelude_connection_t</a></td>
283 </tr>
284 </tbody>
285 </table></div>
286 </div>
287 <div class="refsect1">
288 <a name="libprelude-prelude-connection.description"></a><h2>Description</h2>
289 </div>
290 <div class="refsect1">
291 <a name="libprelude-prelude-connection.functions_details"></a><h2>Functions</h2>
292 <div class="refsect2">
293 <a name="prelude-connection-destroy"></a><h3>prelude_connection_destroy ()</h3>
294 <pre class="programlisting"><span class="returnvalue">void</span>
295 prelude_connection_destroy (<em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> *conn</code></em>);</pre>
296 <p>Destroy the connection referenced by <em class="parameter"><code>conn</code></em>
297 .</p>
298 <p>In case the connection is still alive, it is closed in a blocking
299 manner. Use <a class="link" href="libprelude-prelude-connection.html#prelude-connection-close" title="prelude_connection_close ()"><code class="function">prelude_connection_close()</code></a> if you want to close the
300 connection in a non blocking manner prior <a class="link" href="libprelude-prelude-connection.html#prelude-connection-destroy" title="prelude_connection_destroy ()"><code class="function">prelude_connection_destroy()</code></a>.</p>
301 <div class="refsect3">
302 <a name="prelude-connection-destroy.parameters"></a><h4>Parameters</h4>
303 <div class="informaltable"><table width="100%" border="0">
304 <colgroup>
305 <col width="150px" class="parameters_name">
306 <col class="parameters_description">
307 <col width="200px" class="parameters_annotations">
308 </colgroup>
309 <tbody><tr>
310 <td class="parameter_name"><p>conn</p></td>
311 <td class="parameter_description"><p>Pointer to a <a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> object.</p></td>
312 <td class="parameter_annotations"> </td>
313 </tr></tbody>
314 </table></div>
315 </div>
316 </div>
317 <hr>
318 <div class="refsect2">
319 <a name="prelude-connection-send"></a><h3>prelude_connection_send ()</h3>
320 <pre class="programlisting"><span class="returnvalue">int</span>
321 prelude_connection_send (<em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> *cnx</code></em>,
322 <em class="parameter"><code><a class="link" href="libprelude-prelude-msg.html#prelude-msg-t" title="prelude_msg_t"><span class="type">prelude_msg_t</span></a> *msg</code></em>);</pre>
323 </div>
324 <hr>
325 <div class="refsect2">
326 <a name="prelude-connection-recv"></a><h3>prelude_connection_recv ()</h3>
327 <pre class="programlisting"><span class="returnvalue">int</span>
328 prelude_connection_recv (<em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> *cnx</code></em>,
329 <em class="parameter"><code><a class="link" href="libprelude-prelude-msg.html#prelude-msg-t" title="prelude_msg_t"><span class="type">prelude_msg_t</span></a> **outmsg</code></em>);</pre>
330 </div>
331 <hr>
332 <div class="refsect2">
333 <a name="prelude-connection-recv-idmef"></a><h3>prelude_connection_recv_idmef ()</h3>
334 <pre class="programlisting"><span class="returnvalue">int</span>
335 prelude_connection_recv_idmef (<em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> *con</code></em>,
336 <em class="parameter"><code><a class="link" href="libprelude-idmef-tree-wrap.html#idmef-message-t" title="idmef_message_t"><span class="type">idmef_message_t</span></a> **idmef</code></em>);</pre>
337 </div>
338 <hr>
339 <div class="refsect2">
340 <a name="prelude-connection-connect"></a><h3>prelude_connection_connect ()</h3>
341 <pre class="programlisting"><span class="returnvalue">int</span>
342 prelude_connection_connect (<em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> *cnx</code></em>,
343 <em class="parameter"><code><a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="type">prelude_client_profile_t</span></a> *profile</code></em>,
344 <em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-permission-t" title="enum prelude_connection_permission_t"><span class="type">prelude_connection_permission_t</span></a> permission</code></em>);</pre>
345 </div>
346 <hr>
347 <div class="refsect2">
348 <a name="prelude-connection-forward"></a><h3>prelude_connection_forward ()</h3>
349 <pre class="programlisting"><span class="returnvalue">ssize_t</span>
350 prelude_connection_forward (<em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> *cnx</code></em>,
351 <em class="parameter"><code><a class="link" href="libprelude-prelude-io.html#prelude-io-t" title="prelude_io_t"><span class="type">prelude_io_t</span></a> *src</code></em>,
352 <em class="parameter"><code><span class="type">size_t</span> count</code></em>);</pre>
353 </div>
354 <hr>
355 <div class="refsect2">
356 <a name="prelude-connection-get-local-addr"></a><h3>prelude_connection_get_local_addr ()</h3>
357 <pre class="programlisting">const <span class="returnvalue">char</span> *
358 prelude_connection_get_local_addr (<em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> *cnx</code></em>);</pre>
359 <div class="refsect3">
360 <a name="prelude-connection-get-local-addr.parameters"></a><h4>Parameters</h4>
361 <div class="informaltable"><table width="100%" border="0">
362 <colgroup>
363 <col width="150px" class="parameters_name">
364 <col class="parameters_description">
365 <col width="200px" class="parameters_annotations">
366 </colgroup>
367 <tbody><tr>
368 <td class="parameter_name"><p>cnx</p></td>
369 <td class="parameter_description"><p>Pointer to a <a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> object.</p></td>
370 <td class="parameter_annotations"> </td>
371 </tr></tbody>
372 </table></div>
373 </div>
374 <div class="refsect3">
375 <a name="prelude-connection-get-local-addr.returns"></a><h4>Returns</h4>
376 <p> the local address used to connect.</p>
377 </div>
378 </div>
379 <hr>
380 <div class="refsect2">
381 <a name="prelude-connection-get-local-port"></a><h3>prelude_connection_get_local_port ()</h3>
382 <pre class="programlisting">unsigned <span class="returnvalue">int</span>
383 prelude_connection_get_local_port (<em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> *cnx</code></em>);</pre>
384 <div class="refsect3">
385 <a name="prelude-connection-get-local-port.parameters"></a><h4>Parameters</h4>
386 <div class="informaltable"><table width="100%" border="0">
387 <colgroup>
388 <col width="150px" class="parameters_name">
389 <col class="parameters_description">
390 <col width="200px" class="parameters_annotations">
391 </colgroup>
392 <tbody><tr>
393 <td class="parameter_name"><p>cnx</p></td>
394 <td class="parameter_description"><p>Pointer to a <a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> object.</p></td>
395 <td class="parameter_annotations"> </td>
396 </tr></tbody>
397 </table></div>
398 </div>
399 <div class="refsect3">
400 <a name="prelude-connection-get-local-port.returns"></a><h4>Returns</h4>
401 <p> the local port used to connect.</p>
402 </div>
403 </div>
404 <hr>
405 <div class="refsect2">
406 <a name="prelude-connection-get-peer-addr"></a><h3>prelude_connection_get_peer_addr ()</h3>
407 <pre class="programlisting">const <span class="returnvalue">char</span> *
408 prelude_connection_get_peer_addr (<em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> *cnx</code></em>);</pre>
409 </div>
410 <hr>
411 <div class="refsect2">
412 <a name="prelude-connection-get-peer-port"></a><h3>prelude_connection_get_peer_port ()</h3>
413 <pre class="programlisting">unsigned <span class="returnvalue">int</span>
414 prelude_connection_get_peer_port (<em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> *cnx</code></em>);</pre>
415 </div>
416 <hr>
417 <div class="refsect2">
418 <a name="prelude-connection-is-alive"></a><h3>prelude_connection_is_alive ()</h3>
419 <pre class="programlisting"><a class="link" href="libprelude-prelude-inttypes.html#prelude-bool-t" title="enum prelude_bool_t"><span class="returnvalue">prelude_bool_t</span></a>
420 prelude_connection_is_alive (<em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> *cnx</code></em>);</pre>
421 <div class="refsect3">
422 <a name="prelude-connection-is-alive.parameters"></a><h4>Parameters</h4>
423 <div class="informaltable"><table width="100%" border="0">
424 <colgroup>
425 <col width="150px" class="parameters_name">
426 <col class="parameters_description">
427 <col width="200px" class="parameters_annotations">
428 </colgroup>
429 <tbody><tr>
430 <td class="parameter_name"><p>cnx</p></td>
431 <td class="parameter_description"><p>Pointer to a <a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> object.</p></td>
432 <td class="parameter_annotations"> </td>
433 </tr></tbody>
434 </table></div>
435 </div>
436 <div class="refsect3">
437 <a name="prelude-connection-is-alive.returns"></a><h4>Returns</h4>
438 <p> 0 if the connection associated with <em class="parameter"><code>cnx</code></em>
439 is alive, -1 otherwise.</p>
440 </div>
441 </div>
442 <hr>
443 <div class="refsect2">
444 <a name="prelude-connection-get-fd"></a><h3>prelude_connection_get_fd ()</h3>
445 <pre class="programlisting"><a class="link" href="libprelude-prelude-io.html#prelude-io-t" title="prelude_io_t"><span class="returnvalue">prelude_io_t</span></a> *
446 prelude_connection_get_fd (<em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> *cnx</code></em>);</pre>
447 <div class="refsect3">
448 <a name="prelude-connection-get-fd.parameters"></a><h4>Parameters</h4>
449 <div class="informaltable"><table width="100%" border="0">
450 <colgroup>
451 <col width="150px" class="parameters_name">
452 <col class="parameters_description">
453 <col width="200px" class="parameters_annotations">
454 </colgroup>
455 <tbody><tr>
456 <td class="parameter_name"><p>cnx</p></td>
457 <td class="parameter_description"><p>Pointer to a <a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> object.</p></td>
458 <td class="parameter_annotations"> </td>
459 </tr></tbody>
460 </table></div>
461 </div>
462 <div class="refsect3">
463 <a name="prelude-connection-get-fd.returns"></a><h4>Returns</h4>
464 <p> A pointer to the <a class="link" href="libprelude-prelude-io.html#prelude-io-t" title="prelude_io_t"><span class="type">prelude_io_t</span></a> object used for
465 communicating with the peer.</p>
466 </div>
467 </div>
468 <hr>
469 <div class="refsect2">
470 <a name="prelude-connection-close"></a><h3>prelude_connection_close ()</h3>
471 <pre class="programlisting"><span class="returnvalue">int</span>
472 prelude_connection_close (<em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> *cnx</code></em>);</pre>
473 </div>
474 <hr>
475 <div class="refsect2">
476 <a name="prelude-connection-set-fd-ref"></a><h3>prelude_connection_set_fd_ref ()</h3>
477 <pre class="programlisting"><span class="returnvalue">void</span>
478 prelude_connection_set_fd_ref (<em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> *cnx</code></em>,
479 <em class="parameter"><code><a class="link" href="libprelude-prelude-io.html#prelude-io-t" title="prelude_io_t"><span class="type">prelude_io_t</span></a> *fd</code></em>);</pre>
480 </div>
481 <hr>
482 <div class="refsect2">
483 <a name="prelude-connection-set-fd-nodup"></a><h3>prelude_connection_set_fd_nodup ()</h3>
484 <pre class="programlisting"><span class="returnvalue">void</span>
485 prelude_connection_set_fd_nodup (<em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> *cnx</code></em>,
486 <em class="parameter"><code><a class="link" href="libprelude-prelude-io.html#prelude-io-t" title="prelude_io_t"><span class="type">prelude_io_t</span></a> *fd</code></em>);</pre>
487 </div>
488 <hr>
489 <div class="refsect2">
490 <a name="prelude-connection-set-state"></a><h3>prelude_connection_set_state ()</h3>
491 <pre class="programlisting"><span class="returnvalue">void</span>
492 prelude_connection_set_state (<em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> *cnx</code></em>,
493 <em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-state-t" title="enum prelude_connection_state_t"><span class="type">prelude_connection_state_t</span></a> state</code></em>);</pre>
494 </div>
495 <hr>
496 <div class="refsect2">
497 <a name="prelude-connection-get-state"></a><h3>prelude_connection_get_state ()</h3>
498 <pre class="programlisting"><a class="link" href="libprelude-prelude-connection.html#prelude-connection-state-t" title="enum prelude_connection_state_t"><span class="returnvalue">prelude_connection_state_t</span></a>
499 prelude_connection_get_state (<em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> *cnx</code></em>);</pre>
500 </div>
501 <hr>
502 <div class="refsect2">
503 <a name="prelude-connection-set-data"></a><h3>prelude_connection_set_data ()</h3>
504 <pre class="programlisting"><span class="returnvalue">void</span>
505 prelude_connection_set_data (<em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> *cnx</code></em>,
506 <em class="parameter"><code><span class="type">void</span> *data</code></em>);</pre>
507 </div>
508 <hr>
509 <div class="refsect2">
510 <a name="prelude-connection-get-data"></a><h3>prelude_connection_get_data ()</h3>
511 <pre class="programlisting"><span class="returnvalue">void</span> *
512 prelude_connection_get_data (<em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> *cnx</code></em>);</pre>
513 </div>
514 <hr>
515 <div class="refsect2">
516 <a name="prelude-connection-get-default-socket-filename"></a><h3>prelude_connection_get_default_socket_filename ()</h3>
517 <pre class="programlisting">const <span class="returnvalue">char</span> *
518 prelude_connection_get_default_socket_filename
519 (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
520 </div>
521 <hr>
522 <div class="refsect2">
523 <a name="prelude-connection-get-permission"></a><h3>prelude_connection_get_permission ()</h3>
524 <pre class="programlisting"><a class="link" href="libprelude-prelude-connection.html#prelude-connection-permission-t" title="enum prelude_connection_permission_t"><span class="returnvalue">prelude_connection_permission_t</span></a>
525 prelude_connection_get_permission (<em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> *conn</code></em>);</pre>
526 </div>
527 <hr>
528 <div class="refsect2">
529 <a name="prelude-connection-get-peer-analyzerid"></a><h3>prelude_connection_get_peer_analyzerid ()</h3>
530 <pre class="programlisting"><a class="link" href="libprelude-prelude-inttypes.html#uint64-t" title="uint64_t"><span class="returnvalue">uint64_t</span></a>
531 prelude_connection_get_peer_analyzerid
532 (<em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> *cnx</code></em>);</pre>
533 </div>
534 <hr>
535 <div class="refsect2">
536 <a name="prelude-connection-set-peer-analyzerid"></a><h3>prelude_connection_set_peer_analyzerid ()</h3>
537 <pre class="programlisting"><span class="returnvalue">void</span>
538 prelude_connection_set_peer_analyzerid
539 (<em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> *cnx</code></em>,
540 <em class="parameter"><code><a class="link" href="libprelude-prelude-inttypes.html#uint64-t" title="uint64_t"><span class="type">uint64_t</span></a> analyzerid</code></em>);</pre>
541 </div>
542 <hr>
543 <div class="refsect2">
544 <a name="prelude-connection-new"></a><h3>prelude_connection_new ()</h3>
545 <pre class="programlisting"><span class="returnvalue">int</span>
546 prelude_connection_new (<em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> **ret</code></em>,
547 <em class="parameter"><code>const <span class="type">char</span> *addr</code></em>);</pre>
548 </div>
549 <hr>
550 <div class="refsect2">
551 <a name="prelude-connection-ref"></a><h3>prelude_connection_ref ()</h3>
552 <pre class="programlisting"><a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="returnvalue">prelude_connection_t</span></a> *
553 prelude_connection_ref (<em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> *conn</code></em>);</pre>
554 <p>Increases <em class="parameter"><code>conn</code></em>
555 reference count.</p>
556 <p>prelude_connection_destroy() will decrease the refcount until it
557 reaches 0, at which point <em class="parameter"><code>conn</code></em>
558 will be destroyed.</p>
559 <div class="refsect3">
560 <a name="prelude-connection-ref.parameters"></a><h4>Parameters</h4>
561 <div class="informaltable"><table width="100%" border="0">
562 <colgroup>
563 <col width="150px" class="parameters_name">
564 <col class="parameters_description">
565 <col width="200px" class="parameters_annotations">
566 </colgroup>
567 <tbody><tr>
568 <td class="parameter_name"><p>conn</p></td>
569 <td class="parameter_description"><p>Pointer to a <a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> object to reference.</p></td>
570 <td class="parameter_annotations"> </td>
571 </tr></tbody>
572 </table></div>
573 </div>
574 <div class="refsect3">
575 <a name="prelude-connection-ref.returns"></a><h4>Returns</h4>
576 <p> <em class="parameter"><code>conn</code></em>
577 .</p>
578 </div>
579 </div>
580 <hr>
581 <div class="refsect2">
582 <a name="prelude-connection-new-msgbuf"></a><h3>prelude_connection_new_msgbuf ()</h3>
583 <pre class="programlisting"><span class="returnvalue">int</span>
584 prelude_connection_new_msgbuf (<em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-t" title="prelude_connection_t"><span class="type">prelude_connection_t</span></a> *connection</code></em>,
585 <em class="parameter"><code><a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-t" title="prelude_msgbuf_t"><span class="type">prelude_msgbuf_t</span></a> **msgbuf</code></em>);</pre>
586 </div>
587 <hr>
588 <div class="refsect2">
589 <a name="prelude-connection-permission-to-string"></a><h3>prelude_connection_permission_to_string ()</h3>
590 <pre class="programlisting"><span class="returnvalue">int</span>
591 prelude_connection_permission_to_string
592 (<em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-permission-t" title="enum prelude_connection_permission_t"><span class="type">prelude_connection_permission_t</span></a> perm</code></em>,
593 <em class="parameter"><code><a class="link" href="libprelude-prelude-string.html#prelude-string-t" title="prelude_string_t"><span class="type">prelude_string_t</span></a> *out</code></em>);</pre>
594 </div>
595 <hr>
596 <div class="refsect2">
597 <a name="prelude-connection-permission-new-from-string"></a><h3>prelude_connection_permission_new_from_string ()</h3>
598 <pre class="programlisting"><span class="returnvalue">int</span>
599 prelude_connection_permission_new_from_string
600 (<em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-permission-t" title="enum prelude_connection_permission_t"><span class="type">prelude_connection_permission_t</span></a> *out</code></em>,
601 <em class="parameter"><code>const <span class="type">char</span> *buf</code></em>);</pre>
602 </div>
603 </div>
604 <div class="refsect1">
605 <a name="libprelude-prelude-connection.other_details"></a><h2>Types and Values</h2>
606 <div class="refsect2">
607 <a name="prelude-connection-permission-t"></a><h3>enum prelude_connection_permission_t</h3>
608 <div class="refsect3">
609 <a name="prelude-connection-permission-t.members"></a><h4>Members</h4>
610 <div class="informaltable"><table width="100%" border="0">
611 <colgroup>
612 <col width="300px" class="enum_members_name">
613 <col class="enum_members_description">
614 <col width="200px" class="enum_members_annotations">
615 </colgroup>
616 <tbody>
617 <tr>
618 <td class="enum_member_name"><p><a name="PRELUDE-CONNECTION-PERMISSION-IDMEF-READ:CAPS"></a>PRELUDE_CONNECTION_PERMISSION_IDMEF_READ</p></td>
619 <td> </td>
620 <td> </td>
621 </tr>
622 <tr>
623 <td class="enum_member_name"><p><a name="PRELUDE-CONNECTION-PERMISSION-ADMIN-READ:CAPS"></a>PRELUDE_CONNECTION_PERMISSION_ADMIN_READ</p></td>
624 <td> </td>
625 <td> </td>
626 </tr>
627 <tr>
628 <td class="enum_member_name"><p><a name="PRELUDE-CONNECTION-PERMISSION-IDMEF-WRITE:CAPS"></a>PRELUDE_CONNECTION_PERMISSION_IDMEF_WRITE</p></td>
629 <td> </td>
630 <td> </td>
631 </tr>
632 <tr>
633 <td class="enum_member_name"><p><a name="PRELUDE-CONNECTION-PERMISSION-ADMIN-WRITE:CAPS"></a>PRELUDE_CONNECTION_PERMISSION_ADMIN_WRITE</p></td>
634 <td> </td>
635 <td> </td>
636 </tr>
637 </tbody>
638 </table></div>
639 </div>
640 </div>
641 <hr>
642 <div class="refsect2">
643 <a name="prelude-connection-state-t"></a><h3>enum prelude_connection_state_t</h3>
644 <div class="refsect3">
645 <a name="prelude-connection-state-t.members"></a><h4>Members</h4>
646 <div class="informaltable"><table width="100%" border="0">
647 <colgroup>
648 <col width="300px" class="enum_members_name">
649 <col class="enum_members_description">
650 <col width="200px" class="enum_members_annotations">
651 </colgroup>
652 <tbody><tr>
653 <td class="enum_member_name"><p><a name="PRELUDE-CONNECTION-STATE-ESTABLISHED:CAPS"></a>PRELUDE_CONNECTION_STATE_ESTABLISHED</p></td>
654 <td> </td>
655 <td> </td>
656 </tr></tbody>
657 </table></div>
658 </div>
659 </div>
660 <hr>
661 <div class="refsect2">
662 <a name="prelude-connection-t"></a><h3>prelude_connection_t</h3>
663 <pre class="programlisting">typedef struct prelude_connection prelude_connection_t;
664 </pre>
665 </div>
666 </div>
667 </div>
668 <div class="footer">
669 <hr>Generated by GTK-Doc V1.28</div>
670 </body>
671 </html>