luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-25 15:06:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

gobject: Mention quark memory usage for g_object_set_data()

Browse Source 
g_object_set_data() should only ever be used with a small, bounded set
of keys, or the memory usage of the quark lookup table will grow
unbounded. Document that.

Signed-off-by: Philip Withnall <withnall@endlessm.com>

Fixes: #682
This commit is contained in:
Philip Withnall 2019-03-07 10:56:47 +00:00
parent c9c88a4b22
commit 2a570dc5af
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
gobject/gobject.c
View File

@ -3629,6 +3629,11 @@ g_object_get_data (GObject *object,
*
* If the object already had an association with that name,
* the old association will be destroyed.
*
* Internally, the @key is converted to a #GQuark using g_quark_from_string().
* This means a copy of @key is kept permanently (even after @object has been
* finalized) — so it is recommended to only use a small, bounded set of values
* for @key in your program, to avoid the #GQuark storage growing unbounded.
*/
void
g_object_set_data (GObject *object,
@ -3707,6 +3712,9 @@ g_object_dup_data (GObject *object,
* or may not include using @old_destroy as sometimes replacement
* should not destroy the object in the normal way.
*
* See g_object_set_data() for guidance on using a small, bounded set of values
* for @key.
*
* Returns: %TRUE if the existing value for @key was replaced
* by @newval, %FALSE otherwise.
*