X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=include%2Fbabeltrace%2Fctf%2Fevents.h;h=61e3f6a31a948d060088b66a165c3db2526dedbd;hp=f2ef22dfbb6491c1ac66aa08919de5419dfc1ba1;hb=e419579102094d83539d79ce6af83d9786d387ee;hpb=5c5facc70af60670ec8f53b9d90d13722a8477f4 diff --git a/include/babeltrace/ctf/events.h b/include/babeltrace/ctf/events.h index f2ef22df..61e3f6a3 100644 --- a/include/babeltrace/ctf/events.h +++ b/include/babeltrace/ctf/events.h @@ -24,10 +24,12 @@ */ #include +#include struct ctf_stream; struct ctf_stream_event; struct definition; +struct bt_ctf_iter; /* * the top-level scopes in CTF @@ -66,6 +68,42 @@ struct bt_ctf_event { struct ctf_stream_event *event; }; +/* + * bt_ctf_iter_read_event: Read the iterator's current event data. + * + * @iter: trace collection iterator (input) + * @stream: stream containing event at current position (output) + * @event: current event (output) + * Return 0 on success, negative error value on error. + */ +struct bt_ctf_event *bt_ctf_iter_read_event(struct bt_ctf_iter *iter); + +/* + * bt_ctf_iter_create - Allocate a CTF trace collection iterator. + * + * begin_pos and end_pos are optional parameters to specify the position + * at which the trace collection should be seeked upon iterator + * creation, and the position at which iteration will start returning + * "EOF". + * + * By default, if begin_pos is NULL, a BT_SEEK_CUR is performed at + * creation. By default, if end_pos is NULL, a BT_SEEK_END (end of + * trace) is the EOF criterion. + */ +struct bt_ctf_iter *bt_ctf_iter_create(struct bt_context *ctx, + struct bt_iter_pos *begin_pos, + struct bt_iter_pos *end_pos); + +/* + * bt_ctf_get_iter - get iterator from ctf iterator. + */ +struct bt_iter *bt_ctf_get_iter(struct bt_ctf_iter *iter); + +/* + * bt_ctf_iter_destroy - Free a CTF trace collection iterator. + */ +void bt_ctf_iter_destroy(struct bt_ctf_iter *iter); + /* * bt_ctf_get_top_level_scope: return a definition of the top-level scope *