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 ab00b1c195df52b3f7c35e079f20f2a2a65fb51c..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 = {} }}",