[asterisk-commits] russell: branch 1.4 r90310 - /branches/1.4/include/asterisk/astobj2.h

[SVN commits to the Asterisk project]

Author: russell
Date: Fri Nov 30 12:46:46 2007
New Revision: 90310

URL: http://svn.digium.com/view/asterisk?view=rev&rev=90310
Log:
Add some notes on the behavior of ao2_unlink() after a discussion with Tilghman

Modified:
    branches/1.4/include/asterisk/astobj2.h

Modified: branches/1.4/include/asterisk/astobj2.h
URL: http://svn.digium.com/view/asterisk/branches/1.4/include/asterisk/astobj2.h?view=diff&rev=90310&r1=90309&r2=90310
==============================================================================
--- branches/1.4/include/asterisk/astobj2.h (original)
+++ branches/1.4/include/asterisk/astobj2.h Fri Nov 30 12:46:46 2007
@@ -367,7 +367,24 @@
  */
 #define ao2_link(c, o) __ao2_link(c, o, 0)
 void *__ao2_link(struct ao2_container *c, void *newobj, int iax2_hack);
-void *ao2_unlink(struct ao2_container *c, void *newobj);
+/*!
+ * \brief Remove an object from the container
+ *
+ * \arg c the container
+ * \arg obj the object to unlink
+ *
+ * \retval NULL, always
+ *
+ * \note The object requested to be unlinked must be valid.  However, if it turns
+ *       out that it is not in the container, this function is still safe to
+ *       be called.
+ *
+ * \note If the object gets unlinked from the container, the container's
+ *       reference to the object will be automatically released.  This is
+ *       slightly different than ao2_link(), which inherits a reference instead
+ *       of automatically increasing the reference count.
+ */
+void *ao2_unlink(struct ao2_container *c, void *obj);
 
 /*! \struct Used as return value if the flag OBJ_MULTIPLE is set */
 struct ao2_list {