X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=include%2Flttng%2Ftrigger%2Ftrigger.h;fp=include%2Flttng%2Ftrigger%2Ftrigger.h;h=921ff11bea976ca3c5c62df27ebf4473b7dc1447;hp=6490af118a4333eb857d203d46dfce05a78455aa;hb=a5c2d2a71919b8d1542b62f6d32579125cc2c8f8;hpb=0efb2ad7fc448283184e43d6fb0915febae45384 diff --git a/include/lttng/trigger/trigger.h b/include/lttng/trigger/trigger.h index 6490af118..921ff11be 100644 --- a/include/lttng/trigger/trigger.h +++ b/include/lttng/trigger/trigger.h @@ -9,6 +9,7 @@ #define LTTNG_TRIGGER_H #include +#include #include struct lttng_action; @@ -120,38 +121,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); /* - * Destroy (frees) a trigger object. + * Register a trigger to the session daemon with a given name. + * + * The trigger object can be destroyed after this call. + * On success, this function will set the trigger's name to `name`. + * + * Returns an LTTng status code. */ -extern void lttng_trigger_destroy(struct lttng_trigger *trigger); +extern enum lttng_error_code lttng_register_trigger_with_name( + struct lttng_trigger *trigger, + const char *name); /* - * 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. @@ -201,6 +204,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 }