aboutsummaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authorrussell <russell@f38db490-d61c-443f-a65b-d21fe96a405b>2008-11-07 15:01:45 +0000
committerrussell <russell@f38db490-d61c-443f-a65b-d21fe96a405b>2008-11-07 15:01:45 +0000
commitc00ef2b90a5ce417c4b8ff615fad98321792de89 (patch)
tree8118dec64603543becbd03baf5cce41b9afac747 /include
parent520ec7a9a7753c2b88dcd0d053f9078f19cc6615 (diff)
Merged revisions 155244 via svnmerge from
https://origsvn.digium.com/svn/asterisk/trunk ........ r155244 | russell | 2008-11-07 09:01:02 -0600 (Fri, 07 Nov 2008) | 4 lines Clarify which part of OBJ_MULTIPLE is not implemented, and under what case it is perfectly fine to use. (Inspired by a question I received about my last commit.) ........ git-svn-id: http://svn.digium.com/svn/asterisk/branches/1.6.1@155245 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'include')
-rw-r--r--include/asterisk/astobj2.h9
1 files changed, 6 insertions, 3 deletions
diff --git a/include/asterisk/astobj2.h b/include/asterisk/astobj2.h
index fd22b3be4..ec8e2c55e 100644
--- a/include/asterisk/astobj2.h
+++ b/include/asterisk/astobj2.h
@@ -511,7 +511,7 @@ Operations on container include:
can be:
OBJ_UNLINK - to remove the object, once found, from the container.
OBJ_NODATA - don't return the object if found (no ref count change)
- OBJ_MULTIPLE - don't stop at first match (not implemented)
+ OBJ_MULTIPLE - don't stop at first match (not fully implemented)
OBJ_POINTER - if set, 'arg' is an object pointer, and a hashtable
search will be done. If not, a traversal is done.
@@ -523,7 +523,7 @@ Operations on container include:
- flags can be
OBJ_UNLINK - to remove the object, once found, from the container.
OBJ_NODATA - don't return the object if found (no ref count change)
- OBJ_MULTIPLE - don't stop at first match (not implemented)
+ OBJ_MULTIPLE - don't stop at first match (not fully implemented)
OBJ_POINTER - if set, 'arg' is an object pointer, and a hashtable
search will be done. If not, a traversal is done through
all the hashtable 'buckets'..
@@ -615,7 +615,10 @@ enum search_flags {
* its refcount. */
OBJ_NODATA = (1 << 1),
/*! Don't stop at the first match in ao2_callback()
- * \note This is not fully implemented. */
+ * \note This is not fully implemented. Using OBJ_MULTIME with OBJ_NODATA
+ * is perfectly fine. The part that is not implemented is the case where
+ * multiple objects should be returned by ao2_callback().
+ */
OBJ_MULTIPLE = (1 << 2),
/*! obj is an object of the same type as the one being searched for,
* so use the object's hash function for optimized searching.