Removed trailing spaces

[libcds.git] / cds / urcu / signal_threaded.h

diff --git a/cds/urcu/signal_threaded.h b/cds/urcu/signal_threaded.h
index 68a3adf6164baf9179b4fbe5f5ef8aeef5bae727..80a5ed8c39586b7b0f39187fd004d42defecbd66 100644 (file)
--- a/cds/urcu/signal_threaded.h
+++ b/cds/urcu/signal_threaded.h
@@ -1,7 +1,35 @@
-//$$CDS-header$$
+/*
+    This file is a part of libcds - Concurrent Data Structures library
 
-#ifndef _CDS_URCU_SIGNAL_THREADED_H
-#define _CDS_URCU_SIGNAL_THREADED_H
+    (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2016
+
+    Source code repo: http://github.com/khizmax/libcds/
+    Download: http://sourceforge.net/projects/libcds/files/
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, this
+      list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+    DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+    SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+    OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+#ifndef CDSLIB_URCU_SIGNAL_THREADED_H
+#define CDSLIB_URCU_SIGNAL_THREADED_H
 
 #include <cds/urcu/details/sig_threaded.h>
 
@@ -12,24 +40,21 @@ namespace cds { namespace urcu {
     /// User-space signal-handled RCU with special thread for deferred reclamation
     /** @anchor cds_urcu_signal_threaded_gc
 
-        This is a wrapper around signal_threaded class used for metaprogramming.
+        This is a wrapper around \p signal_threaded class.
 
         Template arguments:
-        - \p Buffer - lock-free queue or lock-free bounded queue.
-            Default is cds::container::VyukovMPMCCycleQueue< retired_ptr >
+        - \p Buffer - lock-free MPSC (muliple producer/single consumer) queue.
+            Default is \p cds::container::VyukovMPSCCycleQueue< epoch_retired_ptr >
         - \p Lock - mutex type, default is \p std::mutex
         - \p DisposerThread - reclamation thread class, default is \p %general_threaded_dispose_thread
             See \ref cds::urcu::dispose_thread for class interface.
-        - \p Backoff - back-off schema, default is cds::backoff::Default
+        - \p Backoff - back-off schema, default is \p cds::backoff::Default
 
     */
     template <
 #ifdef CDS_DOXGEN_INVOKED
-        class Buffer = cds::container::VyukovMPMCCycleQueue<
-            epoch_retired_ptr
-            ,cds::opt::buffer< cds::opt::v::dynamic_buffer< epoch_retired_ptr > >
-        >
-        ,class Lock = cds_std::mutex
+        class Buffer = cds::container::VyukovMPSCCycleQueue< epoch_retired_ptr >
+        ,class Lock = std::mutex
         ,class DisposerThread = dispose_thread<Buffer>
         ,class Backoff = cds::backoff::Default
 #else
@@ -117,6 +142,13 @@ namespace cds { namespace urcu {
             rcu_implementation::instance()->batch_retire( itFirst, itLast );
         }
 
+        /// Retires the pointer chain until \p Func returns \p nullptr retired pointer
+        template <typename Func>
+        static void batch_retire( Func e )
+        {
+            rcu_implementation::instance()->batch_retire( e );
+        }
+
          /// Acquires access lock (so called RCU reader-side lock)
         /**
             For safety reasons, it is better to use \ref scoped_lock class for locking/unlocking
@@ -168,7 +200,13 @@ namespace cds { namespace urcu {
         }
     };
 
+    //@cond
+    template<>
+    class gc< signal_threaded_stripped >: public gc< signal_threaded<>>
+    {};
+    //@endcond
+
 }} // namespace cds::urcu
 
 #endif // #ifdef CDS_URCU_SIGNAL_HANDLING_ENABLED
-#endif // #ifndef _CDS_URCU_SIGNAL_THREADED_H
+#endif // #ifndef CDSLIB_URCU_SIGNAL_THREADED_H