1 #ifndef _BABELTRACE_ITERATOR_H
2 #define _BABELTRACE_ITERATOR_H
5 * BabelTrace API Iterators
7 * Copyright 2010-2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
9 * Permission is hereby granted, free of charge, to any person obtaining a copy
10 * of this software and associated documentation files (the "Software"), to deal
11 * in the Software without restriction, including without limitation the rights
12 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 * copies of the Software, and to permit persons to whom the Software is
14 * furnished to do so, subject to the following conditions:
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
20 #include <babeltrace/format.h>
21 #include <babeltrace/context.h>
23 /* Forward declarations */
25 struct ctf_stream_event
;
31 BT_SEEK_TIME
, /* uses u.seek_time */
32 BT_SEEK_RESTORE
, /* uses u.restore */
39 struct bt_saved_pos
*restore
;
44 * bt_iter_create - Allocate a trace collection iterator.
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
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.
55 struct bt_iter
*bt_iter_create(struct bt_context
*ctx
,
56 struct bt_iter_pos
*begin_pos
,
57 struct bt_iter_pos
*end_pos
);
60 * bt_iter_destroy - Free a trace collection iterator.
62 void bt_iter_destroy(struct bt_iter
*iter
);
65 * bt_iter_next: Move trace collection position to the next event.
67 * Returns 0 on success, a negative value on error
69 int bt_iter_next(struct bt_iter
*iter
);
72 * bt_iter_get_pos - Get the current iterator position.
74 * The position returned by this function needs to be freed by
75 * bt_iter_free_pos after use.
78 bt_iter_get_pos(struct bt_iter
*iter
);
81 * bt_iter_free_pos - Free the position.
83 void bt_iter_free_pos(struct bt_iter_pos
*pos
);
86 * bt_iter_set_pos: move the iterator to a given position.
88 * On error, the stream_heap is reinitialized and returned empty.
90 * Return 0 for success.
92 * Return EOF if the position requested is after the last event of the
94 * Return -EINVAL when called with invalid parameter.
95 * Return -ENOMEM if the stream_heap could not be properly initialized.
97 int bt_iter_set_pos(struct bt_iter
*iter
, const struct bt_iter_pos
*pos
);
100 * bt_iter_create_time_pos: create a position based on time
102 * This function allocates and returns a new bt_iter_pos (which must be freed
103 * with bt_iter_free_pos) to be able to restore an iterator position based on a
106 struct bt_iter_pos
*bt_iter_create_time_pos(struct bt_iter
*iter
,
109 #endif /* _BABELTRACE_ITERATOR_H */
This page took 0.035082 seconds and 5 git commands to generate.