From: Arran Cudbard-Bell <a.cudbardb@freeradius.org>
Date: Sat, 27 Jun 2015 21:32:31 +0000 (-0400)
Subject: Note on new get opaque function
X-Git-Tag: release_3_0_9~47
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=19ff37d9d076ac30bc5860277c7ccaca0afe8ae6;p=thirdparty%2Ffreeradius-server.git

Note on new get opaque function
---

diff --git a/src/main/connection.c b/src/main/connection.c
index de2de4de864..23ce8a34f2c 100644
--- 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.