From 4a732689c2fe7624efff6fec2353542f14c60cb8 Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=A9mie=20Galarneau?= Date: Mon, 17 Sep 2018 18:15:11 -0400 Subject: [PATCH] Docs: document the meaning of a ust app channel key set to 0 MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérémie Galarneau --- src/bin/lttng-sessiond/ust-app.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/bin/lttng-sessiond/ust-app.h b/src/bin/lttng-sessiond/ust-app.h index 03a50e877..3c375f30d 100644 --- a/src/bin/lttng-sessiond/ust-app.h +++ b/src/bin/lttng-sessiond/ust-app.h @@ -134,7 +134,11 @@ struct ust_app_channel { int handle; /* Channel and streams were sent to the UST tracer. */ int is_sent; - /* Unique key used to identify the channel on the consumer side. */ + /* + * Unique key used to identify the channel on the consumer side. + * 0 is a reserved 'invalid' value used to indicate that the consumer + * does not know about this channel (i.e. an error occured). + */ uint64_t key; /* Id of the tracing channel set on creation. */ uint64_t tracing_channel_id; -- 2.34.1