Docs: document the meaning of a ust app channel key set to 0

[lttng-tools.git] / src / bin / lttng-sessiond / ust-app.h

diff --git a/src/bin/lttng-sessiond/ust-app.h b/src/bin/lttng-sessiond/ust-app.h
index 03a50e87799574d708a978c9163cf29cec38fbfe..3c375f30d82e33513db0445d134da6931315463d 100644 (file)
--- 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;