X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=include%2Flttng%2Flttng.h;h=f4b07e29f94a175b56758dc4fb38a71d1e48cf8f;hp=0a12d9be75e4b97be6728bad11727105f4e68b8c;hb=6d805429e9cb049eb0c9205fcf742a53e3166caf;hpb=9449cc7574c27419ac4424b4653a6f4428d01b4d diff --git a/include/lttng/lttng.h b/include/lttng/lttng.h index 0a12d9be7..f4b07e29f 100644 --- a/include/lttng/lttng.h +++ b/include/lttng/lttng.h @@ -594,13 +594,15 @@ extern int lttng_health_check(enum lttng_health_component c); /* * For a given session name, this call checks if the data is ready to be read - * or is still being extracted by the consumer(s) hence not ready to be used by - * any readers. + * or is still being extracted by the consumer(s) (pending) hence not ready to + * be used by any readers. * - * Return 0 if the data is _NOT_ available else 1 if the data is ready. On - * error, a negative value is returned and readable by lttng_strerror(). + * Return 0 if there is _no_ data pending in the buffers thus having a + * guarantee that the data can be read safely. Else, return 1 if there is still + * traced data is pending. On error, a negative value is returned and readable + * by lttng_strerror(). */ -extern int lttng_data_available(const char *session_name); +extern int lttng_data_pending(const char *session_name); #ifdef __cplusplus }