session-descriptor.h

/*
 * SPDX-FileCopyrightText: 2019 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 */
 
#ifndef LTTNG_SESSION_DESCRIPTOR_H
#define LTTNG_SESSION_DESCRIPTOR_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <lttng/lttng-export.h>
 
struct lttng_session_descriptor;
 
enum lttng_session_descriptor_status {
    LTTNG_SESSION_DESCRIPTOR_STATUS_OK = 0,
 
    LTTNG_SESSION_DESCRIPTOR_STATUS_INVALID = -1,
 
    LTTNG_SESSION_DESCRIPTOR_STATUS_UNSET = 1,
};
 
enum lttng_trace_format {
    LTTNG_TRACE_FORMAT_DEFAULT = 0,
 
    LTTNG_TRACE_FORMAT_CTF_1_8 = 1,
 
    LTTNG_TRACE_FORMAT_CTF_2 = 2,
};
 
LTTNG_EXPORT extern struct lttng_session_descriptor *
lttng_session_descriptor_create(const char *session_name);
 
LTTNG_EXPORT extern struct lttng_session_descriptor *
lttng_session_descriptor_local_create(const char *session_name, const char *trace_dir);
 
LTTNG_EXPORT extern struct lttng_session_descriptor *lttng_session_descriptor_network_create(
    const char *session_name, const char *control_url, const char *data_url);
 
LTTNG_EXPORT extern struct lttng_session_descriptor *
lttng_session_descriptor_snapshot_create(const char *session_name);
 
LTTNG_EXPORT extern struct lttng_session_descriptor *
lttng_session_descriptor_snapshot_local_create(const char *session_name, const char *trace_dir);
 
LTTNG_EXPORT extern struct lttng_session_descriptor *
lttng_session_descriptor_snapshot_network_create(const char *session_name,
                         const char *control_url,
                         const char *data_url);
 
/*
 * NOTE: Not documented with Doxygen as what lttng_create_session_ext()
 * creates from such a descriptor is useless (a live recording session
 * without any output). Original documentation follows.
 *
 * Create a live session descriptor without an output.
 *
 * The 'name' parameter can be left NULL to auto-generate a session name.
 *
 * The 'live_timer_interval_us' parameter is the live timer's period, specified
 * in microseconds.
 *
 * This parameter can't be 0. There is no default value defined for a live
 * timer's period.
 *
 * Returns an lttng_session_descriptor instance on success, NULL on error.
 */
LTTNG_EXPORT extern struct lttng_session_descriptor *
lttng_session_descriptor_live_create(const char *name, unsigned long long live_timer_interval_us);
 
LTTNG_EXPORT extern struct lttng_session_descriptor *
lttng_session_descriptor_live_network_create(const char *session_name,
                         const char *control_url,
                         const char *data_url,
                         unsigned long long live_timer_period);
 
LTTNG_EXPORT extern enum lttng_session_descriptor_status
lttng_session_descriptor_get_session_name(const struct lttng_session_descriptor *session_descriptor,
                      const char **session_name);
 
LTTNG_EXPORT extern enum lttng_session_descriptor_status
lttng_session_descriptor_set_trace_format(struct lttng_session_descriptor *descriptor,
                      enum lttng_trace_format format);
 
LTTNG_EXPORT extern void
lttng_session_descriptor_destroy(struct lttng_session_descriptor *session_descriptor);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* LTTNG_SESSION_DESCRIPTOR_H */