Typedef rclc_parameter_callback_t

Typedef Documentation

typedef bool (*rclc_parameter_callback_t)(const Parameter *old_param, const Parameter *new_param, void *context)

Parameter event callback. This callback will allow the user to allow or reject the following events:

  • Parameter value change: Internal and external parameter set on existing parameters.

  • Parameter creation: External parameter set on unexisting parameter if allow_undeclared_parameters is set.

  • Parameter delete: External parameter delete on existing parameter.

Parameters modifications are disabled while this callback is executed.

Attribute

Adherence

Allocates Memory

No

Thread-Safe

No

Uses Atomics

No

Lock-Free

No

Param old_param:

[in] Parameter actual value, NULL for new parameter request.

Param new_param:

[in] Parameter new value, NULL for parameter removal request.

Param context:

[in] Context of the callback.

Return:

true to accept the parameter event. If the operation was rejected, false is returned.