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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
|
<?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="libprelude-idmef-time">
<refmeta>
<refentrytitle id="top_of_page">idmef-time</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBPRELUDE Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>idmef-time</refname>
<refpurpose>
Time representation in IDMEF message</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="synopsis">
<title id="synopsis.title">Synopsis</title>
<synopsis>
struct <link linkend="idmef-time">idmef_time</link>;
typedef <link linkend="idmef-time-t">idmef_time_t</link>;
<link linkend="idmef-time-t">idmef_time_t</link>* <link linkend="idmef-time-ref">idmef_time_ref</link> (<link linkend="idmef-time-t">idmef_time_t</link> *time);
<link linkend="int">int</link> <link linkend="idmef-time-new">idmef_time_new</link> (<link linkend="idmef-time-t">idmef_time_t</link> **time);
<link linkend="int">int</link> <link linkend="idmef-time-new-from-time">idmef_time_new_from_time</link> (<link linkend="idmef-time-t">idmef_time_t</link> **time,
const <link linkend="time-t">time_t</link> *t);
<link linkend="int">int</link> <link linkend="idmef-time-new-from-gettimeofday">idmef_time_new_from_gettimeofday</link>
(<link linkend="idmef-time-t">idmef_time_t</link> **time);
<link linkend="int">int</link> <link linkend="idmef-time-new-from-string">idmef_time_new_from_string</link> (<link linkend="idmef-time-t">idmef_time_t</link> **time,
const <link linkend="char">char</link> *buf);
<link linkend="int">int</link> <link linkend="idmef-time-new-from-ntpstamp">idmef_time_new_from_ntpstamp</link> (<link linkend="idmef-time-t">idmef_time_t</link> **time,
const <link linkend="char">char</link> *buf);
<link linkend="int">int</link> <link linkend="idmef-time-new-from-timeval">idmef_time_new_from_timeval</link> (<link linkend="idmef-time-t">idmef_time_t</link> **time,
const struct <link linkend="timeval">timeval</link> *tv);
<link linkend="void">void</link> <link linkend="idmef-time-set-from-time">idmef_time_set_from_time</link> (<link linkend="idmef-time-t">idmef_time_t</link> *time,
const <link linkend="time-t">time_t</link> *t);
<link linkend="int">int</link> <link linkend="idmef-time-set-from-gettimeofday">idmef_time_set_from_gettimeofday</link>
(<link linkend="idmef-time-t">idmef_time_t</link> *time);
<link linkend="int">int</link> <link linkend="idmef-time-set-from-string">idmef_time_set_from_string</link> (<link linkend="idmef-time-t">idmef_time_t</link> *time,
const <link linkend="char">char</link> *buf);
<link linkend="int">int</link> <link linkend="idmef-time-set-from-ntpstamp">idmef_time_set_from_ntpstamp</link> (<link linkend="idmef-time-t">idmef_time_t</link> *time,
const <link linkend="char">char</link> *buf);
<link linkend="int">int</link> <link linkend="idmef-time-set-from-timeval">idmef_time_set_from_timeval</link> (<link linkend="idmef-time-t">idmef_time_t</link> *time,
const struct <link linkend="timeval">timeval</link> *tv);
<link linkend="void">void</link> <link linkend="idmef-time-destroy-internal">idmef_time_destroy_internal</link> (<link linkend="idmef-time-t">idmef_time_t</link> *time);
<link linkend="void">void</link> <link linkend="idmef-time-destroy">idmef_time_destroy</link> (<link linkend="idmef-time-t">idmef_time_t</link> *time);
<link linkend="int">int</link> <link linkend="idmef-time-clone">idmef_time_clone</link> (const <link linkend="idmef-time-t">idmef_time_t</link> *src,
<link linkend="idmef-time-t">idmef_time_t</link> **dst);
<link linkend="int">int</link> <link linkend="idmef-time-copy">idmef_time_copy</link> (const <link linkend="idmef-time-t">idmef_time_t</link> *src,
<link linkend="idmef-time-t">idmef_time_t</link> *dst);
<link linkend="void">void</link> <link linkend="idmef-time-set-sec">idmef_time_set_sec</link> (<link linkend="idmef-time-t">idmef_time_t</link> *time,
<link linkend="uint32-t">uint32_t</link> sec);
<link linkend="void">void</link> <link linkend="idmef-time-set-usec">idmef_time_set_usec</link> (<link linkend="idmef-time-t">idmef_time_t</link> *time,
<link linkend="uint32-t">uint32_t</link> usec);
<link linkend="void">void</link> <link linkend="idmef-time-set-gmt-offset">idmef_time_set_gmt_offset</link> (<link linkend="idmef-time-t">idmef_time_t</link> *time,
<link linkend="int32-t">int32_t</link> gmtoff);
<link linkend="uint32-t">uint32_t</link> <link linkend="idmef-time-get-sec">idmef_time_get_sec</link> (const <link linkend="idmef-time-t">idmef_time_t</link> *time);
<link linkend="uint32-t">uint32_t</link> <link linkend="idmef-time-get-usec">idmef_time_get_usec</link> (const <link linkend="idmef-time-t">idmef_time_t</link> *time);
<link linkend="int32-t">int32_t</link> <link linkend="idmef-time-get-gmt-offset">idmef_time_get_gmt_offset</link> (const <link linkend="idmef-time-t">idmef_time_t</link> *time);
<link linkend="int">int</link> <link linkend="idmef-time-to-string">idmef_time_to_string</link> (const <link linkend="idmef-time-t">idmef_time_t</link> *time,
<link linkend="prelude-string-t">prelude_string_t</link> *out);
<link linkend="int">int</link> <link linkend="idmef-time-to-ntpstamp">idmef_time_to_ntpstamp</link> (const <link linkend="idmef-time-t">idmef_time_t</link> *time,
<link linkend="prelude-string-t">prelude_string_t</link> *out);
</synopsis>
</refsynopsisdiv>
<refsect1 id="desc">
<title id="desc.title">Description</title>
<para>
The <link linkend="idmef-time-t"><type>idmef_time_t</type></link> type is used in order to represent a time value in
an IDMEF message. This object contain information such as the number
of seconds since the Epoch, the local GMT offset, the number of micro second (if applicable).
</para>
<para>
When creating an IDMEF message, you need to insert a timestamp in it.
IDMEF provide differents time field to be used for this:
<itemizedlist>
<listitem>AnalyzerTime<para>The AnalyzerTime class is used to indicate the current date and time
on the analyzer. Its values should be filled in as late as possible in the message transmission
process, ideally immediately before placing the message "on the wire."</para></listitem>
<listitem>CreateTime<para>The CreateTime class is used to indicate the date and time the alert
or heartbeat was created by the analyzer.</para></listitem>
<listitem>DetectTime<para>The DetectTime class is used to indicate the date and time the
event(s) producing an alert was detected by the analyzer. In the case of more than one event,
the time the first event was detected. (This may or may not be the same time as CreateTime;
analyzers are not required to send alerts immediately upon detection).</para></listitem>
</itemizedlist>
You don't need to take care of the AnalyzerTime field, since in Prelude, once an events
is handed to the library, and if the sending of the message fail, there will be a fallback
to backuping the event for later retransmission.
Thus the library has to take care of setting the AnalyzerTime for you (since the message might
not be emited immediatly in this specific case.
</para>
<para>
Several helper are available in order to create <link linkend="idmef-time-t"><type>idmef_time_t</type></link> object. Most probably, the function
that you will need are the one bellow:
<itemizedlist>
<listitem><link linkend="idmef-time-new-from-gettimeofday"><function>idmef_time_new_from_gettimeofday()</function></link> and <link linkend="idmef-time-set-from-gettimeofday"><function>idmef_time_set_from_gettimeofday()</function></link></listitem>
<listitem><link linkend="idmef-time-new-from-timeval"><function>idmef_time_new_from_timeval()</function></link> and <link linkend="idmef-time-set-from-timeval"><function>idmef_time_set_from_timeval()</function></link></listitem>
<listitem><link linkend="idmef-time-new-from-time"><function>idmef_time_new_from_time()</function></link> and <link linkend="idmef-time-set-from-time"><function>idmef_time_set_from_time()</function></link></listitem>
<listitem><link linkend="idmef-time-new-from-string"><function>idmef_time_new_from_string()</function></link> and <link linkend="idmef-time-set-from-string"><function>idmef_time_set_from_string()</function></link></listitem>
</itemizedlist>
</para>
</refsect1>
<refsect1 id="details">
<title id="details.title">Details</title>
<refsect2>
<title><anchor id="idmef-time" role="struct"/>struct idmef_time</title>
<indexterm><primary>idmef_time</primary></indexterm><programlisting>struct idmef_time {
};
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="idmef-time-t" role="typedef"/>idmef_time_t</title>
<indexterm><primary>idmef_time_t</primary></indexterm><programlisting>typedef struct idmef_time idmef_time_t;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="idmef-time-ref" role="function"/>idmef_time_ref ()</title>
<indexterm><primary>idmef_time_ref</primary></indexterm><programlisting><link linkend="idmef-time-t">idmef_time_t</link>* idmef_time_ref (<link linkend="idmef-time-t">idmef_time_t</link> *time);</programlisting>
<para>
Increases <parameter>time</parameter> reference count.
<link linkend="idmef-time-destroy"><function>idmef_time_destroy()</function></link> won't destroy <parameter>time</parameter> until the refcount
reach 0.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> Pointer to an <link linkend="idmef-time-t"><type>idmef_time_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The <parameter>time</parameter> provided argument.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="idmef-time-new" role="function"/>idmef_time_new ()</title>
<indexterm><primary>idmef_time_new</primary></indexterm><programlisting><link linkend="int">int</link> idmef_time_new (<link linkend="idmef-time-t">idmef_time_t</link> **time);</programlisting>
<para>
Creates an empty <link linkend="idmef-time-t"><type>idmef_time_t</type></link> object and store it in <parameter>time</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> Address where to store the created <link linkend="idmef-time-t"><type>idmef_time_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> 0 on success, a negative value if an error occured.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="idmef-time-new-from-time" role="function"/>idmef_time_new_from_time ()</title>
<indexterm><primary>idmef_time_new_from_time</primary></indexterm><programlisting><link linkend="int">int</link> idmef_time_new_from_time (<link linkend="idmef-time-t">idmef_time_t</link> **time,
const <link linkend="time-t">time_t</link> *t);</programlisting>
<para>
Creates a new <link linkend="idmef-time-t"><type>idmef_time_t</type></link> object and store it in <parameter>time</parameter>.
This object will be filled with information available in <parameter>t</parameter>. The created
<parameter>time</parameter> won't contain micro seconds information, since theses are not
available within <parameter>t</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> Address where to store the created <link linkend="idmef-time-t"><type>idmef_time_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>t</parameter> :</term>
<listitem><simpara> Pointer to a time_t.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> 0 on success, a negative value if an error occured.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="idmef-time-new-from-gettimeofday" role="function"/>idmef_time_new_from_gettimeofday ()</title>
<indexterm><primary>idmef_time_new_from_gettimeofday</primary></indexterm><programlisting><link linkend="int">int</link> idmef_time_new_from_gettimeofday
(<link linkend="idmef-time-t">idmef_time_t</link> **time);</programlisting>
<para>
Creates an <link linkend="idmef-time-t"><type>idmef_time_t</type></link> object filled with information retrieved
using <link linkend="gettimeofday"><function>gettimeofday()</function></link>, and stores it in <parameter>time</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> Address where to store the created <link linkend="idmef-time-t"><type>idmef_time_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> 0 on success, a negative value if an error occured.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="idmef-time-new-from-string" role="function"/>idmef_time_new_from_string ()</title>
<indexterm><primary>idmef_time_new_from_string</primary></indexterm><programlisting><link linkend="int">int</link> idmef_time_new_from_string (<link linkend="idmef-time-t">idmef_time_t</link> **time,
const <link linkend="char">char</link> *buf);</programlisting>
<para>
Creates an <link linkend="idmef-time-t"><type>idmef_time_t</type></link> object filled with information retrieved
from the user provided <parameter>buf</parameter>, containing a string describing a time in a format
conforming to the IDMEF definition (v. 0.10, section 3.2.6).
</para>
<para>
Additionally, the provided time might be separated with white spaces, instead
of the IDMEF define 'T' character. The format might not specify a timezone
(will assume UTC in this case).
</para>
<para>
The resulting <link linkend="idmef-time-t"><type>idmef_time_t</type></link> object is stored in <parameter>time</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> Address where to store the created <link linkend="idmef-time-t"><type>idmef_time_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>buf</parameter> :</term>
<listitem><simpara> Pointer to a string describing a time in an IDMEF conforming format.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> 0 on success, a negative value if an error occured.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="idmef-time-new-from-ntpstamp" role="function"/>idmef_time_new_from_ntpstamp ()</title>
<indexterm><primary>idmef_time_new_from_ntpstamp</primary></indexterm><programlisting><link linkend="int">int</link> idmef_time_new_from_ntpstamp (<link linkend="idmef-time-t">idmef_time_t</link> **time,
const <link linkend="char">char</link> *buf);</programlisting>
<para>
Creates an <link linkend="idmef-time-t"><type>idmef_time_t</type></link> object filled with information provided
from the <parameter>buf</parameter> NTP timestamp, and stores it in <parameter>time</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> Address where to store the created <link linkend="idmef-time-t"><type>idmef_time_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>buf</parameter> :</term>
<listitem><simpara> Pointer to a string containing an NTP timestamp.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> 0 on success, a negative value if an error occured.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="idmef-time-new-from-timeval" role="function"/>idmef_time_new_from_timeval ()</title>
<indexterm><primary>idmef_time_new_from_timeval</primary></indexterm><programlisting><link linkend="int">int</link> idmef_time_new_from_timeval (<link linkend="idmef-time-t">idmef_time_t</link> **time,
const struct <link linkend="timeval">timeval</link> *tv);</programlisting>
<para>
Creates an <link linkend="idmef-time-t"><type>idmef_time_t</type></link> object filled with information provided
within the <parameter>tv</parameter> structure.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> Address where to store the created <link linkend="idmef-time-t"><type>idmef_time_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tv</parameter> :</term>
<listitem><simpara> Pointer to a struct timeval (see <link linkend="gettimeofday"><function>gettimeofday()</function></link>).
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> 0 on success, a negative value if an error occured.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="idmef-time-set-from-time" role="function"/>idmef_time_set_from_time ()</title>
<indexterm><primary>idmef_time_set_from_time</primary></indexterm><programlisting><link linkend="void">void</link> idmef_time_set_from_time (<link linkend="idmef-time-t">idmef_time_t</link> *time,
const <link linkend="time-t">time_t</link> *t);</programlisting>
<para>
Fills <parameter>time</parameter> from the information described by <parameter>t</parameter>.
<parameter>time</parameter> won't contain micro seconds information, since theses are not
available within <parameter>t</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> Pointer to an <link linkend="idmef-time-t"><type>idmef_time_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>t</parameter> :</term>
<listitem><simpara> Pointer to a time_t.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="idmef-time-set-from-gettimeofday" role="function"/>idmef_time_set_from_gettimeofday ()</title>
<indexterm><primary>idmef_time_set_from_gettimeofday</primary></indexterm><programlisting><link linkend="int">int</link> idmef_time_set_from_gettimeofday
(<link linkend="idmef-time-t">idmef_time_t</link> *time);</programlisting>
<para>
Fills <parameter>time</parameter> with information retrieved using <link linkend="gettimeofday"><function>gettimeofday()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> Pointer to an <link linkend="idmef-time-t"><type>idmef_time_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> 0 on success, a negative value if an error occured.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="idmef-time-set-from-string" role="function"/>idmef_time_set_from_string ()</title>
<indexterm><primary>idmef_time_set_from_string</primary></indexterm><programlisting><link linkend="int">int</link> idmef_time_set_from_string (<link linkend="idmef-time-t">idmef_time_t</link> *time,
const <link linkend="char">char</link> *buf);</programlisting>
<para>
Fills <parameter>time</parameter> object with information retrieved from the user provided
<parameter>buf</parameter>, containing a string describing a time in a format conforming
to the IDMEF definition (v. 0.10, section 3.2.6).
</para>
<para>
Additionally, the provided time might be separated with white spaces, instead
of the IDMEF define 'T' character. The format might not specify a timezone
(will assume UTC in this case).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> Pointer to an <link linkend="idmef-time-t"><type>idmef_time_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>buf</parameter> :</term>
<listitem><simpara> Pointer to a string describing a time in an IDMEF conforming format.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> 0 on success, a negative value if an error occured.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="idmef-time-set-from-ntpstamp" role="function"/>idmef_time_set_from_ntpstamp ()</title>
<indexterm><primary>idmef_time_set_from_ntpstamp</primary></indexterm><programlisting><link linkend="int">int</link> idmef_time_set_from_ntpstamp (<link linkend="idmef-time-t">idmef_time_t</link> *time,
const <link linkend="char">char</link> *buf);</programlisting>
<para>
Fills the <parameter>time</parameter> object with information provided within the <parameter>buf</parameter> NTP timestamp.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="idmef-time-t"><type>idmef_time_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>buf</parameter> :</term>
<listitem><simpara> Pointer to a string containing an NTP timestamp.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> 0 on success, a negative value if an error occured.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="idmef-time-set-from-timeval" role="function"/>idmef_time_set_from_timeval ()</title>
<indexterm><primary>idmef_time_set_from_timeval</primary></indexterm><programlisting><link linkend="int">int</link> idmef_time_set_from_timeval (<link linkend="idmef-time-t">idmef_time_t</link> *time,
const struct <link linkend="timeval">timeval</link> *tv);</programlisting>
<para>
Fills <parameter>time</parameter> object filled with information provided within the <parameter>tv</parameter> structure.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> Pointer to an <link linkend="idmef-time-t"><type>idmef_time_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tv</parameter> :</term>
<listitem><simpara> Pointer to a struct timeval (see <link linkend="gettimeofday"><function>gettimeofday()</function></link>).
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> 0 on success, a negative value if an error occured.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="idmef-time-destroy-internal" role="function"/>idmef_time_destroy_internal ()</title>
<indexterm><primary>idmef_time_destroy_internal</primary></indexterm><programlisting><link linkend="void">void</link> idmef_time_destroy_internal (<link linkend="idmef-time-t">idmef_time_t</link> *time);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="idmef-time-destroy" role="function"/>idmef_time_destroy ()</title>
<indexterm><primary>idmef_time_destroy</primary></indexterm><programlisting><link linkend="void">void</link> idmef_time_destroy (<link linkend="idmef-time-t">idmef_time_t</link> *time);</programlisting>
<para>
Destroys <parameter>time</parameter> if refcount reach 0.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> Pointer to an <link linkend="idmef-time-t"><type>idmef_time_t</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="idmef-time-clone" role="function"/>idmef_time_clone ()</title>
<indexterm><primary>idmef_time_clone</primary></indexterm><programlisting><link linkend="int">int</link> idmef_time_clone (const <link linkend="idmef-time-t">idmef_time_t</link> *src,
<link linkend="idmef-time-t">idmef_time_t</link> **dst);</programlisting>
<para>
Clones <parameter>src</parameter> and stores the result in the <parameter>dst</parameter> address.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>src</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="idmef-time-t"><type>idmef_time_t</type></link> to clone.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dst</parameter> :</term>
<listitem><simpara> Address where to store the cloned <parameter>src</parameter> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> 0 on success, a negative value if an error occured.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="idmef-time-copy" role="function"/>idmef_time_copy ()</title>
<indexterm><primary>idmef_time_copy</primary></indexterm><programlisting><link linkend="int">int</link> idmef_time_copy (const <link linkend="idmef-time-t">idmef_time_t</link> *src,
<link linkend="idmef-time-t">idmef_time_t</link> *dst);</programlisting>
<para>
Copies <parameter>src</parameter> internal to <parameter>dst</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>src</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="idmef-time-t"><type>idmef_time_t</type></link> to copy data from.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dst</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="idmef-time-t"><type>idmef_time_t</type></link> to copy data to.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> 0 on success, a negative value if an error occured.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="idmef-time-set-sec" role="function"/>idmef_time_set_sec ()</title>
<indexterm><primary>idmef_time_set_sec</primary></indexterm><programlisting><link linkend="void">void</link> idmef_time_set_sec (<link linkend="idmef-time-t">idmef_time_t</link> *time,
<link linkend="uint32-t">uint32_t</link> sec);</programlisting>
<para>
Sets the number of second from the Epoch to <parameter>sec</parameter> within <parameter>time</parameter>.
</para>
<para>
WARNING: this is just an accessor function, and using it to
set <parameter>time</parameter> current time also requires the use of <link linkend="idmef-time-set-usec"><function>idmef_time_set_usec()</function></link>
and <link linkend="idmef-time-set-gmt-offset"><function>idmef_time_set_gmt_offset()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="idmef-time-t"><type>idmef_time_t</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>sec</parameter> :</term>
<listitem><simpara> Number of seconds since the Epoch.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="idmef-time-set-usec" role="function"/>idmef_time_set_usec ()</title>
<indexterm><primary>idmef_time_set_usec</primary></indexterm><programlisting><link linkend="void">void</link> idmef_time_set_usec (<link linkend="idmef-time-t">idmef_time_t</link> *time,
<link linkend="uint32-t">uint32_t</link> usec);</programlisting>
<para>
Sets the number of micro second to <parameter>usec</parameter> within <parameter>time</parameter>.
</para>
<para>
WARNING: this is just an accessor function, and using it to
set <parameter>time</parameter> current time also requires the use of <link linkend="idmef-time-set-sec"><function>idmef_time_set_sec()</function></link>
and <link linkend="idmef-time-set-gmt-offset"><function>idmef_time_set_gmt_offset()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="idmef-time-t"><type>idmef_time_t</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>usec</parameter> :</term>
<listitem><simpara> Number of micro seconds to set within <parameter>time</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="idmef-time-set-gmt-offset" role="function"/>idmef_time_set_gmt_offset ()</title>
<indexterm><primary>idmef_time_set_gmt_offset</primary></indexterm><programlisting><link linkend="void">void</link> idmef_time_set_gmt_offset (<link linkend="idmef-time-t">idmef_time_t</link> *time,
<link linkend="int32-t">int32_t</link> gmtoff);</programlisting>
<para>
Sets the GMT offset <parameter>gmtoff</parameter>, in seconds, within <parameter>time</parameter>.
</para>
<para>
WARNING: this is just an accessor function, and using it to
set <parameter>time</parameter> current time also requires the use of <link linkend="idmef-time-set-sec"><function>idmef_time_set_sec()</function></link>
and <link linkend="idmef-time-set-usec"><function>idmef_time_set_usec()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="idmef-time-t"><type>idmef_time_t</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>gmtoff</parameter> :</term>
<listitem><simpara> GMT offset for <parameter>time</parameter>, in seconds.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="idmef-time-get-sec" role="function"/>idmef_time_get_sec ()</title>
<indexterm><primary>idmef_time_get_sec</primary></indexterm><programlisting><link linkend="uint32-t">uint32_t</link> idmef_time_get_sec (const <link linkend="idmef-time-t">idmef_time_t</link> *time);</programlisting>
<para>
Returns the number of second since the Epoch (00:00:00 UTC, January 1, 1970),
previously set within <parameter>time</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="idmef-time-t"><type>idmef_time_t</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The number of seconds.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="idmef-time-get-usec" role="function"/>idmef_time_get_usec ()</title>
<indexterm><primary>idmef_time_get_usec</primary></indexterm><programlisting><link linkend="uint32-t">uint32_t</link> idmef_time_get_usec (const <link linkend="idmef-time-t">idmef_time_t</link> *time);</programlisting>
<para>
Returns the u-second member of <parameter>time</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="idmef-time-t"><type>idmef_time_t</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The number of u-seconds.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="idmef-time-get-gmt-offset" role="function"/>idmef_time_get_gmt_offset ()</title>
<indexterm><primary>idmef_time_get_gmt_offset</primary></indexterm><programlisting><link linkend="int32-t">int32_t</link> idmef_time_get_gmt_offset (const <link linkend="idmef-time-t">idmef_time_t</link> *time);</programlisting>
<para>
Returns the GMT offset that applies to <parameter>time</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="idmef-time-t"><type>idmef_time_t</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The GMT offset, in seconds.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="idmef-time-to-string" role="function"/>idmef_time_to_string ()</title>
<indexterm><primary>idmef_time_to_string</primary></indexterm><programlisting><link linkend="int">int</link> idmef_time_to_string (const <link linkend="idmef-time-t">idmef_time_t</link> *time,
<link linkend="prelude-string-t">prelude_string_t</link> *out);</programlisting>
<para>
Translates <parameter>time</parameter> to an user readable string conforming to the IDMEF
defined time format.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> Pointer to an IDMEF time structure.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>out</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-string-t"><type>prelude_string_t</type></link> output buffer.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> number of bytes written on success, a negative value if an error occured.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="idmef-time-to-ntpstamp" role="function"/>idmef_time_to_ntpstamp ()</title>
<indexterm><primary>idmef_time_to_ntpstamp</primary></indexterm><programlisting><link linkend="int">int</link> idmef_time_to_ntpstamp (const <link linkend="idmef-time-t">idmef_time_t</link> *time,
<link linkend="prelude-string-t">prelude_string_t</link> *out);</programlisting>
<para>
Translates <parameter>time</parameter> to an user readable NTP timestamp string,
conforming to the IDMEF defined time format.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> Pointer to an IDMEF time structure.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>out</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-string-t"><type>prelude_string_t</type></link> output buffer.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> number of bytes written on success, a negative value if an error occured.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
