/*
- * Copyright (C) 2019 - Jonathan Rajotte-Julien <jonathan.rajotte-julien@efficios.com>
+ * Copyright (C) 2019 Jonathan Rajotte-Julien <jonathan.rajotte-julien@efficios.com>
*
- * This library is free software; you can redistribute it and/or modify it
- * under the terms of the GNU Lesser General Public License, version 2.1 only,
- * as published by the Free Software Foundation.
+ * SPDX-License-Identifier: LGPL-2.1-only
*
- * This library is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
- * for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this library; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef LTTNG_TRACKER_H
#define LTTNG_TRACKER_H
#include <lttng/constant.h>
-#include <common/macros.h>
#include <lttng/session.h>
#ifdef __cplusplus
LTTNG_TRACKER_ID_STATUS_UNSET = 1,
};
+/*
+ * A tracker id.
+ */
struct lttng_tracker_id;
+
+/*
+ * A collection of tracker id.
+ */
struct lttng_tracker_ids;
/*
struct lttng_tracker_id *id);
/*
- * Destroys (frees) a tracker id.
+ * Destroy a tracker id.
*/
extern void lttng_tracker_id_destroy(struct lttng_tracker_id *id);
/*
- * Returns the type of the tracker id.
+ * Get the type of a tracker id.
*/
extern enum lttng_tracker_id_type lttng_tracker_id_get_type(
const struct lttng_tracker_id *id);
/*
- * Returns the value of the tracker id.
+ * Get the value of a tracker id.
*
* Returns LTTNG_TRACKER_ID_OK on success,
* LTTNG_TRACKER_ID_STATUS_INVALID when the tracker is not of type
const struct lttng_tracker_id *id, int *value);
/*
- * Returns the string representation of the tracker id.
+ * Get the string representation of the tracker id.
*
* Returns LTTNG_TRACKER_ID_OK on success,
* LTTNG_TRACKER_ID_STATUS_INVALID when the tracker is not of type
const struct lttng_tracker_id *id);
/*
- * List IDs in the tracker.
+ * List IDs of a tracker.
*
- * tracker_type is the type of tracker.
- * ids is set to an allocated lttng_tracker_ids representing IDs
- * currently tracked.
- * On success, caller is responsible for freeing ids
- * using lttng_tracker_ids_destroy.
+ * On success, ids is allocated.
+ * The ids collection must be freed by the caller with lttng_destroy_ids().
*
* Returns 0 on success, else a negative LTTng error code.
*/