lttng-ctl: Add error query interface

[lttng-tools.git] / include / lttng / endpoint.h

diff --git a/include/lttng/endpoint.h b/include/lttng/endpoint.h
index fcd787018e54d1ea1adc94f7786d7c79b2440da7..1db5e5108ab8a994fad8a4372e8d4bced4c4708d 100644 (file)
--- a/include/lttng/endpoint.h
+++ b/include/lttng/endpoint.h
@@ -12,9 +12,34 @@
 extern "C" {
 #endif
 
-/* Default LTTng session daemon endpoint singleton. */
+/*
+ * Default LTTng session daemon notification endpoint singleton.
+ *
+ * For use during the creation of a notification channel. This endpoint
+ * implements the following policy to connect to a session daemon's
+ * notification delivery channel:
+ *   - If the caller is root or part of the tracing group:
+ *     - Attempt to connect to the "root" (global) session daemon,
+ *     - Fallback to the session daemon running as the caller's user.
+ *   - Otherwise (caller is an unpriviliged user):
+ *     - Attempt to connect to the session daemon running as the caller's user.
+ */
 extern struct lttng_endpoint *lttng_session_daemon_notification_endpoint;
 
+/*
+ * Default LTTng session daemon command endpoint singleton.
+ *
+ * For use as part of the invocation of a command. This endpoint
+ * implements the following policy to connect to a session daemon's
+ * command channel:
+ *   - If the caller is root or part of the tracing group:
+ *     - Attempt to connect to the "root" (global) session daemon,
+ *     - Fallback to the session daemon running as the caller's user.
+ *   - Otherwise (caller is an unpriviliged user):
+ *     - Attempt to connect to the session daemon running as the caller's user.
+ */
+extern struct lttng_endpoint *lttng_session_daemon_command_endpoint;
+
 #ifdef __cplusplus
 }
 #endif