From: Amaury Denoyelle <adenoyelle@haproxy.com>
Date: Thu, 23 Apr 2026 09:40:23 +0000 (+0200)
Subject: MINOR: connection: document conn_create_mux()
X-Git-Url: http://git.ipfire.org/gitweb/?a=commitdiff_plain;h=537c90fb5e96e53e065c1e67a6f871a06e0d9409;p=thirdparty%2Fhaproxy.git

MINOR: connection: document conn_create_mux()

Function conn_create_mux() has different behavior for frontend and
backend connections. In particular, on FE side, there is a risk that the
connection is freed.

Write a comment to explain these differences clearly.
---

diff --git a/src/connection.c b/src/connection.c
index f5f5d5ee4..77bdba6a9 100644
--- a/src/connection.c
+++ b/src/connection.c
@@ -102,6 +102,20 @@ void conn_delete_from_tree(struct connection *conn, int thr)
 	ceb64_item_delete(conn_tree, hash_node.node, hash_node.key, conn);
 }
 
+/* Installs the MUX layer for <conn> connection. The behavior is slightly
+ * different for frontend and backend sides.
+ *
+ * For frontend connections, MUX is setup via session initialization
+ * completion. In case of failure, the session and the whole connection stack
+ * is freed. Caller should set <closed_connection> to a non NULL value as it
+ * will be set to 1 to report the connection release.
+ *
+ * For backend connections, MUX layer is immediately initialized by selecting
+ * the most appropriate one depending on the connection protocol. In case of
+ * failure, connection is left as it is and the upper layer is notified.
+ *
+ * Returns 0 on success else a negative error code.
+ */
 int conn_create_mux(struct connection *conn, int *closed_connection)
 {
 	if (closed_connection)