Rename data_available to data_pending

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

diff --git a/include/lttng/lttng.h b/include/lttng/lttng.h
index 4171cde41c998d123fac3b407a337ec622b42cfe..f4b07e29f94a175b56758dc4fb38a71d1e48cf8f 100644 (file)
--- a/include/lttng/lttng.h
+++ b/include/lttng/lttng.h
@@ -472,9 +472,20 @@ extern int lttng_start_tracing(const char *session_name);
 
 /*
  * Stop tracing for *all* registered traces (kernel and user-space).
+ *
+ * This call will wait for data availability for each domain of the session so
+ * this can take an abritrary amount of time. However, when returning you have
+ * the guarantee that the data is ready to be read and analyse. Use the
+ * _no_wait call below to avoid this behavior.
  */
 extern int lttng_stop_tracing(const char *session_name);
 
+/*
+ * Behave exactly like lttng_stop_tracing but does not wait for data
+ * availability.
+ */
+extern int lttng_stop_tracing_no_wait(const char *session_name);
+
 /*
  * Add context to event(s) for a specific channel (or for all).
  *
@@ -583,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
 }