Added copyright and license

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

diff --git a/cds/urcu/exempt_ptr.h b/cds/urcu/exempt_ptr.h
index 1b052691aa7b55e4ca40bf4df823cb1155e5a604..d1ec619ba6f92a59bab3eb6aa1f130d7267a27e0 100644 (file)
--- a/cds/urcu/exempt_ptr.h
+++ b/cds/urcu/exempt_ptr.h
@@ -1,7 +1,35 @@
-//$$CDS-header$$
-
-#ifndef __CDS_URCU_EXEMPT_PTR_H
-#define __CDS_URCU_EXEMPT_PTR_H
+/*
+    This file is a part of libcds - Concurrent Data Structures library
+
+    (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_EXEMPT_PTR_H
+#define CDSLIB_URCU_EXEMPT_PTR_H
 
 #include <type_traits>
 #include <cds/details/defs.h>
@@ -37,6 +65,7 @@ namespace cds { namespace urcu {
         For non-intrusive containers from \p cds::container namespace \p Disposer is usually an invocation
         of node deallocator. For intrusive containers the disposer can be empty or it can trigger an event "node can be reused safely".
         In any case, the exempt pointer concept keeps RCU semantics.
+        The destructor or \p release() should be called outside the RCU lock of current thread.
 
         You don't need use this helper class directly. Any RCU-based container typedefs a simplified version of this template.
 
@@ -45,7 +74,7 @@ namespace cds { namespace urcu {
         - \p NodeType - container's node type
         - \p ValueType - value type stored in container's node. For intrusive containers it is the same as \p NodeType
         - \p Disposer - a disposer functor
-        - \p Cast - a functor for casting from \p NodeType to \p ValueType. For intrusive containers 
+        - \p Cast - a functor for casting from \p NodeType to \p ValueType. For intrusive containers
             the casting is usually disabled, i.e. \p Cast is \p void.
     */
     template <
@@ -108,7 +137,7 @@ namespace cds { namespace urcu {
         /// The exempt pointer is not copy-constructible
         exempt_ptr( exempt_ptr const& ) = delete;
 
-        /// Releases the pointer
+        /// Releases the pointer, see \p release()
         ~exempt_ptr()
         {
             release();
@@ -163,4 +192,4 @@ namespace cds { namespace urcu {
     };
 }} // namespace cds::urcu
 
-#endif //#ifndef __CDS_URCU_EXEMPT_PTR_H
+#endif //#ifndef CDSLIB_URCU_EXEMPT_PTR_H