explicitly point out the lifetime of value in push

wavii · Jul 29, 2012 · 1784a90 · 1784a90
1 parent 438a9a2
commit 1784a90
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/include/darner/queue.hpp b/include/darner/queue.hpp
@@ -69,7 +69,8 @@ class queue
 
    /*
     * pushes a value into the queue.  calls cb after the write with a success code.  on failure, sets error as
-    * io_error if there was a problem with the underlying journal
+    * io_error if there was a problem with the underlying journal.  this method does not manage the lifetime of
+    * the value passed to it - the caller must leave the value unchanged until after cb is called.
     */
    void push(const std::string& value, const push_callback& cb)
    {