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 3b5d6ae9a5f814fc205ef96a1dfa53334fcdd7d4..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;
@@ -157,6 +161,7 @@ struct ust_app_channel {
        struct lttng_ht *events;
        uint64_t tracefile_size;
        uint64_t tracefile_count;
+       uint64_t monitor_timer_interval;
        /*
         * Node indexed by channel name in the channels' hash table of a session.
         */
@@ -328,7 +333,6 @@ void ust_app_global_update_all(struct ltt_ust_session *usess);
 void ust_app_clean_list(void);
 int ust_app_ht_alloc(void);
 struct ust_app *ust_app_find_by_pid(pid_t pid);
-int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate);
 struct ust_app_stream *ust_app_alloc_stream(void);
 int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
 int ust_app_recv_notify(int sock);
@@ -497,11 +501,6 @@ int ust_app_enable_event_pid(struct ltt_ust_session *usess,
        return 0;
 }
 static inline
-int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate)
-{
-       return 0;
-}
-static inline
 int ust_app_recv_registration(int sock, struct ust_register_msg *msg)
 {
        return 0;