Docs: sessiond: document the role of an application's two sockets

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

diff --git a/src/bin/lttng-sessiond/ust-app.hpp b/src/bin/lttng-sessiond/ust-app.hpp
index d0cbd217ce857aa48c0e7164e2143de66e2f7986..3200b654986596fb2eda518f96da35e2bccb097e 100644 (file)
--- a/src/bin/lttng-sessiond/ust-app.hpp
+++ b/src/bin/lttng-sessiond/ust-app.hpp
@@ -106,7 +106,7 @@ struct ust_app_ctx {
 };
 
 struct ust_app_event {
-       int enabled;
+       bool enabled;
        int handle;
        struct lttng_ust_abi_object_data *obj;
        struct lttng_ust_abi_event attr;
@@ -117,7 +117,7 @@ struct ust_app_event {
 };
 
 struct ust_app_event_notifier_rule {
-       int enabled;
+       bool enabled;
        uint64_t error_counter_index;
        int handle;
        struct lttng_ust_abi_object_data *obj;
@@ -145,7 +145,7 @@ struct ust_app_stream {
 };
 
 struct ust_app_channel {
-       int enabled;
+       bool enabled;
        int handle;
        /*
         * Unique key used to identify the channel on the consumer side.
@@ -196,9 +196,9 @@ struct ust_app_session {
         */
        pthread_mutex_t lock;
 
-       int enabled;
+       bool enabled;
        /* started: has the session been in started state at any time ? */
-       int started;  /* allows detection of start vs restart. */
+       bool started;  /* allows detection of start vs restart. */
        int handle;   /* used has unique identifier for app session */
 
        bool deleted;   /* Session deleted flag. Check with lock held. */
@@ -249,9 +249,11 @@ struct ust_app_session {
  * and a linked list is kept of all running traceable app.
  */
 struct ust_app {
+       /* Traffic initiated from the session daemon to the application. */
        int sock;
        pthread_mutex_t sock_lock;      /* Protects sock protocol. */
 
+       /* Traffic initiated from the application to the session daemon. */
        int notify_sock;
        pid_t pid;
        pid_t ppid;
@@ -336,8 +338,8 @@ struct ust_app {
 namespace fmt {
 template <>
 struct formatter<ust_app> : formatter<std::string> {
-       template <typename FormatCtx>
-       typename FormatCtx::iterator format(const ust_app& app, FormatCtx& ctx)
+       template <typename FormatContextType>
+       typename FormatContextType::iterator format(const ust_app& app, FormatContextType& ctx)
        {
                return format_to(ctx.out(),
                                "{{ procname = `{}`, ppid = {}, pid = {}, uid = {}, gid = {}, version = {}.{}, registration time = {} }}",
@@ -374,12 +376,12 @@ int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
 void ust_app_global_update(struct ltt_ust_session *usess, struct ust_app *app);
 void ust_app_global_update_all(struct ltt_ust_session *usess);
 void ust_app_global_update_event_notifier_rules(struct ust_app *app);
-void ust_app_global_update_all_event_notifier_rules(void);
+void ust_app_global_update_all_event_notifier_rules();
 
-void ust_app_clean_list(void);
-int ust_app_ht_alloc(void);
+void ust_app_clean_list();
+int ust_app_ht_alloc();
 struct ust_app *ust_app_find_by_pid(pid_t pid);
-struct ust_app_stream *ust_app_alloc_stream(void);
+struct ust_app_stream *ust_app_alloc_stream();
 int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
 int ust_app_recv_notify(int sock);
 void ust_app_add(struct ust_app *app);
@@ -416,7 +418,7 @@ enum lttng_error_code ust_app_open_packets(struct ltt_session *session);
 int ust_app_setup_event_notifier_group(struct ust_app *app);
 
 static inline
-int ust_app_supported(void)
+int ust_app_supported()
 {
        return 1;
 }