Lib lttng-ctl data available command support

[lttng-tools.git] / include / lttng / lttng.h

diff --git a/include/lttng/lttng.h b/include/lttng/lttng.h
index f92ccb6fdb3615266bb86c06dc465accb01ded9b..4171cde41c998d123fac3b407a337ec622b42cfe 100644 (file)
--- a/include/lttng/lttng.h
+++ b/include/lttng/lttng.h
@@ -581,6 +581,16 @@ extern int lttng_disable_consumer(struct lttng_handle *handle);
  */
 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.
+ *
+ * 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().
+ */
+extern int lttng_data_available(const char *session_name);
+
 #ifdef __cplusplus
 }
 #endif