Function lttngpy::enable_channel

Function Documentation

int lttngpy::enable_channel(const std::string &session_name, const enum lttng_domain_type domain_type, const enum lttng_buffer_type buffer_type, const std::string &channel_name, const std::optional<int> overwrite, const std::optional<uint64_t> subbuf_size, const std::optional<uint64_t> num_subbuf, const std::optional<uint64_t> switch_timer_interval, const std::optional<uint64_t> read_timer_interval, const std::optional<enum lttng_event_output> output)

Enable channel.

Parameters:

  • session_name – the session name

  • domain_type – the domain type

  • buffer_type – the buffer type

  • channel_name – the channel name

  • overwrite – the overwrite attribute (-1: session default, 1: overwrite, 0: discard), or std::nullopt for the default value

  • subbuf_size – the subbuffer size in bytes (power of 2), or std::nullopt for the default value

  • num_subbuf – the number of subbuffers (power of 2), or std::nullopt for the default value

  • switch_timer_interval – the switch timer internal in usec (0 to disable), or std::nullopt for the default value

  • read_timer_interval – the read timer internal in usec (0 to disable), or std::nullopt for the default value

Returns:

0 on success, else a negative LTTng error code