on-event evaluation: remove trigger name accessor

[lttng-tools.git] / include / lttng / condition / on-event.h

diff --git a/include/lttng/condition/on-event.h b/include/lttng/condition/on-event.h
index 4505076131937ae8053a5eb6946e6f144b649e87..18c4155a2c73dd10d1462d088f9beec6a3dbf8e3 100644 (file)
--- a/include/lttng/condition/on-event.h
+++ b/include/lttng/condition/on-event.h
@@ -19,6 +19,12 @@ extern "C" {
 struct lttng_event_expr;
 struct lttng_event_field_value;
 
+enum lttng_evaluation_on_event_status {
+       LTTNG_EVALUATION_ON_EVENT_STATUS_NONE = 1,
+       LTTNG_EVALUATION_ON_EVENT_STATUS_OK = 0,
+       LTTNG_EVALUATION_ON_EVENT_STATUS_INVALID = -1,
+};
+
 /**
  * On event conditions allows an action to be taken whenever an event matching
  * the on event is hit by the tracers.
@@ -58,43 +64,32 @@ extern enum lttng_condition_status lttng_condition_on_event_get_rule(
  * allow users to query a number of properties resulting from the evaluation
  * of a condition which evaluated to true.
  *
- * The evaluation of a on event hit yields two different results:
- *    TEMPORARY - The name of the triggers associated with the condition.
- *    TODO - The captured event payload if any
+ * The evaluation of an on event condition contains the captured event
+ * payload fields that were specified by the condition.
  */
 
-/*
- * Get the trigger name property of a on event hit evaluation.
- *
- * Returns LTTNG_EVALUATION_STATUS_OK on success and a trigger name
- * or LTTNG_EVALUATION_STATUS_INVALID if
- * an invalid parameter is passed.
- */
-extern enum lttng_evaluation_status
-lttng_evaluation_on_event_get_trigger_name(
-               const struct lttng_evaluation *evaluation,
-               const char **name);
-
 /*
  * Sets `*field_val` to the array event field value of the on event
  * condition evaluation `evaluation` which contains its captured values.
  *
  * Returns:
  *
- * `LTTNG_EVALUATION_STATUS_OK`:
+ * `LTTNG_EVALUATION_ON_EVENT_STATUS_OK`:
  *     Success.
  *
  *     `*field_val` is an array event field value with a length of at
  *     least one.
  *
- * `LTTNG_EVALUATION_STATUS_INVALID`:
+ * `LTTNG_EVALUATION_ON_EVENT_STATUS_INVALID`:
  *     * `evaluation` is `NULL`.
  *     * The type of the condition of `evaluation` is not
  *       `LTTNG_CONDITION_TYPE_ON_EVENT`.
- *     * The condition of `evaluation` has no capture descriptors.
  *     * `field_val` is `NULL`.
+ *
+ * `LTTNG_EVALUATION_ON_EVENT_STATUS_NONE`:
+ *     * The condition of `evaluation` has no capture descriptors.
  */
-extern enum lttng_evaluation_status
+extern enum lttng_evaluation_on_event_status
 lttng_evaluation_on_event_get_captured_values(
                const struct lttng_evaluation *evaluation,
                const struct lttng_event_field_value **field_val);