Pass lttng_event struct to the set_filter API call

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

diff --git a/include/lttng/lttng.h b/include/lttng/lttng.h
index f92ccb6fdb3615266bb86c06dc465accb01ded9b..9e2d4d129894878631d38452f05bc5ffc25c946a 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).
  *
@@ -500,14 +511,14 @@ extern int lttng_enable_event(struct lttng_handle *handle,
 /*
  * Apply a filter expression to an event.
  *
- * If event_name is NULL, the filter is applied to all events of the channel.
+ * If event is NULL, the filter is applied to all events of the channel.
  * If channel_name is NULL, a lookup of the event's channel is done.
  * If both are NULL, the filter is applied to all events of all channels.
  */
 extern int lttng_set_event_filter(struct lttng_handle *handle,
-               const char *event_name,
-               const char *channel_name,
+               struct lttng_event *event, const char *channel_name,
                const char *filter_expression);
+
 /*
  * Create or enable a channel.
  * The channel name cannot be NULL.
@@ -581,6 +592,18 @@ 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) (pending) hence not ready to
+ * be used by any readers.
+ *
+ * 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_pending(const char *session_name);
+
 #ifdef __cplusplus
 }
 #endif