lttng_session Struct Reference

Recording session summary. More...

#include <session.h>

Data Fields
uint32_t	enabled
	1 if this recording session is active (started), or 0 otherwise.
unsigned int	live_timer_interval
	Period (µs) of the live timers of the event record channels of this recording session, or 0 if this recording session wasn't created in live mode.
char	name [LTTNG_NAME_MAX]
	Name.
char	path [PATH_MAX]
	Human-readable representation of the output (local or remote).
uint32_t	snapshot_mode
	1 if this recording session was created in snapshot mode, or 0 otherwise.

Detailed Description

Recording session summary.

The purpose of such a structure is to provide information about a recording session itself, but not about its tracing domains and event record channels (use lttng_list_domains() and lttng_list_channels() for this).

lttng_list_sessions() sets a pointer to an array of all the available recording session summaries.

Field Documentation

enabled

uint32_t lttng_session::enabled

1 if this recording session is active (started), or 0 otherwise.

See also

lttng_start_tracing() – Starts a recording session.

lttng_stop_tracing() – Stops a recording session.

live_timer_interval

unsigned int lttng_session::live_timer_interval

Period (µs) of the live timers of the event record channels of this recording session, or 0 if this recording session wasn't created in live mode.

Note

If this member is not 0, then the lttng_session::snapshot_mode member is 0.

snapshot_mode

uint32_t lttng_session::snapshot_mode

1 if this recording session was created in snapshot mode, or 0 otherwise.

Note

If this member is 1, then the lttng_session::live_timer_interval member is 0.