Note on new get opaque function

diff --git a/src/main/connection.c b/src/main/connection.c
index de2de4de86486f3eab31a964fdddbfa22eeb4609..23ce8a34f2cc2075890166ddf35658ddd9ce59b1 100644 (file)
--- a/src/main/connection.c
+++ b/src/main/connection.c
@@ -1246,6 +1246,10 @@ int fr_connection_pool_get_num(fr_connection_pool_t *pool)
 }
 
 /** Get the opaque data associated with a pool
+ *
+ * @note returned pointer is left non-const intentionally. It's up to the caller
+ *     to ensure that if it makes modifications to the opaque data, there are
+ *     no side effects.
  *
  * @param pool to retrieve opaque data for.
  * @return the opaque data for the pool.