X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;ds=sidebyside;f=include%2Flttng%2Frotation.h;h=dbc0183da7e856a26df927c454df439b2e5f3a37;hb=dd73d57bb95fae31161ca0781108d166082a06f5;hp=00d68d7e5c5015a71982f1fe3d5690eca205f135;hpb=90936dcf0968343f20b2f6fd365b9c015cdb9717;p=lttng-tools.git diff --git a/include/lttng/rotation.h b/include/lttng/rotation.h index 00d68d7e5..dbc0183da 100644 --- a/include/lttng/rotation.h +++ b/include/lttng/rotation.h @@ -20,6 +20,7 @@ #define LTTNG_ROTATION_H #include +#include #ifdef __cplusplus extern "C" { @@ -29,15 +30,19 @@ extern "C" { * Return codes for lttng_rotation_handle_get_state() */ enum lttng_rotation_state { + /* + * Session has not been rotated. + */ + LTTNG_ROTATION_STATE_NO_ROTATION = 0, /* * Rotation is ongoing, but has not been completed yet. */ - LTTNG_ROTATION_STATE_ONGOING = 0, + LTTNG_ROTATION_STATE_ONGOING = 1, /* * Rotation has been completed and the resulting chunk * can now safely be read. */ - LTTNG_ROTATION_STATE_COMPLETED = 1, + LTTNG_ROTATION_STATE_COMPLETED = 2, /* * The rotation has expired. * @@ -48,11 +53,11 @@ enum lttng_rotation_state { * Note that this state does not guarantee the the rotation was * completed successfully. */ - LTTNG_ROTATION_STATE_EXPIRED = 2, + LTTNG_ROTATION_STATE_EXPIRED = 3, /* * The rotation could not be completed due to an error. */ - LTTNG_ROTATION_STATE_ERROR = 3, + LTTNG_ROTATION_STATE_ERROR = 4, }; enum lttng_rotation_status { @@ -158,16 +163,14 @@ extern enum lttng_rotation_status lttng_rotation_handle_get_state( * Get the location of the rotation's resulting archive. * * The rotation must be completed in order for this call to succeed. - * The path returned is owned by the rotation handle. - * - * Note that path will not be set in case of error, or if the session - * rotation has expired. + * The location returned remains owned by the rotation handle. * - * FIXME: Return an lttng_location object instead of a path. + * Note that location will not be set in case of error, or if the session + * rotation handle has expired. */ -extern enum lttng_rotation_status lttng_rotation_handle_get_completed_archive_location( +extern enum lttng_rotation_status lttng_rotation_handle_get_archive_location( struct lttng_rotation_handle *rotation_handle, - const char **path); + const struct lttng_trace_archive_location **location); /* * Destroy an lttng_rotate_session handle.