X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=include%2Fbabeltrace%2Fctf%2Fiterator.h;h=ec6aac776e99e80cdb25cbe97463872ab722fe3f;hp=7aeb032c81f23e506edcb9392b7574f85e0152f5;hb=c462e188f3e7819c7bc74f671038cdbf36e8c3c0;hpb=8a4722b0ccf5cf30ee76a85bdf6bea2fa0515153 diff --git a/include/babeltrace/ctf/iterator.h b/include/babeltrace/ctf/iterator.h index 7aeb032c..ec6aac77 100644 --- a/include/babeltrace/ctf/iterator.h +++ b/include/babeltrace/ctf/iterator.h @@ -21,12 +21,24 @@ * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. */ #include +#ifdef __cplusplus +extern "C" { +#endif + struct bt_ctf_iter; -struct ctf_event_definition; +struct bt_ctf_event; /* * bt_ctf_iter_create - Allocate a CTF trace collection iterator. @@ -64,10 +76,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); + +/* + * 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 ctf_event_definition *bt_ctf_iter_read_event(struct bt_ctf_iter *iter); +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); + +#ifdef __cplusplus +} +#endif #endif /* _BABELTRACE_CTF_ITERATOR_H */