Class KeyValuePairChannel

Class Documentation

class KeyValuePairChannel

A channel for logging KeyValuePair messages to a topic.

Note

While channels are fully thread-safe, the KeyValuePair struct is not thread-safe. Avoid modifying it concurrently or during a log operation.

Public Functions

FoxgloveError log(const KeyValuePair &msg, std::optional<uint64_t> log_time = std::nullopt) noexcept

Log a message to the channel.

Parameters:

  • msg – The KeyValuePair message to log.

  • log_time – The timestamp of the message. If omitted, the current time is used.

uint64_t id() const noexcept

Uniquely identifies a channel in the context of this program.

Returns:

The ID of the channel.

KeyValuePairChannel(const KeyValuePairChannel &other) noexcept = delete
KeyValuePairChannel &operator=(const KeyValuePairChannel &other) noexcept = delete
KeyValuePairChannel(KeyValuePairChannel &&other) noexcept = default

Default move constructor.

KeyValuePairChannel &operator=(KeyValuePairChannel &&other) noexcept = default

Default move assignment.

~KeyValuePairChannel() = default

Default destructor.

Public Static Functions

static FoxgloveResult<KeyValuePairChannel> create(const std::string_view &topic, const Context &context = Context())

Create a new channel.

Parameters:

  • topic – The topic name. You should choose a unique topic name per channel for compatibility with the Foxglove app.

  • context – The context which associates logs to a sink. If omitted, the default context is used.