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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>prelude</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
<link rel="start" href="index.html" title="Prelude library Reference Manual">
<link rel="up" href="pt01.html" title="Part I. Using libprelude to interoperate with prelude-manager">
<link rel="prev" href="pt01.html" title="Part I. Using libprelude to interoperate with prelude-manager">
<link rel="next" href="libprelude-prelude-client.html" title="prelude-client">
<meta name="generator" content="GTK-Doc V1.5 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="pt01.html" title="Part I. Using libprelude to interoperate with prelude-manager">
<link rel="part" href="pt02.html" title="Part II. Sending events with libprelude">
<link rel="chapter" href="ch01.html" title="The low level IDMEF API">
<link rel="chapter" href="ch02.html" title="The high level IDMEF API">
<link rel="part" href="pt03.html" title="Part III. Reading events from the collector">
<link rel="part" href="pt04.html" title="Part IV. Filtering operation on IDMEF messages">
<link rel="chapter" href="ch03.html" title="Utility functions">
<link rel="chapter" href="ch04.html" title="Others">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="pt01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="pt01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Prelude library Reference Manual</th>
<td><a accesskey="n" href="libprelude-prelude-client.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#top_of_page" class="shortcut">Top</a>
 | 
<a href="#desc" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libprelude-prelude"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="top_of_page"></a>prelude</span></h2>
<p>prelude —
Initializing the library</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#define <a href="libprelude-prelude.html#LIBPRELUDE-VERSION:CAPS">LIBPRELUDE_VERSION</a>
int <a href="libprelude-prelude.html#prelude-init">prelude_init</a> (int *argc,
char **argv);
void <a href="libprelude-prelude.html#prelude-deinit">prelude_deinit</a> (void);
const char* <a href="libprelude-prelude.html#prelude-check-version">prelude_check_version</a> (const char *req_version);
int <a href="libprelude-prelude.html#prelude-thread-init">prelude_thread_init</a> (void *future_use);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="desc"></a><h2>Description</h2>
<p>
Before any operation are done using the prelude library, the user first need
to initialize it using the <a href="libprelude-prelude.html#prelude-init"><tt class="function">prelude_init()</tt></a> function.
</p>
<pre class="programlisting">
int ret;
ret = prelude_init(&argc, argv);
if ( ret < 0 ) {
prelude_perror(ret, "unable to initialize the prelude library");
return -1;
}
</pre>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id255436"></a><h3>
<a name="LIBPRELUDE-VERSION:CAPS"></a>LIBPRELUDE_VERSION</h3>
<a class="indexterm" name="id240039"></a><pre class="programlisting">#define LIBPRELUDE_VERSION "0.9.7.2"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id240055"></a><h3>
<a name="prelude-init"></a>prelude_init ()</h3>
<a class="indexterm" name="id240067"></a><pre class="programlisting">int prelude_init (int *argc,
char **argv);</pre>
<p>
Call this function before using any other Prelude functions in your applications.
It will initialize everything needed to operate the library and parses some standard
command line options. <i class="parameter"><tt>argc</tt></i> and <i class="parameter"><tt>argv</tt></i> are adjusted accordingly so your own code will
never see those standard arguments.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><i class="parameter"><tt>argc</tt></i> :</span></td>
<td> Address of the argc parameter of your <tt class="function">main()</tt> function.
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>argv</tt></i> :</span></td>
<td> Address of the argv parameter of your <tt class="function">main()</tt> function.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> 0 on success, a negative value if an error occured.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id240178"></a><h3>
<a name="prelude-deinit"></a>prelude_deinit ()</h3>
<a class="indexterm" name="id240190"></a><pre class="programlisting">void prelude_deinit (void);</pre>
<p>
Call this function if you're done using the library and want to free global
shared ressource allocated by libprelude.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id240214"></a><h3>
<a name="prelude-check-version"></a>prelude_check_version ()</h3>
<a class="indexterm" name="id240226"></a><pre class="programlisting">const char* prelude_check_version (const char *req_version);</pre>
<p>
If <i class="parameter"><tt>req_version</tt></i> is NULL this function will return the version of the library.
Otherwise, <i class="parameter"><tt>req_version</tt></i> will be compared to the current library version. If
the library version is higher or equal, this function will return the current
library version. Otherwise, NULL is returned.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><i class="parameter"><tt>req_version</tt></i> :</span></td>
<td> The minimum acceptable version number.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The current library version, or NULL if <i class="parameter"><tt>req_version</tt></i> doesn't match.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id292124"></a><h3>
<a name="prelude-thread-init"></a>prelude_thread_init ()</h3>
<a class="indexterm" name="id292136"></a><pre class="programlisting">int prelude_thread_init (void *future_use);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><i class="parameter"><tt>future_use</tt></i> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>
|
