X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=include%2Fbabeltrace%2Fctf%2Fiterator.h;h=449ddfeb370b1cd8baba7efce664c1046c8bb809;hp=8f9af0e19e3b8af855f2e3fae71200014b8af16c;hb=f60efc0e475b3c2fca3b2afc584615f6c482c9e7;hpb=17e0c86ea65fcfef51592628e35efc27392638f2 diff --git a/include/babeltrace/ctf/iterator.h b/include/babeltrace/ctf/iterator.h index 8f9af0e1..449ddfeb 100644 --- a/include/babeltrace/ctf/iterator.h +++ b/include/babeltrace/ctf/iterator.h @@ -25,6 +25,10 @@ #include +#ifdef __cplusplus +extern "C" { +#endif + struct bt_ctf_iter; struct bt_ctf_event; @@ -39,10 +43,17 @@ struct bt_ctf_event; * 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. + * + * Return a pointer to the newly allocated iterator. + * + * Only one iterator can be created against a context. If more than one + * iterator is being created for the same context, the second creation + * will return NULL. The previous iterator must be destroyed before + * creation of the new iterator for this function to succeed. */ struct bt_ctf_iter *bt_ctf_iter_create(struct bt_context *ctx, - struct bt_iter_pos *begin_pos, - struct bt_iter_pos *end_pos); + const struct bt_iter_pos *begin_pos, + const struct bt_iter_pos *end_pos); /* * bt_ctf_get_iter - get iterator from ctf iterator. @@ -57,10 +68,36 @@ void bt_ctf_iter_destroy(struct bt_ctf_iter *iter); /* * bt_ctf_iter_read_event: Read the iterator's current event data. * - * @iter: trace collection iterator (input) + * @iter: trace collection iterator (input). Should NOT be NULL. * * Return current event on success, NULL on end of trace. */ struct bt_ctf_event *bt_ctf_iter_read_event(struct bt_ctf_iter *iter); +#ifdef __cplusplus +} +#endif + +/* + * bt_ctf_iter_read_event_flags: Read the iterator's current event data. + * + * @iter: trace collection iterator (input). Should NOT be NULL. + * @flags: pointer passed by the user, in which the trace reader populates + * flags on special condition (BT_ITER_FLAG_*). + * + * Return current event on success, NULL on end of trace. + */ +struct bt_ctf_event *bt_ctf_iter_read_event_flags(struct bt_ctf_iter *iter, + int *flags); + +/* + * bt_ctf_get_lost_events_count: returns the number of events discarded + * immediately prior to the last event read + * + * @iter: trace collection iterator (input). Should NOT be NULL. + * + * Return the number of lost events or -1ULL on error. + */ +uint64_t bt_ctf_get_lost_events_count(struct bt_ctf_iter *iter); + #endif /* _BABELTRACE_CTF_ITERATOR_H */