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 */
28 * bt_iter is an abstract class, each format has to implement its own
29 * iterator derived from this parent class.
35 * This structure represents the position where to set an iterator.
37 * type represents the type of seek to use.
38 * u is the argument of the seek if necessary :
39 * - seek_time is the real timestamp to seek to when using BT_SEEK_TIME, it
40 * is expressed in nanoseconds
41 * - restore is a position saved with bt_iter_get_pos, it is used with
46 BT_SEEK_TIME
, /* uses u.seek_time */
47 BT_SEEK_RESTORE
, /* uses u.restore */
54 struct bt_saved_pos
*restore
;
59 * bt_iter_next: Move trace collection position to the next event.
61 * Returns 0 on success, a negative value on error
63 int bt_iter_next(struct bt_iter
*iter
);
66 * bt_iter_get_pos - Get the current iterator position.
68 * The position returned by this function needs to be freed by
69 * bt_iter_free_pos after use.
71 struct bt_iter_pos
*bt_iter_get_pos(struct bt_iter
*iter
);
74 * bt_iter_free_pos - Free the position.
76 void bt_iter_free_pos(struct bt_iter_pos
*pos
);
79 * bt_iter_set_pos: move the iterator to a given position.
81 * On error, the stream_heap is reinitialized and returned empty.
83 * Return 0 for success.
85 * Return EOF if the position requested is after the last event of the
87 * Return -EINVAL when called with invalid parameter.
88 * Return -ENOMEM if the stream_heap could not be properly initialized.
90 int bt_iter_set_pos(struct bt_iter
*iter
, const struct bt_iter_pos
*pos
);
93 * bt_iter_create_time_pos: create a position based on time
95 * This function allocates and returns a new bt_iter_pos (which must be freed
96 * with bt_iter_free_pos) to be able to restore an iterator position based on a
99 struct bt_iter_pos
*bt_iter_create_time_pos(struct bt_iter
*iter
,
102 #endif /* _BABELTRACE_ITERATOR_H */
This page took 0.034457 seconds and 5 git commands to generate.