Add missing permission notice in each source file
[babeltrace.git] / include / babeltrace / ctf / iterator.h
1 #ifndef _BABELTRACE_CTF_ITERATOR_H
2 #define _BABELTRACE_CTF_ITERATOR_H
3
4 /*
5 * BabelTrace
6 *
7 * CTF iterator API
8 *
9 * Copyright 2011-2012 EfficiOS Inc. and Linux Foundation
10 *
11 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
12 * Julien Desfossez <julien.desfossez@efficios.com>
13 *
14 * Permission is hereby granted, free of charge, to any person obtaining
15 * a copy of this software and associated documentation files (the
16 * "Software"), to deal in the Software without restriction, including
17 * without limitation the rights to use, copy, modify, merge, publish,
18 * distribute, sublicense, and/or sell copies of the Software, and to
19 * permit persons to whom the Software is furnished to do so, subject to
20 * the following conditions:
21 *
22 * The above copyright notice and this permission notice shall be
23 * included in all copies or substantial portions of the Software.
24 *
25 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
26 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
27 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
28 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
29 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
30 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31 * SOFTWARE.
32 */
33
34 #include <babeltrace/iterator.h>
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 struct bt_ctf_iter;
41 struct bt_ctf_event;
42
43 /*
44 * bt_ctf_iter_create - Allocate a CTF trace collection iterator.
45 *
46 * begin_pos and end_pos are optional parameters to specify the position
47 * at which the trace collection should be seeked upon iterator
48 * creation, and the position at which iteration will start returning
49 * "EOF".
50 *
51 * By default, if begin_pos is NULL, a BT_SEEK_CUR is performed at
52 * creation. By default, if end_pos is NULL, a BT_SEEK_END (end of
53 * trace) is the EOF criterion.
54 *
55 * Return a pointer to the newly allocated iterator.
56 *
57 * Only one iterator can be created against a context. If more than one
58 * iterator is being created for the same context, the second creation
59 * will return NULL. The previous iterator must be destroyed before
60 * creation of the new iterator for this function to succeed.
61 */
62 struct bt_ctf_iter *bt_ctf_iter_create(struct bt_context *ctx,
63 const struct bt_iter_pos *begin_pos,
64 const struct bt_iter_pos *end_pos);
65
66 /*
67 * bt_ctf_get_iter - get iterator from ctf iterator.
68 */
69 struct bt_iter *bt_ctf_get_iter(struct bt_ctf_iter *iter);
70
71 /*
72 * bt_ctf_iter_destroy - Free a CTF trace collection iterator.
73 */
74 void bt_ctf_iter_destroy(struct bt_ctf_iter *iter);
75
76 /*
77 * bt_ctf_iter_read_event: Read the iterator's current event data.
78 *
79 * @iter: trace collection iterator (input). Should NOT be NULL.
80 *
81 * Return current event on success, NULL on end of trace.
82 */
83 struct bt_ctf_event *bt_ctf_iter_read_event(struct bt_ctf_iter *iter);
84
85 /*
86 * bt_ctf_iter_read_event_flags: Read the iterator's current event data.
87 *
88 * @iter: trace collection iterator (input). Should NOT be NULL.
89 * @flags: pointer passed by the user, in which the trace reader populates
90 * flags on special condition (BT_ITER_FLAG_*).
91 *
92 * Return current event on success, NULL on end of trace.
93 */
94 struct bt_ctf_event *bt_ctf_iter_read_event_flags(struct bt_ctf_iter *iter,
95 int *flags);
96
97 /*
98 * bt_ctf_get_lost_events_count: returns the number of events discarded
99 * immediately prior to the last event read
100 *
101 * @iter: trace collection iterator (input). Should NOT be NULL.
102 *
103 * Return the number of lost events or -1ULL on error.
104 */
105 uint64_t bt_ctf_get_lost_events_count(struct bt_ctf_iter *iter);
106
107 #ifdef __cplusplus
108 }
109 #endif
110
111 #endif /* _BABELTRACE_CTF_ITERATOR_H */
This page took 0.044608 seconds and 4 git commands to generate.