bin: compile lttng-consumerd as a C++

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

diff --git a/include/lttng/trigger/trigger.h b/include/lttng/trigger/trigger.h
index 3b1cedda1fb4709457537ded9df978e206d6d3ca..842203ace0f145f17ecbee0389762671acbeea83 100644 (file)
--- a/include/lttng/trigger/trigger.h
+++ b/include/lttng/trigger/trigger.h
@@ -9,7 +9,9 @@
 #define LTTNG_TRIGGER_H
 
 #include <sys/types.h>
+#include <lttng/constant.h>
 #include <inttypes.h>
+#include <lttng/lttng-error.h>
 
 struct lttng_action;
 struct lttng_condition;
@@ -36,11 +38,6 @@ enum lttng_trigger_status {
        LTTNG_TRIGGER_STATUS_PERMISSION_DENIED = -6,
 };
 
-enum lttng_trigger_firing_policy {
-       LTTNG_TRIGGER_FIRING_POLICY_EVERY_N = 0,
-       LTTNG_TRIGGER_FIRING_POLICY_ONCE_AFTER_N = 1,
-};
-
 /*
  * Create a trigger object associating a condition and an action.
  *
@@ -100,7 +97,7 @@ extern enum lttng_trigger_status lttng_trigger_get_owner_uid(
 extern struct lttng_condition *lttng_trigger_get_condition(
                struct lttng_trigger *trigger);
 
-const struct lttng_condition *lttng_trigger_get_const_condition(
+extern const struct lttng_condition *lttng_trigger_get_const_condition(
                const struct lttng_trigger *trigger);
 
 /*
@@ -113,7 +110,7 @@ const struct lttng_condition *lttng_trigger_get_const_condition(
 extern struct lttng_action *lttng_trigger_get_action(
                struct lttng_trigger *trigger);
 
-const struct lttng_action *lttng_trigger_get_const_action(
+extern const struct lttng_action *lttng_trigger_get_const_action(
                const struct lttng_trigger *trigger);
 
 /*
@@ -125,69 +122,40 @@ const struct lttng_action *lttng_trigger_get_const_action(
  *
  * Returns LTTNG_TRIGGER_STATUS_OK and a pointer to the trigger's name on
  * success, LTTNG_TRIGGER_STATUS_INVALID if an invalid parameter is passed,
- * or LTTNG_TRIGGER_STATUS_UNSET if a name was not set prior to this call.
+ * or LTTNG_TRIGGER_STATUS_UNSET if the trigger is unnamed.
  */
 extern enum lttng_trigger_status lttng_trigger_get_name(
                const struct lttng_trigger *trigger, const char **name);
 
 /*
- * Set the trigger name.
- *
- * A name is optional.
- * A name will be assigned on trigger registration if no name is set.
- *
- * The name is copied.
- *
- * Return LTTNG_TRIGGER_STATUS_OK on success, LTTNG_TRIGGER_STATUS_INVALID
- * if invalid parameters are passed.
+ * Destroy (frees) a trigger object.
  */
-extern enum lttng_trigger_status lttng_trigger_set_name(
-               struct lttng_trigger *trigger, const char *name);
+extern void lttng_trigger_destroy(struct lttng_trigger *trigger);
 
 /*
- * Set the trigger firing policy.
- *
- * This is optional. By default a trigger is set to fire each time the
- * associated condition occurs.
+ * Register a trigger to the session daemon with a given name.
  *
- * Threshold is the number of times the condition must be hit before the policy
- * is enacted.
+ * The trigger object can be destroyed after this call.
+ * On success, this function will set the trigger's name to `name`.
  *
- * Return LTTNG_TRIGGER_STATUS_OK on success, LTTNG_TRIGGER_STATUS_INVALID
- * if invalid parameters are passed.
+ * Returns an LTTng status code.
  */
-extern enum lttng_trigger_status lttng_trigger_set_firing_policy(
+extern enum lttng_error_code lttng_register_trigger_with_name(
                struct lttng_trigger *trigger,
-               enum lttng_trigger_firing_policy policy_type,
-               uint64_t threshold);
+               const char *name);
 
 /*
- * Get the trigger firing policy.
- *
- * Threshold is the number of time the condition must be hit before the policy is
- * enacted.
- *
- * Return LTTNG_TRIGGER_STATUS_OK on success, LTTNG_TRIGGER_STATUS_INVALID
- * if invalid parameters are passed.
- */
-extern enum lttng_trigger_status lttng_trigger_get_firing_policy(
-               const struct lttng_trigger *trigger,
-               enum lttng_trigger_firing_policy *policy_type,
-               uint64_t *threshold);
-
-/*
- * Destroy (frees) a trigger object.
- */
-extern void lttng_trigger_destroy(struct lttng_trigger *trigger);
-
-/*
- * Register a trigger to the session daemon.
+ * Register a trigger to the session daemon, generating a unique name for its
+ * owner.
  *
  * The trigger can be destroyed after this call.
+ * On success, this function will set the trigger's name to the generated
+ * name.
  *
- * Return 0 on success, a negative LTTng error code on error.
+ * Returns an LTTng status code.
  */
-extern int lttng_register_trigger(struct lttng_trigger *trigger);
+extern enum lttng_error_code lttng_register_trigger_with_automatic_name(
+               struct lttng_trigger *trigger);
 
 /*
  * Unregister a trigger from the session daemon.
@@ -237,6 +205,18 @@ extern enum lttng_trigger_status lttng_triggers_get_count(
  */
 extern void lttng_triggers_destroy(struct lttng_triggers *triggers);
 
+/*
+ * Deprecated: invocations should be replaced by
+ * lttng_register_trigger_with_automatic_name().
+ *
+ * Register a trigger to the session daemon.
+ *
+ * The trigger can be destroyed after this call.
+ *
+ * Return 0 on success, a negative LTTng error code on error.
+ */
+LTTNG_DEPRECATED("Use lttng_register_trigger_with_automatic_name")
+extern int lttng_register_trigger(struct lttng_trigger *trigger);
 
 #ifdef __cplusplus
 }