Trigger action path API

Collaboration diagram for Trigger action path API:

Warning

The documentation of the trigger action path API is incomplete.

The text below shows the typical usage of this API, but the types, enumerators, and functions of lttng/action/path.h aren't documented individually.

A trigger action path specifies how to traverse a trigger action tree, formed with action lists, to reach a specific action.

The current purpose of a trigger action path is to locate a specific action when executing an error query with lttng_error_query_action_create().

To use a trigger action path:

1. Create an action path with lttng_action_path_create(), passing an array of action indexes (within nested action lists) and the number of indexes.
2. Pass the trigger action path to lttng_error_query_action_create() to locate the specific action when you create an error query.
3. When you're done with the trigger action path, destroy it with lttng_action_path_destroy().

Get an action index from a trigger action path with lttng_action_path_get_index_count() and lttng_action_path_get_index_at_index().