lttng_channel Struct Reference

Channel summary. More...

#include <channel.h>

Collaboration diagram for lttng_channel:

Data Fields
struct lttng_channel_attr	attr
	Other properties.
uint32_t	enabled
	1 if this channel is enabled, or 0 otherwise.
char	name [LTTNG_SYMBOL_NAME_LEN]
	Name.

Detailed Description

Channel summary.

The purpose of such a structure is to provide information about a channel itself, but not about its recording event rules (use lttng_list_events() for this).

lttng_list_channels() sets a pointer to an array of all the channel summaries of a given recording session and tracing domain.

Most properties are part of the lttng_channel::attr member, but the following ones have their own dedicated accessors:

Buffer allocation policy

• lttng_channel_get_allocation_policy()
• lttng_channel_set_allocation_policy()

Monitor timer period

• lttng_channel_get_monitor_timer_interval()
• lttng_channel_set_monitor_timer_interval()

Blocking timeout

• lttng_channel_get_blocking_timeout()
• lttng_channel_set_blocking_timeout()

Create a channel summary with lttng_channel_create().

Destroy a channel summary with lttng_channel_destroy().

Field Documentation

enabled

uint32_t lttng_channel::enabled

1 if this channel is enabled, or 0 otherwise.

See also

lttng_enable_channel() – Creates or enables a channel.

lttng_disable_channel() – Disables a channel.