Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r57570 - sandbox/stm/branches/vbe/libs/stm/doc/html/toward_boost_stm/reference
From: vicente.botet_at_[hidden]
Date: 2009-11-11 11:03:55

Author: viboes
Date: 2009-11-11 11:03:52 EST (Wed, 11 Nov 2009)
New Revision: 57570
URL: http://svn.boost.org/trac/boost/changeset/57570

Log:
TBoost.STM vbe: doc reorganization: html files

Added:
   sandbox/stm/branches/vbe/libs/stm/doc/html/toward_boost_stm/reference/core.html (contents, props changed)
   sandbox/stm/branches/vbe/libs/stm/doc/html/toward_boost_stm/reference/deep_transactional_objects.html (contents, props changed)
   sandbox/stm/branches/vbe/libs/stm/doc/html/toward_boost_stm/reference/mixins.html (contents, props changed)
   sandbox/stm/branches/vbe/libs/stm/doc/html/toward_boost_stm/reference/mixins_transactional_objects.html (contents, props changed)
   sandbox/stm/branches/vbe/libs/stm/doc/html/toward_boost_stm/reference/shallow_transactional_objects.html (contents, props changed)
   sandbox/stm/branches/vbe/libs/stm/doc/html/toward_boost_stm/reference/warppers.html (contents, props changed)
   sandbox/stm/branches/vbe/libs/stm/doc/html/toward_boost_stm/reference/warppers_transactional_objects.html (contents, props changed)

Added: sandbox/stm/branches/vbe/libs/stm/doc/html/toward_boost_stm/reference/core.html
==============================================================================
--- (empty file)
+++ sandbox/stm/branches/vbe/libs/stm/doc/html/toward_boost_stm/reference/core.html 2009-11-11 11:03:52 EST (Wed, 11 Nov 2009)
@@ -0,0 +1,1967 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Core</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../../index.html" title="Chapter 1. Toward.Boost.STM">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="stm_hpp.html" title=" Header <boost/stm.hpp>">
+<link rel="next" href="mixins_transactional_objects.html" title="Mixins
+ Transactional Objects">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="TowardBoostSTM" width="277" height="86" src="../../../image/Toward_Boost_STM.jpg"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="stm_hpp.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="mixins_transactional_objects.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_stm.reference.core"></a>Core
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="core.html#toward_boost_stm.reference.core.base_transaction_object_hpp">
+ Header <code class="computeroutput"><boost/stm/base_transaction_object.hpp></code></a></dt>
+<dd><dl><dt><a href="core.html#toward_boost_stm.reference.core.base_transaction_object_hpp.abstract_class__base_transaction_object_">Abstract
+ Class <code class="computeroutput">base_transaction_object</code></a></dt></dl></dd>
+<dt><a href="core.html#toward_boost_stm.reference.core.cache_fct_hpp"> Header
+ <code class="computeroutput"><boost/stm/cache_fct.hpp></code></a></dt>
+<dd><dl>
+<dt><a href="core.html#toward_boost_stm.reference.core.cache_fct_hpp.template_function__cache_clone_____">Template
+ Function <code class="computeroutput">cache_clone<>()</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.cache_fct_hpp.template_function__cache_copy_____">Template
+ Function <code class="computeroutput">cache_copy<>()</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.cache_fct_hpp.function__cache_release_____">Function
+ <code class="computeroutput">cache_release<>()</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.cache_fct_hpp.template_function__cache_allocate_____">Template
+ Function <code class="computeroutput">cache_allocate<>()</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.cache_fct_hpp.template_function__cache_deallocate_____">Template
+ Function <code class="computeroutput">cache_deallocate<>()</code></a></dt>
+</dl></dd>
+<dt><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp"> Header
+ <code class="computeroutput"><boost/stm/datatypes.hpp></code></a></dt>
+<dd><dl>
+<dt><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.enum__transaction_type_">Enum
+ <code class="computeroutput">transaction_type</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.enum__latm_type_">Enum
+ <code class="computeroutput">latm_type</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.enum__transaction_state_">Enum
+ <code class="computeroutput">transaction_state</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.typedef__new_memory_t_">Typedef
+ <code class="computeroutput">new_memory_t</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.typedef__priority_t_">Typedef
+ <code class="computeroutput">priority_t</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.typedef__clock_t_">Typedef
+ <code class="computeroutput">clock_t</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.typedef__version_t_">Typedef
+ <code class="computeroutput">version_t</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.typedef__thread_id_t_">Typedef
+ <code class="computeroutput">thread_id_t</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.function__invalid_thread_id___">Function
+ <code class="computeroutput">invalid_thread_id()</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.function__this_thread__get_id___">Function
+ <code class="computeroutput">this_thread::get_id()</code></a></dt>
+</dl></dd>
+<dt><a href="core.html#toward_boost_stm.reference.core.exceptions_hpp"> Header
+ <code class="computeroutput"><boost/stm/exceptions.hpp></code></a></dt>
+<dd><dl><dt><a href="core.html#toward_boost_stm.reference.core.exceptions_hpp.class__aborted_transaction_exception_">Class
+ <code class="computeroutput">aborted_transaction_exception</code></a></dt></dl></dd>
+<dt><a href="core.html#toward_boost_stm.reference.core.language_like_hpp">
+ Header <code class="computeroutput"><boost/stm/language_like.hpp></code></a></dt>
+<dd><dl>
+<dt><a href="core.html#toward_boost_stm.reference.core.language_like_hpp.macro__atomic_">Macro
+ <code class="computeroutput">atomic</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.language_like_hpp.macro__try_atomic_">Macro
+ <code class="computeroutput">try_atomic</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.language_like_hpp.macro__use_atomic_">Macro
+ <code class="computeroutput">use_atomic</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.language_like_hpp.macro__catch_before_retry_">Macro
+ <code class="computeroutput">catch_before_retry</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.language_like_hpp.macro__before_retry_">Macro
+ <code class="computeroutput">before_retry</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.language_like_hpp.macro__end_atom_">Macro
+ <code class="computeroutput">end_atom</code></a></dt>
+</dl></dd>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp"> Header
+ <code class="computeroutput"><boost/stm/transaction.hpp></code></a></dt>
+<dd><dl>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_">Class
+ <code class="computeroutput">transaction</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.struct__thread_initializer_">Struct
+ <code class="computeroutput">thread_initializer</code></a></dt>
+</dl></dd>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_bookkeeping_hpp">
+ Header <code class="computeroutput"><boost/stm/transaction_bookkeeping.hpp></code></a></dt>
+<dd><dl><dt><a href="core.html#toward_boost_stm.reference.core.transaction_bookkeeping_hpp.class__transaction_bookkeeping_">Class
+ <code class="computeroutput">transaction_bookkeeping</code></a></dt></dl></dd>
+</dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_stm.reference.core.base_transaction_object_hpp"></a><a href="core.html#toward_boost_stm.reference.core.base_transaction_object_hpp" title="
+ Header <boost/stm/base_transaction_object.hpp>">
+ Header <code class="computeroutput"><boost/stm/base_transaction_object.hpp></code></a>
+</h4></div></div></div>
+<div class="toc"><dl><dt><a href="core.html#toward_boost_stm.reference.core.base_transaction_object_hpp.abstract_class__base_transaction_object_">Abstract
+ Class <code class="computeroutput">base_transaction_object</code></a></dt></dl></div>
+<pre class="programlisting">namespace boost { namespace stm {
+ class base_transaction_object;
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.core.base_transaction_object_hpp.abstract_class__base_transaction_object_"></a><a href="core.html#toward_boost_stm.reference.core.base_transaction_object_hpp.abstract_class__base_transaction_object_" title="Abstract
+ Class base_transaction_object">Abstract
+ Class <code class="computeroutput">base_transaction_object</code></a>
+</h5></div></div></div>
+<div class="toc"><dl>
+<dt><a href="core.html#toward_boost_stm.reference.core.base_transaction_object_hpp.abstract_class__base_transaction_object_.constructor__base_transaction_object___">Constructor
+ <code class="computeroutput">base_transaction_object()</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.base_transaction_object_hpp.abstract_class__base_transaction_object_.virtual_destructor___base_transaction_object___">Virtual
+ Destructor <code class="computeroutput">~base_transaction_object()</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.base_transaction_object_hpp.abstract_class__base_transaction_object_.virtual_function__copy_state___">Virtual
+ function <code class="computeroutput">copy_state()</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.base_transaction_object_hpp.abstract_class__base_transaction_object_.virtual_function__move_state___">Virtual
+ function <code class="computeroutput">move_state()</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.base_transaction_object_hpp.abstract_class__base_transaction_object_.static_function__retrieve_mem___">Static
+ function <code class="computeroutput">retrieve_mem()</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.base_transaction_object_hpp.abstract_class__base_transaction_object_.static_function__return_mem___">Static
+ function <code class="computeroutput">return_mem()</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.base_transaction_object_hpp.abstract_class__base_transaction_object_.static_function__alloc_size___">Static
+ function <code class="computeroutput">alloc_size()</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.base_transaction_object_hpp.abstract_class__base_transaction_object_.virtual_function__cache_deallocate___">Virtual
+ function <code class="computeroutput">cache_deallocate()</code></a></dt>
+</dl></div>
+
+ This is the base class of all the transactional objects. It tracks:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+<code class="computeroutput">transactionThread_</code>:
+ the thread identifier holding the write acces to this transactional
+ object
+ </li>
+<li>
+<code class="computeroutput">transaction_</code>: the pointer
+ to the transaction
+ </li>
+<li>
+<code class="computeroutput">version_</code>: the version
+ when performing validation
+ </li>
+<li>
+<code class="computeroutput">newMemory_</code>: states
+ whether this object is a new object
+ </li>
+</ul></div>
+
+ Transactional objets must specialize the pure virtual functions
+ 
+<div class="itemizedlist"><ul type="disc">
+<li><code class="computeroutput">copy_state(base_transaction_object const
+ * const
+ rhs)</code></li>
+<li>
+<code class="computeroutput">move_state(base_transaction_object *
+ rhs)</code>
+ if <code class="computeroutput">BUILD_MOVE_SEMANTICS</code>
+</li>
+<li>
+<code class="computeroutput">cache_deallocate()</code>
+ if <code class="computeroutput">BOOST_STM_USE_UNASIGNED_COPY</code>
+</li>
+</ul></div>
+
+ <code class="computeroutput">copy_state</code> is used to
+ copy the backup/working copy to the shared transactional object when
+ the roolback/commit is done direct/defered policy is used.
+ 
+
+ <code class="computeroutput">move_state</code> is used to
+ move the backup/working copy to the shared transactional object when
+ the roolback/commit is done direct/defered policy is used.
+ 
+
+ <code class="computeroutput">cache_deallocate</code> is used
+ to release the backup/working copy when the transaction ends if direct/defered
+ policy is used.
+ 
+
+ When USE_STM_MEMORY_MANAGER is defined this class provides two functions
+ (<code class="computeroutput">retrieve_mem</code> and <code class="computeroutput">return_mem</code>) and to manage a pool of
+ memory.
+ 
+<pre class="programlisting">class base_transaction_object
+{
+public:
+
+ base_transaction_object();
+ virtual ~base_transaction_object() {};
+
+ virtual base_transaction_object* clone() const = 0;
+ virtual void copy_state(base_transaction_object const * const rhs) = 0;
+ virtual void move_state(base_transaction_object * rhs) = 0;
+
+ void transaction_thread(thread_id rhs) const;
+ thread_id transaction_thread() const;
+
+ void new_memory(bool rhs)
+ bool new_memory() const;
+
+#if BOOST_STM_PERFORMING_VALIDATION
+ void version(std::size_t rhs);
+ std::size_t version() const;
+#endif
+
+#if BOOST_STM_USE_MEMORY_MANAGER
+ static void return_mem(void *mem, size_t size);
+ static void* retrieve_mem(size_t size);
+ static void alloc_size(size_t size);
+#endif
+
+#ifdef BOOST_STM_USE_UNASIGNED_COPY
+ virtual void cache_deallocate()=0;
+#endif
+
+};
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.base_transaction_object_hpp.abstract_class__base_transaction_object_.constructor__base_transaction_object___"></a><a href="core.html#toward_boost_stm.reference.core.base_transaction_object_hpp.abstract_class__base_transaction_object_.constructor__base_transaction_object___" title="Constructor
+ base_transaction_object()">Constructor
+ <code class="computeroutput">base_transaction_object()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">base_transaction_object();
+</pre>
+
+ Default constructor (ctor) with no parameters allows derived base_transaction_objects
+ to implicitly construct the base_transaction_object base class for
+ easier integration.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.base_transaction_object_hpp.abstract_class__base_transaction_object_.virtual_destructor___base_transaction_object___"></a><a href="core.html#toward_boost_stm.reference.core.base_transaction_object_hpp.abstract_class__base_transaction_object_.virtual_destructor___base_transaction_object___" title="Virtual
+ Destructor ~base_transaction_object()">Virtual
+ Destructor <code class="computeroutput">~base_transaction_object()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual ~base_transaction_object() {};
+</pre>
+
+ Virtual destructor (dtor) ensures correct destructors are called in
+ the inheritance hierarchy for delete operations invoked on base_transaction_object
+ pointers, which occur in numerous places throughout the internal transaction
+ code.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.base_transaction_object_hpp.abstract_class__base_transaction_object_.virtual_function__copy_state___"></a><a href="core.html#toward_boost_stm.reference.core.base_transaction_object_hpp.abstract_class__base_transaction_object_.virtual_function__copy_state___" title="Virtual
+ function copy_state()">Virtual
+ function <code class="computeroutput">copy_state()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void copy_state(base_transaction_object const * const rhs) = 0;
+</pre>
+
+ The <code class="computeroutput">copy_state()</code>
+ method is called each time global memory is updated, for either direct
+ or deferred updating policies. With this in mind, it is vital that
+ the this object be set to the exact state of the input parameter.
+ 
+
+ Derived classes usually simply override this method and perform an
+ <code class="computeroutput">operator=()</code>
+ function call for the specific derived type.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.base_transaction_object_hpp.abstract_class__base_transaction_object_.virtual_function__move_state___"></a><a href="core.html#toward_boost_stm.reference.core.base_transaction_object_hpp.abstract_class__base_transaction_object_.virtual_function__move_state___" title="Virtual
+ function move_state()">Virtual
+ function <code class="computeroutput">move_state()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void move_state(base_transaction_object * rhs) = 0;
+</pre>
+
+ The move_state() method is internally called at deferred updating commit
+ time and at direct updating abort time and invokes the user-defined
+ derived transaction class's move assignment (e.g. operator=(type &&)).
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.base_transaction_object_hpp.abstract_class__base_transaction_object_.static_function__retrieve_mem___"></a><a href="core.html#toward_boost_stm.reference.core.base_transaction_object_hpp.abstract_class__base_transaction_object_.static_function__retrieve_mem___" title="Static
+ function retrieve_mem()">Static
+ function <code class="computeroutput">retrieve_mem()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static void* retrieve_mem(size_t size);
+</pre>
+
+ Static interface into TBoost.STM's memory management system for retrieving
+ memory. The supplied parameter is the requested block size, the return
+ parameter is a void* to the allocated block. Usually access to this
+ interface is done by overloading operator new in the derived base_transaction_object
+ class. Void pointers are the natural and preferred manner to handle
+ memory allocations and deallocations and are therefore safe in this
+ context.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.base_transaction_object_hpp.abstract_class__base_transaction_object_.static_function__return_mem___"></a><a href="core.html#toward_boost_stm.reference.core.base_transaction_object_hpp.abstract_class__base_transaction_object_.static_function__return_mem___" title="Static
+ function return_mem()">Static
+ function <code class="computeroutput">return_mem()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static void return_mem(void *mem, size_t size);
+</pre>
+
+ Static interface into TBoost.STM's memory management system for returning
+ memory. The first parameter points to the memory block being returned,
+ the second parameter specifies its size. Usually access to this interface
+ is done by overloading operator delete in the derived transaction object
+ class. Void pointers are the natural and preferred manner to handle
+ memory allocations and deallocations and are therefore safe in this
+ context.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.base_transaction_object_hpp.abstract_class__base_transaction_object_.static_function__alloc_size___"></a><a href="core.html#toward_boost_stm.reference.core.base_transaction_object_hpp.abstract_class__base_transaction_object_.static_function__alloc_size___" title="Static
+ function alloc_size()">Static
+ function <code class="computeroutput">alloc_size()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static void alloc_size(size_t size);
+</pre>
+
+ Static interface into TBoost.STM's memory management system which allows
+ the user to specify the allocation chunk size for the memory manager.
+ The input parameter specifies the number of transactional objects that
+ should be allocated at startup and with each subsequent buffer increase.
+ If no size is specified, the allocation chunk size uses TBoost.STM's
+ default value, currently 8192. The alloc_size() interface can be reconfigured
+ at runtime and is used upon the next buffer increase.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.base_transaction_object_hpp.abstract_class__base_transaction_object_.virtual_function__cache_deallocate___"></a><a href="core.html#toward_boost_stm.reference.core.base_transaction_object_hpp.abstract_class__base_transaction_object_.virtual_function__cache_deallocate___" title="Virtual
+ function cache_deallocate()">Virtual
+ function <code class="computeroutput">cache_deallocate()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void cache_deallocate()=0;
+</pre>
+</div>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_stm.reference.core.cache_fct_hpp"></a><a href="core.html#toward_boost_stm.reference.core.cache_fct_hpp" title=" Header
+ <boost/stm/cache_fct.hpp>"> Header
+ <code class="computeroutput"><boost/stm/cache_fct.hpp></code></a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="core.html#toward_boost_stm.reference.core.cache_fct_hpp.template_function__cache_clone_____">Template
+ Function <code class="computeroutput">cache_clone<>()</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.cache_fct_hpp.template_function__cache_copy_____">Template
+ Function <code class="computeroutput">cache_copy<>()</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.cache_fct_hpp.function__cache_release_____">Function
+ <code class="computeroutput">cache_release<>()</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.cache_fct_hpp.template_function__cache_allocate_____">Template
+ Function <code class="computeroutput">cache_allocate<>()</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.cache_fct_hpp.template_function__cache_deallocate_____">Template
+ Function <code class="computeroutput">cache_deallocate<>()</code></a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost { namespace stm {
+ template <class T> T* cache_clone(const T& val);
+ template <class T> void cache_copy(const T* const ori, T* target);
+ void cache_release(base_transaction_object* ptr);
+
+ template <class T> T* cache_allocate();
+ template <class T> void cache_deallocate(T*);
+
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.core.cache_fct_hpp.template_function__cache_clone_____"></a><a href="core.html#toward_boost_stm.reference.core.cache_fct_hpp.template_function__cache_clone_____" title="Template
+ Function cache_clone<>()">Template
+ Function <code class="computeroutput">cache_clone<>()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">template <class T>
+T* cache_clone(const T& val);
+</pre>
+
+ Makes a new copy of the parameter. Allocates an object of type T using
+ the <code class="computeroutput">cache_allocate</code> function
+ and copy from the given parameter <code class="computeroutput">val</code>
+ using the free function <code class="computeroutput">cache_copy</code>.
+ 
+
+ The user can overload this function, as TBoost.STM uses ADL to access
+ it.
+ 
+
+ When <code class="computeroutput">BOOST_STM_NO_PARTIAL_SPECIALIZATION</code>
+ is defined, i.e. on compilers not supporting partial template specialization,
+ the function calls to <code class="computeroutput">partial_specialization_workaround::cache_clone<T>::apply(val)</code>. So the user will need to overload the
+ class <code class="computeroutput">partial_specialization_workaround::cache_clone<T></code> defining the function
+ 
+<pre class="programlisting">static T* apply(const T& val);
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.core.cache_fct_hpp.template_function__cache_copy_____"></a><a href="core.html#toward_boost_stm.reference.core.cache_fct_hpp.template_function__cache_copy_____" title="Template
+ Function cache_copy<>()">Template
+ Function <code class="computeroutput">cache_copy<>()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">template <class T>
+void cache_copy(const T* const source, T* target);
+</pre>
+
+ Copy from souce to target using memcpy by default.
+ 
+
+ The user can overload this function, as TBoost.STM uses ADL to access
+ it.
+ 
+
+ When <code class="computeroutput">BOOST_STM_NO_PARTIAL_SPECIALIZATION</code>
+ is defined, i.e. on compilers not supporting partial template specialization,
+ the function calls to <code class="computeroutput">partial_specialization_workaround::cache_copy<T>::apply(source, target)</code>. So the user will need to overload the
+ class <code class="computeroutput">partial_specialization_workaround::cache_copy<T></code> defining the function
+ 
+<pre class="programlisting">static T* apply(const T* const source, T* target);
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.core.cache_fct_hpp.function__cache_release_____"></a><a href="core.html#toward_boost_stm.reference.core.cache_fct_hpp.function__cache_release_____" title="Function
+ cache_release<>()">Function
+ <code class="computeroutput">cache_release<>()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">void cache_release(base_transaction_object* ptr) {
+</pre>
+
+ Release the given base_transaction_object by calling to the virtual function
+ <code class="computeroutput">cache_dealocate</code>.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.core.cache_fct_hpp.template_function__cache_allocate_____"></a><a href="core.html#toward_boost_stm.reference.core.cache_fct_hpp.template_function__cache_allocate_____" title="Template
+ Function cache_allocate<>()">Template
+ Function <code class="computeroutput">cache_allocate<>()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">template <class T>
+T* cache_allocate();
+</pre>
+
+ Allocates an instance of calls T. Depending on whether BOOST_STM_CACHE_USE_MEMORY_MANAGER,
+ BOOST_STM_CACHE_USE_MALLOC or BOOST_STM_CACHE_USE_TSS_MONOTONIC_MEMORY_MANAGER
+ are defined this function will use the static pool of the class T, malloc
+ or the thread specific monotonic allocator.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.core.cache_fct_hpp.template_function__cache_deallocate_____"></a><a href="core.html#toward_boost_stm.reference.core.cache_fct_hpp.template_function__cache_deallocate_____" title="Template
+ Function cache_deallocate<>()">Template
+ Function <code class="computeroutput">cache_deallocate<>()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">template <class T>
+void cache_deallocate(T*ptr) {
+</pre>
+
+ Deallocates an instance of calls T. Depending on whether BOOST_STM_CACHE_USE_MEMORY_MANAGER,
+ BOOST_STM_CACHE_USE_MALLOC or BOOST_STM_CACHE_USE_TSS_MONOTONIC_MEMORY_MANAGER
+ are defined this function will use the static pool of the class T, free
+ or the no-op.
+ 
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_stm.reference.core.datatypes_hpp"></a><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp" title=" Header
+ <boost/stm/datatypes.hpp>"> Header
+ <code class="computeroutput"><boost/stm/datatypes.hpp></code></a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.enum__transaction_type_">Enum
+ <code class="computeroutput">transaction_type</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.enum__latm_type_">Enum
+ <code class="computeroutput">latm_type</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.enum__transaction_state_">Enum
+ <code class="computeroutput">transaction_state</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.typedef__new_memory_t_">Typedef
+ <code class="computeroutput">new_memory_t</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.typedef__priority_t_">Typedef
+ <code class="computeroutput">priority_t</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.typedef__clock_t_">Typedef
+ <code class="computeroutput">clock_t</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.typedef__version_t_">Typedef
+ <code class="computeroutput">version_t</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.typedef__thread_id_t_">Typedef
+ <code class="computeroutput">thread_id_t</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.function__invalid_thread_id___">Function
+ <code class="computeroutput">invalid_thread_id()</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.function__this_thread__get_id___">Function
+ <code class="computeroutput">this_thread::get_id()</code></a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost { namespace stm {
+ enum transaction_type;
+ enum latm_type;
+ enum transaction_state;
+ typedef new_memory_t;
+ typedef priority_t;
+ typedef clock_t;
+ typedef milliseconds_t;
+ typedef version_t;
+ typedef thread_id_t;
+ thread_id_t invalid_thread_id();
+ namespace this_thread {
+ thread_id_t get_id();
+ }
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.core.datatypes_hpp.enum__transaction_type_"></a><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.enum__transaction_type_" title="Enum
+ transaction_type">Enum
+ <code class="computeroutput">transaction_type</code></a>
+</h5></div></div></div>
+
+ Type of transaction enumeration.
+ 
+<pre class="programlisting"> enum transaction_type
+ {
+ eNormalTx,
+ eIrrevocableTx,
+ eIrrevocableAndIsolatedTx
+};
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.core.datatypes_hpp.enum__latm_type_"></a><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.enum__latm_type_" title="Enum
+ latm_type">Enum
+ <code class="computeroutput">latm_type</code></a>
+</h5></div></div></div>
+
+ Type of LATM enumeration.
+ 
+<pre class="programlisting">enum latm_type
+{
+ eFullLatmProtection,
+ eTmConflictingLockLatmProtection,
+ eTxConflictingLockLatmProtection
+};
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.core.datatypes_hpp.enum__transaction_state_"></a><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.enum__transaction_state_" title="Enum
+ transaction_state">Enum
+ <code class="computeroutput">transaction_state</code></a>
+</h5></div></div></div>
+
+ Transaction states enumeration.
+ 
+<pre class="programlisting">enum transaction_state
+{
+ e_no_state = -1, // no state is -1
+ e_aborted, // ensure aborted = 0
+ e_committed, // committed is positive
+ e_hand_off, // so is handoff in case bool conversion
+ e_in_flight
+};
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.core.datatypes_hpp.typedef__new_memory_t_"></a><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.typedef__new_memory_t_" title="Typedef
+ new_memory_t">Typedef
+ <code class="computeroutput">new_memory_t</code></a>
+</h5></div></div></div>
+
+ This type should be bool, but for alignements purposes is a int.
+ 
+<pre class="programlisting">typedef int new_memory_t;
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.core.datatypes_hpp.typedef__priority_t_"></a><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.typedef__priority_t_" title="Typedef
+ priority_t">Typedef
+ <code class="computeroutput">priority_t</code></a>
+</h5></div></div></div>
+
+ Type used for the user contention management with transaction priority.
+ 
+<pre class="programlisting">typedef std::size_t priority_t;
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.core.datatypes_hpp.typedef__clock_t_"></a><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.typedef__clock_t_" title="Typedef
+ clock_t">Typedef
+ <code class="computeroutput">clock_t</code></a>
+</h5></div></div></div>
+
+ Type used to represent the time.
+ 
+<pre class="programlisting">typedef std::size_t clock_t;
+typedef std::size_t milliseconds_t;
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.core.datatypes_hpp.typedef__version_t_"></a><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.typedef__version_t_" title="Typedef
+ version_t">Typedef
+ <code class="computeroutput">version_t</code></a>
+</h5></div></div></div>
+
+ Type used for validation using the version algorithm.
+ 
+<pre class="programlisting">typedef std::size_t version_t;
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.core.datatypes_hpp.typedef__thread_id_t_"></a><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.typedef__thread_id_t_" title="Typedef
+ thread_id_t">Typedef
+ <code class="computeroutput">thread_id_t</code></a>
+</h5></div></div></div>
+
+ Thread id type, which is platform dependent.
+ 
+<pre class="programlisting">typedef platform_specific thread_id_t;
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.core.datatypes_hpp.function__invalid_thread_id___"></a><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.function__invalid_thread_id___" title="Function
+ invalid_thread_id()">Function
+ <code class="computeroutput">invalid_thread_id()</code></a>
+</h5></div></div></div>
+
+ Invalid thread_id_t value.
+ 
+<pre class="programlisting">thread_id_t invalid_thread_id();
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.core.datatypes_hpp.function__this_thread__get_id___"></a><a href="core.html#toward_boost_stm.reference.core.datatypes_hpp.function__this_thread__get_id___" title="Function
+ this_thread::get_id()">Function
+ <code class="computeroutput">this_thread::get_id()</code></a>
+</h5></div></div></div>
+
+ thread_id_t for the current thread.
+ 
+<pre class="programlisting">namespace this_thread {
+ inline thread_id_t get_id() {
+}
+</pre>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_stm.reference.core.exceptions_hpp"></a><a href="core.html#toward_boost_stm.reference.core.exceptions_hpp" title=" Header
+ <boost/stm/exceptions.hpp>"> Header
+ <code class="computeroutput"><boost/stm/exceptions.hpp></code></a>
+</h4></div></div></div>
+<div class="toc"><dl><dt><a href="core.html#toward_boost_stm.reference.core.exceptions_hpp.class__aborted_transaction_exception_">Class
+ <code class="computeroutput">aborted_transaction_exception</code></a></dt></dl></div>
+<pre class="programlisting">namespace boost { namespace stm {
+ class aborted_transaction_exception;
+}}
+</pre>
+<div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.core.exceptions_hpp.class__aborted_transaction_exception_"></a><a href="core.html#toward_boost_stm.reference.core.exceptions_hpp.class__aborted_transaction_exception_" title="Class
+ aborted_transaction_exception">Class
+ <code class="computeroutput">aborted_transaction_exception</code></a>
+</h5></div></div></div></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_stm.reference.core.language_like_hpp"></a><a href="core.html#toward_boost_stm.reference.core.language_like_hpp" title="
+ Header <boost/stm/language_like.hpp>">
+ Header <code class="computeroutput"><boost/stm/language_like.hpp></code></a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="core.html#toward_boost_stm.reference.core.language_like_hpp.macro__atomic_">Macro
+ <code class="computeroutput">atomic</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.language_like_hpp.macro__try_atomic_">Macro
+ <code class="computeroutput">try_atomic</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.language_like_hpp.macro__use_atomic_">Macro
+ <code class="computeroutput">use_atomic</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.language_like_hpp.macro__catch_before_retry_">Macro
+ <code class="computeroutput">catch_before_retry</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.language_like_hpp.macro__before_retry_">Macro
+ <code class="computeroutput">before_retry</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.language_like_hpp.macro__end_atom_">Macro
+ <code class="computeroutput">end_atom</code></a></dt>
+</dl></div>
+
+ The complexity behind the <code class="computeroutput">atomic</code>
+ macro is needed to guarantee two fundamental goals.
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ First, transactions must start and end correctly.
+ </li>
+<li>
+ Second, transactions must change their retry behavior based on whether
+ they are a child or parent transaction to ensure proper closed nesting,
+ flattened transaction behavior is performed.
+ </li>
+</ul></div>
+
+ The <code class="computeroutput">atomic</code> preprocessor
+ behaves as follows. When the transactional for loop is entered, a transaction
+ automatic object is constructed which initializes the transaction and puts
+ it in-flight. The for loop conditional ensures the following conditions:
+ 
+<div class="orderedlist"><ol type="1">
+<li>
+ the transaction is uncommitted,
+ </li>
+<li>
+ the transaction has the opportunity to throw an exception if necessary,
+ and
+ </li>
+<li>
+ the transaction is in-flight.
+ </li>
+</ol></div>
+
+ Once a transaction commits, the check on (1) <code class="computeroutput">!T.committed()</code> ensures the transaction is not executed
+ again. If the transaction has been aborted but is a child transaction,
+ the transaction must be restarted at the parent level. The call to (2)
+ <code class="computeroutput">T.check_throw_before_restart()</code>
+ allows an aborted child transaction to throw an exception upward (before
+ it is restarted) so the entire transaction can be restarted from the parent.
+ The <code class="computeroutput">check_throw_before_restart()</code> API checks the current run-time state
+ of the thread to determine if another transaction is active above it. This
+ behavior allows transactions to be used at any nesting level while dynamically
+ ensuring the correct retry behavior. Finally, the call to <code class="computeroutput">restart_if_not_inflight()</code>
+ ensures the transaction is correctly restarted after each subsequent abort.
+ 
+
+ Once all of the transactional operations within the for loop are executed,
+ a call to no_throw_end() is made which ends the transaction. The <code class="computeroutput">no_throw_end()</code>
+ terminates the transaction by either committing or aborting it. Note, however,
+ that <code class="computeroutput">no_throw_end()</code>
+ does not throw an exception if the transaction is aborted, whereas the
+ prior TBoost.STM's API end() does. This non-throwing behavior deviates
+ from the prior TBoost.STM implementation of automatic objects when end()
+ was invoked within the try / catch body. Furthermore, due to <code class="computeroutput">no_throw_end()</code>
+ not throwing an exception if the transaction is aborted, some cases may
+ arise where <code class="computeroutput">catch_before_retry</code>
+ or <code class="computeroutput">before_retry</code> operations
+ are not invoked when a transaction is aborted. This is a current limitation
+ of the system and is overcome by inserting a manual end() operation as
+ the last operation in the atomic block. The explicit end() ensures any
+ operations within the before_retry block are executed if the transaction
+ is aborted.
+ 
+<pre class="programlisting">#define atomic(T)
+#define try_atomic(T)
+#define use_atomic(T)
+#define catch_before_retry(E)
+#define before_retry
+#define end_atom
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.core.language_like_hpp.macro__atomic_"></a><a href="core.html#toward_boost_stm.reference.core.language_like_hpp.macro__atomic_" title="Macro
+ atomic">Macro
+ <code class="computeroutput">atomic</code></a>
+</h5></div></div></div>
+
+ Use atomic transaction T for optimistic critical section. Supports single-depth
+ and multiple-depth (nested) transactions. Performs automatic retry when
+ T is a parent transaction, throws exception when T is a child transaction.
+ This automatic switch enables correctly behaved nested and non-nested
+ transactions
+ 
+<pre class="programlisting">#define atomic(T) \
+ for (transaction T; \
+ !T.committed() && T.check_throw_before_restart() && T.restart_if_not_inflight(); \
+ T.no_throw_end())
+ try
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.core.language_like_hpp.macro__try_atomic_"></a><a href="core.html#toward_boost_stm.reference.core.language_like_hpp.macro__try_atomic_" title="Macro
+ try_atomic">Macro
+ <code class="computeroutput">try_atomic</code></a>
+</h5></div></div></div>
+<pre class="programlisting">#define try_atomic(T) \
+ for (transaction T; \
+ !T.committed() && T.restart(); \
+ T.no_throw_end())
+ try
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.core.language_like_hpp.macro__use_atomic_"></a><a href="core.html#toward_boost_stm.reference.core.language_like_hpp.macro__use_atomic_" title="Macro
+ use_atomic">Macro
+ <code class="computeroutput">use_atomic</code></a>
+</h5></div></div></div>
+<pre class="programlisting">#define use_atomic(T) \
+ for (transaction T; \
+ !T.committed() && T.restart(); \
+ T.end())
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.core.language_like_hpp.macro__catch_before_retry_"></a><a href="core.html#toward_boost_stm.reference.core.language_like_hpp.macro__catch_before_retry_" title="Macro
+ catch_before_retry">Macro
+ <code class="computeroutput">catch_before_retry</code></a>
+</h5></div></div></div>
+<pre class="programlisting">#define catch_before_retry(E) catch (aborted_tx &E)
+</pre>
+
+ Catches exception when transaction is aborted. This, before_retry, or
+ end_atom must follow an atomic block. Once all operations within the
+ catch_before_retry block are executed, control is returned to the local
+ atomic where the transaction is retried (if it is the parent) or the
+ atomic block is exited by exception (if it is a child).
+ 
+
+ To be used pairwise with <code class="computeroutput">try_atomic</code>
+ or <code class="computeroutput">atomic</code>.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.core.language_like_hpp.macro__before_retry_"></a><a href="core.html#toward_boost_stm.reference.core.language_like_hpp.macro__before_retry_" title="Macro
+ before_retry">Macro
+ <code class="computeroutput">before_retry</code></a>
+</h5></div></div></div>
+<pre class="programlisting">#define before_retry catch (aborted_tx &)
+</pre>
+
+ Same as catch_before_retry(E) except the exception is discarded.
+ 
+
+ To be used pairwise with <code class="computeroutput">try_atomic</code>
+ or <code class="computeroutput">atomic</code>.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.core.language_like_hpp.macro__end_atom_"></a><a href="core.html#toward_boost_stm.reference.core.language_like_hpp.macro__end_atom_" title="Macro
+ end_atom">Macro
+ <code class="computeroutput">end_atom</code></a>
+</h5></div></div></div>
+<pre class="programlisting">#define end_atom catch (aborted_tx &) {}
+</pre>
+
+ Same as before_retry except the exception is discarded and {} are automated.
+ 
+
+ To be used pairwise with <code class="computeroutput">try_atomic</code>
+ or <code class="computeroutput">atomic</code>.
+ 
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp" title=" Header
+ <boost/stm/transaction.hpp>"> Header
+ <code class="computeroutput"><boost/stm/transaction.hpp></code></a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_">Class
+ <code class="computeroutput">transaction</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.struct__thread_initializer_">Struct
+ <code class="computeroutput">thread_initializer</code></a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost { namespace stm {
+ class transaction;
+ struct thread_initializer;
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_" title="Class
+ transaction">Class
+ <code class="computeroutput">transaction</code></a>
+</h5></div></div></div>
+<div class="toc"><dl>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__initialize___">Static
+ Function <code class="computeroutput">initialize()</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__initialize_thread___">Static
+ Function <code class="computeroutput">initialize_thread()</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__terminate_thread___">Static
+ Function <code class="computeroutput">terminate_thread()</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__contention_manager_">Static
+ Function <code class="computeroutput">contention_manager</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__get_contention_manager_">Static
+ Function <code class="computeroutput">get_contention_manager</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__enable_dynamic_priority_assignment_">Static
+ Function <code class="computeroutput">enable_dynamic_priority_assignment</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__disable_dynamic_priority_assignment_">Static
+ Function <code class="computeroutput">disable_dynamic_priority_assignment</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__doing_dynamic_priority_assignment_">Static
+ Function <code class="computeroutput">doing_dynamic_priority_assignment</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__enableloggingofabortandcommitsetsize_">Static
+ Function <code class="computeroutput">enableLoggingOfAbortAndCommitSetSize</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__disableloggingofabortandcommitsetsize_">Static
+ Function <code class="computeroutput">disableLoggingOfAbortAndCommitSetSize</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__transaction_bookkeeping_">Static
+ Function <code class="computeroutput">transaction_bookkeeping</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__early_conflict_detection_">Static
+ Function <code class="computeroutput">early_conflict_detection</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__late_conflict_detection_">Static
+ Function <code class="computeroutput">late_conflict_detection</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__do_early_conflict_detection_">Static
+ Function <code class="computeroutput">do_early_conflict_detection</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__do_late_conflict_detection_">Static
+ Function <code class="computeroutput">do_late_conflict_detection</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__consistency_checking_string_">Static
+ Function <code class="computeroutput">consistency_checking_string</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__validating_">Static
+ Function <code class="computeroutput">validating</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__invalidating_">Static
+ Function <code class="computeroutput">invalidating</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__direct_updating_">Static
+ Function <code class="computeroutput">direct_updating</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__deferred_updating_">Static
+ Function <code class="computeroutput">deferred_updating</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__do_direct_updating_">Static
+ Function <code class="computeroutput">do_direct_updating</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__do_deferred_updating_">Static
+ Function <code class="computeroutput">do_deferred_updating</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__update_policy_string_">Static
+ Function <code class="computeroutput">update_policy_string</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__latm_protection_">Static
+ Function <code class="computeroutput">latm_protection</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__latm_protection_str_">Static
+ Function <code class="computeroutput">latm_protection_str</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__do_full_lock_protection_">Static
+ Function <code class="computeroutput">do_full_lock_protection</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__do_tm_lock_protection_">Static
+ Function <code class="computeroutput">do_tm_lock_protection</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__do_tx_lock_protection_">Static
+ Function <code class="computeroutput">do_tx_lock_protection</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__doing_tx_lock_protection_">Static
+ Function <code class="computeroutput">doing_tx_lock_protection</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__doing_full_lock_protection_">Static
+ Function <code class="computeroutput">doing_full_lock_protection</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__doing_tm_lock_protection_">Static
+ Function <code class="computeroutput">doing_tm_lock_protection</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__in_flight_transactions_">Static
+ Function <code class="computeroutput">in_flight_transactions</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.constructor__transaction___">Constructor
+ <code class="computeroutput">transaction()</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.destructor___transaction___">Destructor
+ <code class="computeroutput">~transaction()</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__committed_">Member
+ Function <code class="computeroutput">committed</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__aborted_">Member
+ Function <code class="computeroutput">aborted</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__in_flight_">Member
+ Function <code class="computeroutput">in_flight</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__begin_">Member
+ Function <code class="computeroutput">begin</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__restart_">Member
+ Function <code class="computeroutput">restart</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__restart_if_not_inflight_">Member
+ Function <code class="computeroutput">restart_if_not_inflight</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__end_">Member
+ Function <code class="computeroutput">end</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__no_throw_end_">Member
+ Function <code class="computeroutput">no_throw_end</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__force_to_abort_">Member
+ Function <code class="computeroutput">force_to_abort</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__unforce_to_abort_">Member
+ Function <code class="computeroutput">unforce_to_abort</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__priority_">Member
+ Function <code class="computeroutput">priority</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__set_priority_">Member
+ Function <code class="computeroutput">set_priority</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__raise_priority_">Member
+ Function <code class="computeroutput">raise_priority</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__make_irrevocable_">Member
+ Function <code class="computeroutput">make_irrevocable</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__make_isolated_">Member
+ Function <code class="computeroutput">make_isolated</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__irrevocable_">Member
+ Function <code class="computeroutput">irrevocable</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__isolated_">Member
+ Function <code class="computeroutput">isolated</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__thread_id_">Member
+ Function <code class="computeroutput">thread_id</code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.template_member_function__find_original___">Template
+ Member Function <code class="computeroutput">find_original<></code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.template__function__read___">Template
+ Function <code class="computeroutput">read<></code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.template__function__read_ptr___">Template
+ Function <code class="computeroutput">read_ptr<></code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.template__function__write___">Template
+ Function <code class="computeroutput">write<></code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.template__function__write_ptr___">Template
+ Function <code class="computeroutput">write_ptr<></code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.template__function__get_written___">Template
+ Function <code class="computeroutput">get_written<></code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.template__function__delete_memory___">Template
+ Function <code class="computeroutput">delete_memory<></code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.template__function__new_memory___">Template
+ Function <code class="computeroutput">new_memory<></code></a></dt>
+<dt><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.template__function__new_memory_copy___">Template
+ Function <code class="computeroutput">new_memory_copy<></code></a></dt>
+</dl></div>
+
+ TBoost.STM defines transactions as stackbased objects using RAII. In
+ addition to the static interfaces for direct and deferred updating described
+ earlier in this section, the following interfaces are necessary for performing
+ transactions.
+ 
+<pre class="programlisting">class transaction {
+public:
+ // initialization
+ static void initialize();
+ static void initialize_thread();
+ static void terminate_thread();
+
+ // contention manager
+ static void contention_manager(base_contention_manager *rhs);
+ static base_contention_manager* get_contention_manager();
+
+ static bool enable_dynamic_priority_assignment();
+ static bool disable_dynamic_priority_assignment();
+ static bool doing_dynamic_priority_assignment();
+
+ // bookeeping
+ static void enableLoggingOfAbortAndCommitSetSize();
+ static void disableLoggingOfAbortAndCommitSetSize();
+ static const transaction_bookkeeping & bookkeeping();
+
+ // conflict detection
+ static bool early_conflict_detection();
+ static bool late_conflict_detection();
+ static bool do_early_conflict_detection();
+ static bool do_late_conflict_detection();
+
+ // consistency checking
+ static std::string consistency_checking_string();
+ static bool validating();
+ static bool invalidating();
+
+ // updating
+ static bool direct_updating()
+ static bool deferred_updating();
+ static bool do_direct_updating();
+ static bool do_deferred_updating();
+ static std::string update_policy_string();
+
+ // Lock Aware Transactional Memory support methods
+ static latm_type const latm_protection();
+ static std::string const latm_protection_str();
+ static void do_full_lock_protection();
+ static void do_tm_lock_protection();
+ static void do_tx_lock_protection();
+ static bool doing_full_lock_protection();
+ static bool doing_tm_lock_protection();
+ static bool doing_tx_lock_protection();
+
+ //in flight transactions
+ static InflightTxes const & in_flight_transactions();
+
+ // transaction
+ transaction();
+ ~transaction();
+
+ bool committed() const;
+ bool aborted() const;
+ bool in_flight() const;
+
+ void begin();
+ bool restart();
+ bool restart_if_not_inflight();
+ void end();
+ void no_throw_end();
+ void force_to_abort();
+ void unforce_to_abort();
+
+ std::size_t const &priority() const;
+ void set_priority(std::size_t const &rhs) const;
+ void raise_priority();
+
+ void make_irrevocable();
+ void make_isolated();
+ bool irrevocable() const;
+ bool isolated() const;
+
+ thread_id_t const & thread_id() const;
+
+
+ template <typename T> T& find_original(T& in);
+
+ template <typename T> T const & read(T const & in);
+ template <typename T> T const * read_ptr(T const * in);
+ template <typename T> T const & r(T const & in);
+
+ template <typename T> T& write(T& in);
+ template <typename T> T* write_ptr(T* in);
+ template <typename T> T& w(T& in);
+
+ template <typename T> T* get_written(T const & in);
+
+ template <typename T> void delete_memory(T &in)
+ template <typename T> T* new_memory();
+ template <typename T> T* new_memory_copy(T const &rhs);
+
+};
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__initialize___"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__initialize___" title="Static
+ Function initialize()">Static
+ Function <code class="computeroutput">initialize()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static void initialize();
+</pre>
+
+ This method must called before any transaction objects are constructed.
+ The initialize method initializes the overall transaction locking framework.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__initialize_thread___"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__initialize_thread___" title="Static
+ Function initialize_thread()">Static
+ Function <code class="computeroutput">initialize_thread()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static void initialize_thread();
+</pre>
+
+ This method must be called for each thread before any transactions
+ are constructed. This method initializes the thread's read and write
+ sets, new and deleted memory sets, mutex locks and thread-based flags.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__terminate_thread___"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__terminate_thread___" title="Static
+ Function terminate_thread()">Static
+ Function <code class="computeroutput">terminate_thread()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static void terminate_thread();
+</pre>
+
+ This method should be called before destroying a thread. While it is
+ not needed, it will keep transaction operations functioning optimally
+ by reducing static overhead within the transaction class that is no
+ longer needed once a thread's lifetime has ended.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__contention_manager_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__contention_manager_" title="Static
+ Function contention_manager">Static
+ Function <code class="computeroutput">contention_manager</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static void contention_manager(base_contention_manager *rhs);
+</pre>
+
+ Sets TBoost.STM's contention manager to point to the passed in contention
+ manager. When a new CM is passed in to TBoost.STM, it deletes the previously
+ pointed to CM and points to the new one. Client code is responsible
+ for constructing new CMs that are passed to this method, but TBoost.STM
+ then takes ownership of these CMs.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__get_contention_manager_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__get_contention_manager_" title="Static
+ Function get_contention_manager">Static
+ Function <code class="computeroutput">get_contention_manager</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static base_contention_manager* get_contention_manager();
+</pre>
+
+ Returns a pointer to the current CM used by TBoost.STM. This method
+ is mostly used for validation purposes after setting a CM to a user-specified
+ implementation.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__enable_dynamic_priority_assignment_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__enable_dynamic_priority_assignment_" title="Static
+ Function enable_dynamic_priority_assignment">Static
+ Function <code class="computeroutput">enable_dynamic_priority_assignment</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static bool enable_dynamic_priority_assignment();
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__disable_dynamic_priority_assignment_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__disable_dynamic_priority_assignment_" title="Static
+ Function disable_dynamic_priority_assignment">Static
+ Function <code class="computeroutput">disable_dynamic_priority_assignment</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static bool disable_dynamic_priority_assignment();
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__doing_dynamic_priority_assignment_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__doing_dynamic_priority_assignment_" title="Static
+ Function doing_dynamic_priority_assignment">Static
+ Function <code class="computeroutput">doing_dynamic_priority_assignment</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static bool doing_dynamic_priority_assignment();
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__enableloggingofabortandcommitsetsize_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__enableloggingofabortandcommitsetsize_" title="Static
+ Function enableLoggingOfAbortAndCommitSetSize">Static
+ Function <code class="computeroutput">enableLoggingOfAbortAndCommitSetSize</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static void enableLoggingOfAbortAndCommitSetSize();
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__disableloggingofabortandcommitsetsize_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__disableloggingofabortandcommitsetsize_" title="Static
+ Function disableLoggingOfAbortAndCommitSetSize">Static
+ Function <code class="computeroutput">disableLoggingOfAbortAndCommitSetSize</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static void disableLoggingOfAbortAndCommitSetSize();
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__transaction_bookkeeping_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__transaction_bookkeeping_" title="Static
+ Function transaction_bookkeeping">Static
+ Function <code class="computeroutput">transaction_bookkeeping</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static const transaction_bookkeeping & bookkeeping();
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__early_conflict_detection_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__early_conflict_detection_" title="Static
+ Function early_conflict_detection">Static
+ Function <code class="computeroutput">early_conflict_detection</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static bool early_conflict_detection();
+</pre>
+
+ Returns true if direct updating is active and early conflict detection,
+ otherwise returns false.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__late_conflict_detection_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__late_conflict_detection_" title="Static
+ Function late_conflict_detection">Static
+ Function <code class="computeroutput">late_conflict_detection</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static bool late_conflict_detection();
+</pre>
+
+ Returns true if deferred updating is active or if direct updating and
+ late conflict detection are active, otherwise returns false.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__do_early_conflict_detection_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__do_early_conflict_detection_" title="Static
+ Function do_early_conflict_detection">Static
+ Function <code class="computeroutput">do_early_conflict_detection</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static bool do_early_conflict_detection();
+</pre>
+
+ Attempts to switch to early conflict detection. Returns false if in-flight
+ transactions are found or if deferred updating is active. Otherwise
+ returns true and enables early conflict detection.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__do_late_conflict_detection_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__do_late_conflict_detection_" title="Static
+ Function do_late_conflict_detection">Static
+ Function <code class="computeroutput">do_late_conflict_detection</code></a>
+</h6></div></div></div>
+
+ Attempts to switch to late conflict detection. Returns false if in-flight
+ transactions are found, otherwise returns true and enables late conflict
+ detection.
+ 
+<pre class="programlisting">static bool do_late_conflict_detection();
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__consistency_checking_string_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__consistency_checking_string_" title="Static
+ Function consistency_checking_string">Static
+ Function <code class="computeroutput">consistency_checking_string</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static std::string consistency_checking_string();
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__validating_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__validating_" title="Static
+ Function validating">Static
+ Function <code class="computeroutput">validating</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static bool validating();
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__invalidating_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__invalidating_" title="Static
+ Function invalidating">Static
+ Function <code class="computeroutput">invalidating</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static bool invalidating();
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__direct_updating_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__direct_updating_" title="Static
+ Function direct_updating">Static
+ Function <code class="computeroutput">direct_updating</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static bool direct_updating()
+</pre>
+
+ Returns true if direct updating is active, otherwise returns false.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__deferred_updating_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__deferred_updating_" title="Static
+ Function deferred_updating">Static
+ Function <code class="computeroutput">deferred_updating</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static bool deferred_updating();
+</pre>
+
+ Returns true if deferred updating is active, otherwise returns false
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__do_direct_updating_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__do_direct_updating_" title="Static
+ Function do_direct_updating">Static
+ Function <code class="computeroutput">do_direct_updating</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static bool do_direct_updating();
+</pre>
+
+ Attempts to switch to direct updating. Returns false if inflight transactions
+ are found and TBoost.STM is unable to switch updating models. Otherwise,
+ returns true and enables direct updating.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__do_deferred_updating_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__do_deferred_updating_" title="Static
+ Function do_deferred_updating">Static
+ Function <code class="computeroutput">do_deferred_updating</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static bool do_deferred_updating();
+</pre>
+
+ Attempts to switch to deferred updating. Returns false if inflight
+ transactions are found and TBoost.STM is unable to switch updating
+ models. Otherwise, returns true and enables deferred updating.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__update_policy_string_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__update_policy_string_" title="Static
+ Function update_policy_string">Static
+ Function <code class="computeroutput">update_policy_string</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static std::string update_policy_string();
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__latm_protection_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__latm_protection_" title="Static
+ Function latm_protection">Static
+ Function <code class="computeroutput">latm_protection</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static latm_type const latm_protection();
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__latm_protection_str_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__latm_protection_str_" title="Static
+ Function latm_protection_str">Static
+ Function <code class="computeroutput">latm_protection_str</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static std::string const latm_protection_str();
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__do_full_lock_protection_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__do_full_lock_protection_" title="Static
+ Function do_full_lock_protection">Static
+ Function <code class="computeroutput">do_full_lock_protection</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static void do_full_lock_protection();
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__do_tm_lock_protection_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__do_tm_lock_protection_" title="Static
+ Function do_tm_lock_protection">Static
+ Function <code class="computeroutput">do_tm_lock_protection</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static void do_tm_lock_protection();
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__do_tx_lock_protection_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__do_tx_lock_protection_" title="Static
+ Function do_tx_lock_protection">Static
+ Function <code class="computeroutput">do_tx_lock_protection</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static void do_tx_lock_protection();
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__doing_tx_lock_protection_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__doing_tx_lock_protection_" title="Static
+ Function doing_tx_lock_protection">Static
+ Function <code class="computeroutput">doing_tx_lock_protection</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static bool doing_tx_lock_protection();
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__doing_full_lock_protection_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__doing_full_lock_protection_" title="Static
+ Function doing_full_lock_protection">Static
+ Function <code class="computeroutput">doing_full_lock_protection</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static bool doing_full_lock_protection();
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__doing_tm_lock_protection_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__doing_tm_lock_protection_" title="Static
+ Function doing_tm_lock_protection">Static
+ Function <code class="computeroutput">doing_tm_lock_protection</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static bool doing_tm_lock_protection();
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__in_flight_transactions_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.static_function__in_flight_transactions_" title="Static
+ Function in_flight_transactions">Static
+ Function <code class="computeroutput">in_flight_transactions</code></a>
+</h6></div></div></div>
+<pre class="programlisting">static InflightTxes const & in_flight_transactions();
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.constructor__transaction___"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.constructor__transaction___" title="Constructor
+ transaction()">Constructor
+ <code class="computeroutput">transaction()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">transaction();
+</pre>
+
+ Default ctor for a transaction immediately puts the transaction in-flight.
+ In addition, the ctor points referenced members to a number of thread-specific
+ sets which it does by referencing the thread id.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.destructor___transaction___"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.destructor___transaction___" title="Destructor
+ ~transaction()">Destructor
+ <code class="computeroutput">~transaction()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">~transaction();
+</pre>
+
+ The transaction dtor releases the thread-specific transaction lock
+ if it is obtained. The dtor then immediately returns if the transaction
+ was not in-flight, or if the transaction was in-flight, it forces the
+ transaction to abort which performs a number of clean-up operations.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__committed_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__committed_" title="Member
+ Function committed">Member
+ Function <code class="computeroutput">committed</code></a>
+</h6></div></div></div>
+
+ States if the state of the transaction is e_committed or e_hand_off
+ 
+<pre class="programlisting">bool committed() const;
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__aborted_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__aborted_" title="Member
+ Function aborted">Member
+ Function <code class="computeroutput">aborted</code></a>
+</h6></div></div></div>
+
+ States if the state of the transaction is e_aborted
+ 
+<pre class="programlisting">bool aborted() const;
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__in_flight_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__in_flight_" title="Member
+ Function in_flight">Member
+ Function <code class="computeroutput">in_flight</code></a>
+</h6></div></div></div>
+
+ States if the state of the transaction is e_in_flight
+ 
+<pre class="programlisting">bool in_flight() const;
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__begin_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__begin_" title="Member
+ Function begin">Member
+ Function <code class="computeroutput">begin</code></a>
+</h6></div></div></div>
+<pre class="programlisting">void begin();
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__restart_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__restart_" title="Member
+ Function restart">Member
+ Function <code class="computeroutput">restart</code></a>
+</h6></div></div></div>
+<pre class="programlisting">bool restart();
+</pre>
+
+ This method is similar to the transaction ctor as it signals the start
+ of a transaction and attempts to put it in-flight. A fundamental difference
+ between restart_transaction() and the transaction ctor is that if the
+ transaction is already in-flight, begin_transaction() aborts the transaction
+ and restarts it. This behavior is important for composed transactions
+ where the outer transaction is never destructed, due to continually
+ excepting inner transactions which also prevent the outer transaction
+ from reaching its call to end_transaction(). This is shown concretely
+ in the composable transaction example
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__restart_if_not_inflight_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__restart_if_not_inflight_" title="Member
+ Function restart_if_not_inflight">Member
+ Function <code class="computeroutput">restart_if_not_inflight</code></a>
+</h6></div></div></div>
+<pre class="programlisting">bool restart_if_not_inflight();
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__end_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__end_" title="Member
+ Function end">Member
+ Function <code class="computeroutput">end</code></a>
+</h6></div></div></div>
+<pre class="programlisting">void end();
+</pre>
+
+ This method signals that the transaction should try to commit. The
+ return value stored in a transaction_state enumeration is either 1)
+ e_hand_off, meaning the transaction was nested and has handed off its
+ state to the parent transaction or 2) e_committed, meaning the transaction
+ was committed and global memory has been updated. If a transaction
+ is aborted, an aborted_transaction_exception is thrown. A call to end_transaction()
+ will never return an enumerated state which signals the transaction
+ was aborted. Instead, if a transaction is found to be aborted at a
+ call to end_transaction(), an aborted transaction exception is thrown.
+ This behavior enables all aborted transactions to be handled in a similar
+ fashion, resulting in an aborted transaction exception.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__no_throw_end_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__no_throw_end_" title="Member
+ Function no_throw_end">Member
+ Function <code class="computeroutput">no_throw_end</code></a>
+</h6></div></div></div>
+<pre class="programlisting">void no_throw_end();
+</pre>
+
+ Do the same as end() by caching every exception.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__force_to_abort_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__force_to_abort_" title="Member
+ Function force_to_abort">Member
+ Function <code class="computeroutput">force_to_abort</code></a>
+</h6></div></div></div>
+<pre class="programlisting">void force_to_abort();
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__unforce_to_abort_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__unforce_to_abort_" title="Member
+ Function unforce_to_abort">Member
+ Function <code class="computeroutput">unforce_to_abort</code></a>
+</h6></div></div></div>
+<pre class="programlisting">void unforce_to_abort();
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__priority_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__priority_" title="Member
+ Function priority">Member
+ Function <code class="computeroutput">priority</code></a>
+</h6></div></div></div>
+<pre class="programlisting">std::size_t const &priority() const;
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__set_priority_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__set_priority_" title="Member
+ Function set_priority">Member
+ Function <code class="computeroutput">set_priority</code></a>
+</h6></div></div></div>
+<pre class="programlisting">void set_priority(std::size_t const &rhs) const;
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__raise_priority_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__raise_priority_" title="Member
+ Function raise_priority">Member
+ Function <code class="computeroutput">raise_priority</code></a>
+</h6></div></div></div>
+<pre class="programlisting">void raise_priority();
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__make_irrevocable_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__make_irrevocable_" title="Member
+ Function make_irrevocable">Member
+ Function <code class="computeroutput">make_irrevocable</code></a>
+</h6></div></div></div>
+<pre class="programlisting">void make_irrevocable();
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__make_isolated_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__make_isolated_" title="Member
+ Function make_isolated">Member
+ Function <code class="computeroutput">make_isolated</code></a>
+</h6></div></div></div>
+<pre class="programlisting">void make_isolated();
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__irrevocable_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__irrevocable_" title="Member
+ Function irrevocable">Member
+ Function <code class="computeroutput">irrevocable</code></a>
+</h6></div></div></div>
+<pre class="programlisting">bool irrevocable() const;
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__isolated_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__isolated_" title="Member
+ Function isolated">Member
+ Function <code class="computeroutput">isolated</code></a>
+</h6></div></div></div>
+<pre class="programlisting">bool isolated() const;
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__thread_id_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.member_function__thread_id_" title="Member
+ Function thread_id">Member
+ Function <code class="computeroutput">thread_id</code></a>
+</h6></div></div></div>
+<pre class="programlisting">thread_id_t const & thread_id() const;
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.template_member_function__find_original___"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.template_member_function__find_original___" title="Template
+ Member Function find_original<>">Template
+ Member Function <code class="computeroutput">find_original<></code></a>
+</h6></div></div></div>
+<pre class="programlisting">template <typename T> T& find_original(T& in);
+</pre>
+
+ This method searches the transaction's write list for the original
+ piece of memory referred to by the transactional memory passed in.
+ If the memory passed in is the original global memory it is simply
+ returned. Otherwise, the copied memory passed in, is used to find the
+ original global memory stored in the transaction's write set and then
+ the original memory is returned. While new memory constructed within
+ a transaction can be passed into find_original(), it is not necessary
+ as it always will return a reference to itself. However, to reduce
+ the complexity of client-side code, it may be preferred to build a
+ single method for both new and existing memory address lookup.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.template__function__read___"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.template__function__read___" title="Template
+ Function read<>">Template
+ Function <code class="computeroutput">read<></code></a>
+</h6></div></div></div>
+<pre class="programlisting">template <typename T> T const & read(T const & in);
+template <typename T> T const & r(T const & in);
+</pre>
+
+ The read method is used when a transaction is attempting to read a
+ piece of memory that is shared between threads (i.e. global heap space).
+ The input argument is a reference to a derived base_transaction_object
+ instance, the return value reference is the correct base_transaction_object
+ to read based on the current state of the transaction and the currently
+ employed updating policy.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.template__function__read_ptr___"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.template__function__read_ptr___" title="Template
+ Function read_ptr<>">Template
+ Function <code class="computeroutput">read_ptr<></code></a>
+</h6></div></div></div>
+<pre class="programlisting">template <typename T> T const * read_ptr(T const * in);
+</pre>
+
+ Identical to the read() interface, except the input parameter is a
+ base_transaction_object pointer as is the return parameter
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.template__function__write___"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.template__function__write___" title="Template
+ Function write<>">Template
+ Function <code class="computeroutput">write<></code></a>
+</h6></div></div></div>
+<pre class="programlisting">template <typename T> T& write(T& in);
+template <typename T> T& w(T& in);
+</pre>
+
+ The templatized write method is used when a transaction is attempting
+ to write to a piece of memory that is shared between threads (i.e.
+ global heap space). The input argument is a reference to a derived
+ base_transaction_object instance, the return value reference is the
+ correct base_transaction_object to write to based on the current state
+ of the transaction and the currently employed updating policy.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.template__function__write_ptr___"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.template__function__write_ptr___" title="Template
+ Function write_ptr<>">Template
+ Function <code class="computeroutput">write_ptr<></code></a>
+</h6></div></div></div>
+<pre class="programlisting">template <typename T> T* write_ptr(T* in);
+</pre>
+
+ Identical to the write() interface, except the input is a base_transaction_object
+ pointer as is the return parameter.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.template__function__get_written___"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.template__function__get_written___" title="Template
+ Function get_written<>">Template
+ Function <code class="computeroutput">get_written<></code></a>
+</h6></div></div></div>
+<pre class="programlisting">template <typename T> T* get_written(T const & in);
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.template__function__delete_memory___"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.template__function__delete_memory___" title="Template
+ Function delete_memory<>">Template
+ Function <code class="computeroutput">delete_memory<></code></a>
+</h6></div></div></div>
+<pre class="programlisting">template <typename T> void delete_memory(T &in)
+</pre>
+
+ This method places the input parameter into a garbage set which is
+ emptied (deleted) once the transaction commits.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.template__function__new_memory___"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.template__function__new_memory___" title="Template
+ Function new_memory<>">Template
+ Function <code class="computeroutput">new_memory<></code></a>
+</h6></div></div></div>
+<pre class="programlisting">template <typename T> T* new_memory();
+</pre>
+
+ This method constructs new memory of a derived base_transaction_object
+ type and returns a pointer to the newly allocated memory. While the
+ input template parameter is not used, C++ does not allow functions
+ to differ only by return type. Since different template function instantiations
+ would be constructed here, one per derived base_transaction_object
+ type used within the transaction, a compiler error would be generated
+ for differing return types if an input parameter was not supplied.
+ To overcome this, a void* could be used as the return value, but that
+ would incur client-side casting on the return value, a costly side-effect.
+ To overcome the limitations of C++, while still ensuring strong type-safety,
+ an input parameter which is never referenced is required.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.class__transaction_.template__function__new_memory_copy___"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.class__transaction_.template__function__new_memory_copy___" title="Template
+ Function new_memory_copy<>">Template
+ Function <code class="computeroutput">new_memory_copy<></code></a>
+</h6></div></div></div>
+<pre class="programlisting">template <typename T> T* new_memory_copy(T const &rhs);
+</pre>
+
+ This method behaves similarly to the new_memory() interface except
+ that it makes an exact replica of the input parameter. The return value
+ is a pointer to the newly allocated, replicated object.
+ 
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.core.transaction_hpp.struct__thread_initializer_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_hpp.struct__thread_initializer_" title="Struct
+ thread_initializer">Struct
+ <code class="computeroutput">thread_initializer</code></a>
+</h5></div></div></div>
+
+ Scoped thread initializer calling transaction::initialize_thread() in
+ the constructor and transaction::terminate_thread() in the destructor.
+ 
+
+ Declare an object of this class on each thread participating on a transaction.
+ 
+<pre class="programlisting">struct thread_initializer {
+ thread_initializer();
+ ~thread_initializer();
+};
+</pre>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_stm.reference.core.transaction_bookkeeping_hpp"></a><a href="core.html#toward_boost_stm.reference.core.transaction_bookkeeping_hpp" title="
+ Header <boost/stm/transaction_bookkeeping.hpp>">
+ Header <code class="computeroutput"><boost/stm/transaction_bookkeeping.hpp></code></a>
+</h4></div></div></div>
+<div class="toc"><dl><dt><a href="core.html#toward_boost_stm.reference.core.transaction_bookkeeping_hpp.class__transaction_bookkeeping_">Class
+ <code class="computeroutput">transaction_bookkeeping</code></a></dt></dl></div>
+<pre class="programlisting">namespace boost { namespace stm {
+ class transaction_bookkeeping
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.core.transaction_bookkeeping_hpp.class__transaction_bookkeeping_"></a><a href="core.html#toward_boost_stm.reference.core.transaction_bookkeeping_hpp.class__transaction_bookkeeping_" title="Class
+ transaction_bookkeeping">Class
+ <code class="computeroutput">transaction_bookkeeping</code></a>
+</h5></div></div></div>
+<pre class="programlisting">class transaction_bookkeeping
+{
+public:
+
+ typedef std::map<uint32, uint32> thread_commit_map;
+ typedef std::map<ThreadIdAndCommitId, uint32> CommitHistory;
+ typedef std::map<ThreadIdAndCommitId, uint32> AbortHistory;
+
+ transaction_bookkeeping();
+
+ uint32 const & lockConvoyMs();
+ uint32 const & commitTimeMs();
+ uint32 const & readAborts();
+ uint32 const & writeAborts();
+ uint32 const & abortPermDenied();
+ uint32 const totalAborts() const;
+ uint32 const & commits() const;
+ uint32 const & handOffs() const;
+ uint32 const & newMemoryAborts();
+ uint32 const & newMemoryCommits();
+ uint32 const & deletedMemoryAborts();
+ uint32 const & deletedMemoryCommits();
+ uint32 const & readChangedToWrite() const;
+ uint32 const & readStayedAsRead() const;
+
+ void inc_read_aborts();
+ void inc_write_aborts();
+
+ void inc_thread_commits(uint32 threadId);
+ void inc_thread_aborts(uint32 threadId);
+
+ thread_commit_map const & threadedCommits() const;
+ thread_commit_map const & threadedAborts() const;
+
+ void inc_lock_convoy_ms(uint32 const &rhs);
+ void inc_commit_time_ms(uint32 const &rhs);
+ void inc_commits();
+ void inc_abort_perm_denied(uint32 const &threadId);
+ void inc_handoffs();
+ void inc_new_mem_aborts_by(uint32 const &rhs);
+ void inc_new_mem_commits_by(uint32 const &rhs);
+ void inc_del_mem_aborts_by(uint32 const &rhs);
+ void inc_del_mem_commits_by(uint32 const &rhs);
+ void incrementReadChangedToWrite();
+ void incrementReadStayedAsRead();
+
+ CommitHistory const& getCommitReadSetList() const;
+ CommitHistory const& getCommitWriteSetList() const;
+ AbortHistory const& getAbortReadSetList() const;
+ AbortHistory const& getAbortWriteSetList() const;
+
+ void pushBackSizeOfReadSetWhenAborting(uint32 const &size);
+
+ void pushBackSizeOfWriteSetWhenAborting(uint32 const &size);
+
+ void pushBackSizeOfReadSetWhenCommitting(uint32 const &size);
+ void pushBackSizeOfWriteSetWhenCommitting(uint32 const &size);
+
+ bool isLoggingAbortAndCommitSize() const;
+ void setIsLoggingAbortAndCommitSize(bool const &in);
+
+ friend std::ostream& operator<<(std::ostream& out, transaction_bookkeeping const &that);
+};
+</pre>
+</div>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 Justin E. Gottchlich Copyright © 2009 Vicente J. Botet Escriba
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="stm_hpp.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="mixins_transactional_objects.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/stm/branches/vbe/libs/stm/doc/html/toward_boost_stm/reference/deep_transactional_objects.html
==============================================================================
--- (empty file)
+++ sandbox/stm/branches/vbe/libs/stm/doc/html/toward_boost_stm/reference/deep_transactional_objects.html 2009-11-11 11:03:52 EST (Wed, 11 Nov 2009)
@@ -0,0 +1,843 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Deep
+ Transactional objects</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../../index.html" title="Chapter 1. Toward.Boost.STM">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="contention_managers.html" title="Contention
+ Managers">
+<link rel="next" href="shallow_transactional_objects.html" title="Shallow
+ Transactional Objects">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="TowardBoostSTM" width="277" height="86" src="../../../image/Toward_Boost_STM.jpg"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="contention_managers.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="shallow_transactional_objects.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects"></a><a href="deep_transactional_objects.html" title="Deep
+ Transactional objects">Deep
+ Transactional objects</a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt>Mixins</dt>
+<dd><dl>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.transaction_object_hpp">
+ Header <code class="computeroutput"><boost/stm/transaction_object.hpp></code></a></dt>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.transaction_object_ptr_hpp">
+ Header <code class="computeroutput"><boost/stm/transaction_object_ptr.hpp></code></a></dt>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.tx_numeric_hpp">
+ Header <code class="computeroutput"><boost/stm/tx/numeric.hpp></code></a></dt>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.tx_pointer_hpp">
+ Header <code class="computeroutput"><boost/stm/tx/pointer.hpp></code></a></dt>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.smart_pointers">Smart
+ pointers</a></dt>
+</dl></dd>
+<dt>Warppers</dt>
+<dd><dl>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.warppers.transactional_object_hpp">
+ Header <code class="computeroutput"><boost/stm/transactional_object.hpp></code></a></dt>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.warppers.smart_pointers">Smart
+ pointers</a></dt>
+</dl></dd>
+</dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.mixins"></a>Mixins
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.transaction_object_hpp">
+ Header <code class="computeroutput"><boost/stm/transaction_object.hpp></code></a></dt>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.transaction_object_ptr_hpp">
+ Header <code class="computeroutput"><boost/stm/transaction_object_ptr.hpp></code></a></dt>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.tx_numeric_hpp">
+ Header <code class="computeroutput"><boost/stm/tx/numeric.hpp></code></a></dt>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.tx_pointer_hpp">
+ Header <code class="computeroutput"><boost/stm/tx/pointer.hpp></code></a></dt>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.smart_pointers">Smart
+ pointers</a></dt>
+</dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.mixins.transaction_object_hpp"></a><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.transaction_object_hpp" title="
+ Header <boost/stm/transaction_object.hpp>">
+ Header <code class="computeroutput"><boost/stm/transaction_object.hpp></code></a>
+</h5></div></div></div>
+<div class="toc"><dl>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.transaction_object_hpp.template_class__transaction_object___">Template
+ Class <code class="computeroutput">transaction_object<></code></a></dt>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.transaction_object_hpp.template_class__native_trans___">Template
+ Class <code class="computeroutput">native_trans<></code></a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost { namespace stm {
+ template <class Derived> class transaction_object;
+ template <typename T> class native_trans;
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.mixins.transaction_object_hpp.template_class__transaction_object___"></a><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.transaction_object_hpp.template_class__transaction_object___" title="Template
+ Class transaction_object<>">Template
+ Class <code class="computeroutput">transaction_object<></code></a>
+</h6></div></div></div>
+<div class="toc"><dl>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.transaction_object_hpp.template_class__transaction_object___.virtual_function__clone___">Virtual
+ function <code class="computeroutput">clone()</code></a></dt>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.transaction_object_hpp.template_class__transaction_object___.virtual_function__copy_state___">Virtual
+ function <code class="computeroutput">copy_state()</code></a></dt>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.transaction_object_hpp.template_class__transaction_object___.virtual_function__move_state___">Virtual
+ function <code class="computeroutput">move_state()</code></a></dt>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.transaction_object_hpp.template_class__transaction_object___.virtual_function__cache_deallocate___">Virtual
+ function <code class="computeroutput">cache_deallocate()</code></a></dt>
+</dl></div>
+
+ To further simplify the usage of TBoost.STM, an intermediate template
+ class was built which is meant to sit between the base_transaction_object
+ and the user-defined transaction objects. The purpose of this intermediate
+ class is to reduce the code overhead needed for user-defined transaction
+ objects. To do this, the curiously recurring template pattern developed
+ by James Coplien was used.
+ 
+
+ With the templatized transaction_object, client-side transaction objects
+ need only to derive from it and pass their class type as its template
+ parameter. At compile-time the transaction_object generates the necessary
+ code to override copy_state() and implement operator new and operator
+ delete using TBoost.STM's memory manager for all user-defined types
+ derived from it.
+ 
+<pre class="programlisting">template <class Derived>
+class transaction_object : public base_transaction_object {
+public:
+
+ virtual base_transaction_object* clone(transaction* t) const;
+ virtual void copy_state(base_transaction_object const * const rhs);
+ virtual void move_state(base_transaction_object * rhs);
+};
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.mixins.transaction_object_hpp.template_class__transaction_object___.virtual_function__clone___"></a><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.transaction_object_hpp.template_class__transaction_object___.virtual_function__clone___" title="Virtual
+ function clone()">Virtual
+ function <code class="computeroutput">clone()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual base_transaction_object* clone(transaction* t) const;
+</pre>
+
+ The clone() creates a new Derived instace using the copy constructor.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.mixins.transaction_object_hpp.template_class__transaction_object___.virtual_function__copy_state___"></a><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.transaction_object_hpp.template_class__transaction_object___.virtual_function__copy_state___" title="Virtual
+ function copy_state()">Virtual
+ function <code class="computeroutput">copy_state()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void copy_state(base_transaction_object const * const rhs);
+</pre>
+
+ The copy_state() assigns the rhs to this instace using the copy-assignement
+ operator.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.mixins.transaction_object_hpp.template_class__transaction_object___.virtual_function__move_state___"></a><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.transaction_object_hpp.template_class__transaction_object___.virtual_function__move_state___" title="Virtual
+ function move_state()">Virtual
+ function <code class="computeroutput">move_state()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void move_state(base_transaction_object * rhs);
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.mixins.transaction_object_hpp.template_class__transaction_object___.virtual_function__cache_deallocate___"></a><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.transaction_object_hpp.template_class__transaction_object___.virtual_function__cache_deallocate___" title="Virtual
+ function cache_deallocate()">Virtual
+ function <code class="computeroutput">cache_deallocate()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void cache_deallocate();
+</pre>
+
+ The cache_deallocate() delete this instace using the delete operator.
+ 
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.mixins.transaction_object_hpp.template_class__native_trans___"></a><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.transaction_object_hpp.template_class__native_trans___" title="Template
+ Class native_trans<>">Template
+ Class <code class="computeroutput">native_trans<></code></a>
+</h6></div></div></div>
+<pre class="programlisting">template <typename T> class native_trans : public transaction_object< native_trans<T> > {
+public:
+ native_trans(){}
+ native_trans(T const &rhs);
+ native_trans(native_trans const &rhs);
+ native_trans(native_trans &&rhs);
+ native_trans& operator=(native_trans &&rhs);
+
+ native_trans& operator=(T const &rhs);
+
+ native_trans& operator--();
+ native_trans operator--(int);
+ native_trans& operator++();
+ native_trans operator++(int);
+ native_trans& operator+=(T const &rhs);
+ native_trans operator+(native_trans const &rhs);
+
+ operator T() const;
+ T& value();
+ T const & value() const;
+};
+</pre>
+</div>
+</div>
+<div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.mixins.transaction_object_ptr_hpp"></a><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.transaction_object_ptr_hpp" title="
+ Header <boost/stm/transaction_object_ptr.hpp>">
+ Header <code class="computeroutput"><boost/stm/transaction_object_ptr.hpp></code></a>
+</h5></div></div></div></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.mixins.tx_numeric_hpp"></a><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.tx_numeric_hpp" title="
+ Header <boost/stm/tx/numeric.hpp>">
+ Header <code class="computeroutput"><boost/stm/tx/numeric.hpp></code></a>
+</h5></div></div></div>
+<div class="toc"><dl><dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.tx_numeric_hpp.template_class__tx__numeric___">Template
+ Class <code class="computeroutput">tx::numeric<></code></a></dt></dl></div>
+<pre class="programlisting">namespace boost { namespace stm { namespace tx {
+
+ template <typename T> class numeric;
+
+ typedef numeric<bool> boolean;
+ typedef numeric<char> char_t;
+ typedef numeric<unsigned char> uchar_t;
+ typedef numeric<short> short_t;
+ typedef numeric<unsigned short> ushort_t;
+ typedef numeric<int> int_t;
+ typedef numeric<unsigned int> uint_t;
+ typedef numeric<long> long_t;
+ typedef numeric<unsigned long> ulong_t;
+ typedef numeric<float> float_t;
+ typedef numeric<double> double_t;
+
+}}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.mixins.tx_numeric_hpp.template_class__tx__numeric___"></a><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.tx_numeric_hpp.template_class__tx__numeric___" title="Template
+ Class tx::numeric<>">Template
+ Class <code class="computeroutput">tx::numeric<></code></a>
+</h6></div></div></div>
+<pre class="programlisting">template <typename T>
+class numeric : public transaction_object< numeric<T> >
+{
+protected:
+ T val_;
+public:
+ numeric();
+ template<class U> numeric(numeric<U> const& u);
+ template <typename U> numeric(U v);
+
+ operator T() const;
+ operator T&();
+
+ T& ref();
+ T value();
+
+};
+</pre>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.mixins.tx_pointer_hpp"></a><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.tx_pointer_hpp" title="
+ Header <boost/stm/tx/pointer.hpp>">
+ Header <code class="computeroutput"><boost/stm/tx/pointer.hpp></code></a>
+</h5></div></div></div>
+<div class="toc"><dl>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.tx_pointer_hpp.template_class__tx__pointer___">Template
+ Class <code class="computeroutput">tx::pointer<></code></a></dt>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.tx_pointer_hpp.template_class__tx__pointer_to_member___">Template
+ Class <code class="computeroutput">tx::pointer_to_member<></code></a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost { namespace stm { namespace tx {
+
+ template <typename T> class pointer;
+ template <typename C, typename R> class pointer_to_member;
+
+}}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.mixins.tx_pointer_hpp.template_class__tx__pointer___"></a><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.tx_pointer_hpp.template_class__tx__pointer___" title="Template
+ Class tx::pointer<>">Template
+ Class <code class="computeroutput">tx::pointer<></code></a>
+</h6></div></div></div>
+<pre class="programlisting">template <typename T>
+class pointer : public transaction_object< pointer<T> >
+{
+protected:
+ T* val_;
+public:
+ pointer();
+ template<class U> pointer(pointer<U> const& r);
+
+ template <typename U> pointer(U* v);
+ pointer(T* v);
+ ~pointer() {}
+
+ operator T*() const;
+ operator T*&();
+
+ T*& get();
+ T const * get() const;
+
+ T const * operator->() const;
+ T const & operator*() const;
+
+ T * operator->();
+ T & operator*();
+};
+</pre>
+</div>
+<div class="section" lang="en"><div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.mixins.tx_pointer_hpp.template_class__tx__pointer_to_member___"></a><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.tx_pointer_hpp.template_class__tx__pointer_to_member___" title="Template
+ Class tx::pointer_to_member<>">Template
+ Class <code class="computeroutput">tx::pointer_to_member<></code></a>
+</h6></div></div></div></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.mixins.smart_pointers"></a><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.smart_pointers" title="Smart
+ pointers">Smart
+ pointers</a>
+</h5></div></div></div>
+<div class="toc"><dl><dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.smart_pointers.txs_ptr_hpp">
+ Header <code class="computeroutput"><boost/stm/tx_ptr.hpp></code></a></dt></dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.mixins.smart_pointers.txs_ptr_hpp"></a><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.smart_pointers.txs_ptr_hpp" title="
+ Header <boost/stm/tx_ptr.hpp>">
+ Header <code class="computeroutput"><boost/stm/tx_ptr.hpp></code></a>
+</h6></div></div></div>
+<div class="toc"><dl>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.smart_pointers.txs_ptr_hpp.template_class__read_ptr___">Template
+ Class <code class="computeroutput">read_ptr<></code></a></dt>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.smart_pointers.txs_ptr_hpp.template_class__write_ptr___">Template
+ Class <code class="computeroutput">write_ptr<></code></a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost { namespace stm {
+ template <typename T> class read_ptr;
+ template <typename T> class write_ptr;
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.mixins.smart_pointers.txs_ptr_hpp.template_class__read_ptr___"></a><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.smart_pointers.txs_ptr_hpp.template_class__read_ptr___" title="Template
+ Class read_ptr<>">Template
+ Class <code class="computeroutput">read_ptr<></code></a>
+</h6></div></div></div>
+<pre class="programlisting">template <typename T> class read_ptr {
+public:
+ inline read_ptr(transaction &t, T const &tx_obj);
+ const T* get() const;
+ inline T const & operator*() const;
+ inline T const * operator->() const;
+
+ inline transaction &trans();
+ T* write_ptr();
+};
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.mixins.smart_pointers.txs_ptr_hpp.template_class__write_ptr___"></a><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.mixins.smart_pointers.txs_ptr_hpp.template_class__write_ptr___" title="Template
+ Class write_ptr<>">Template
+ Class <code class="computeroutput">write_ptr<></code></a>
+</h6></div></div></div>
+<pre class="programlisting">template <typename T> class write_ptr {
+public:
+ inline write_ptr(transaction &t, T & tx_obj);
+
+ T* get() const;
+ inline T& operator*();
+ inline T* operator->();
+</pre>
+</div>
+</div>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.warppers"></a>Warppers
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.warppers.transactional_object_hpp">
+ Header <code class="computeroutput"><boost/stm/transactional_object.hpp></code></a></dt>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.warppers.smart_pointers">Smart
+ pointers</a></dt>
+</dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.warppers.transactional_object_hpp"></a><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.warppers.transactional_object_hpp" title="
+ Header <boost/stm/transactional_object.hpp>">
+ Header <code class="computeroutput"><boost/stm/transactional_object.hpp></code></a>
+</h5></div></div></div>
+<div class="toc"><dl><dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.warppers.transactional_object_hpp.template_class__transactional_object___">Template
+ Class <code class="computeroutput">transactional_object<></code></a></dt></dl></div>
+<pre class="programlisting">namespace boost { namespace stm {
+ template <class T> class transactional_object;
+
+ template <typename T>
+ static transactional_object<T>* tx_up_cast(T* ptr);
+
+ template <typename T, typename U>
+ static transactional_object<T>* tx_static_cast(transactional_object<U>* ptr);
+
+ template <typename T, typename U>
+ static transactional_object<T>* tx_dynamic_cast(transactional_object<U>* ptr);
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.warppers.transactional_object_hpp.template_class__transactional_object___"></a><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.warppers.transactional_object_hpp.template_class__transactional_object___" title="Template
+ Class transactional_object<>">Template
+ Class <code class="computeroutput">transactional_object<></code></a>
+</h6></div></div></div>
+<div class="toc"><dl>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.warppers.transactional_object_hpp.template_class__transactional_object___.virtual_function__copy_state___">Virtual
+ function <code class="computeroutput">copy_state()</code></a></dt>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.warppers.transactional_object_hpp.template_class__transactional_object___.virtual_function__move_state___">Virtual
+ function <code class="computeroutput">move_state()</code></a></dt>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.warppers.transactional_object_hpp.template_class__transactional_object___.virtual_function__cache_deallocate___">Virtual
+ function <code class="computeroutput">cache_deallocate()</code></a></dt>
+</dl></div>
+
+ Transactional object wrapper. A <code class="computeroutput">transactional_object<T></code> is a base_transaction_object wrapping
+ an instance of type T. Provides the definition of the virtual functions
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ forward constructors to the wrapped type
+ </li>
+<li>
+<code class="computeroutput">copy_state</code>: relaying
+ on the cache_copy<T> generic function
+ </li>
+<li>
+<code class="computeroutput">move_state</code> and
+ </li>
+<li>
+<code class="computeroutput">cache_deallocate</code>:
+ relaying on the cache_copy<T> generic function
+ </li>
+</ul></div>
+
+ Defines in addition the functions <code class="computeroutput">new</code>
+ and <code class="computeroutput">delete</code> when <code class="computeroutput">BOOST_STM_USE_MEMORY_MANAGER</code> is defined
+ 
+
+ If a class D inherits from B we have that <code class="computeroutput">transactional_object<D></code> dont inherits from <code class="computeroutput">transactional_object<B></code>,
+ but we can static/dynamic cast them robustly.
+ 
+
+ Evidently the <code class="computeroutput">std::static_cast</code>/<code class="computeroutput">std::dynamic_cast</code>
+ do not works. We need to define the specific cast
+ 
+<pre class="programlisting">transactional_object<D>* d=...;
+transactional_object<B>* b=tx_static_cast<B>(d);
+
+transactional_object<B>* b=...;
+transactional_object<D>* d=tx_dynamic_cast<B>(b);
+</pre>
+
+ Synopsis
+ 
+<pre class="programlisting">template <typename T>
+class transactional_object : public base_transaction_object {
+public:
+ T value;
+
+ transactional_object();
+ transactional_object(const T*ptr);
+ transactional_object(transactional_object<T> const & r);
+ template <typename T1>
+ transactional_object(T1 const &p1);
+
+ template <typename T1, typename T2>
+ transactional_object(T1 const &p1, T2 const &p2);
+
+ transactional_object & operator=(transactional_object const & r);
+
+ virtual void copy_state(base_transaction_object const * const rhs);
+
+#ifdef BOOST_STM_USE_UNASIGNED_COPY
+ virtual void cache_deallocate();
+#endif
+
+#if BOST_STM_USE_MEMORY_MANAGER
+ void* operator new(size_t size) throw ();
+ void operator delete(void* mem);
+#endif
+
+};
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.warppers.transactional_object_hpp.template_class__transactional_object___.virtual_function__copy_state___"></a><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.warppers.transactional_object_hpp.template_class__transactional_object___.virtual_function__copy_state___" title="Virtual
+ function copy_state()">Virtual
+ function <code class="computeroutput">copy_state()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void copy_state(base_transaction_object const * const rhs);
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.warppers.transactional_object_hpp.template_class__transactional_object___.virtual_function__move_state___"></a><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.warppers.transactional_object_hpp.template_class__transactional_object___.virtual_function__move_state___" title="Virtual
+ function move_state()">Virtual
+ function <code class="computeroutput">move_state()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void move_state(base_transaction_object * rhs);
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.warppers.transactional_object_hpp.template_class__transactional_object___.virtual_function__cache_deallocate___"></a><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.warppers.transactional_object_hpp.template_class__transactional_object___.virtual_function__cache_deallocate___" title="Virtual
+ function cache_deallocate()">Virtual
+ function <code class="computeroutput">cache_deallocate()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void cache_deallocate()=0;
+</pre>
+</div>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.warppers.smart_pointers"></a><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.warppers.smart_pointers" title="Smart
+ pointers">Smart
+ pointers</a>
+</h5></div></div></div>
+<div class="toc"><dl><dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.warppers.smart_pointers.tx_smart_ptr_hpp">
+ Header <code class="computeroutput"><boost/stm/tx/smart_ptr.hpp></code></a></dt></dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.warppers.smart_pointers.tx_smart_ptr_hpp"></a><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.warppers.smart_pointers.tx_smart_ptr_hpp" title="
+ Header <boost/stm/tx/smart_ptr.hpp>">
+ Header <code class="computeroutput"><boost/stm/tx/smart_ptr.hpp></code></a>
+</h6></div></div></div>
+<div class="toc"><dl>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__tx_obj___">Template
+ Class <code class="computeroutput">tx_obj<></code></a></dt>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__tx_ptr___">Template
+ Class <code class="computeroutput">tx_ptr<></code></a></dt>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__rd_ptr___">Template
+ Class <code class="computeroutput">rd_ptr<></code></a></dt>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__upgrd_ptr___">Template
+ Class <code class="computeroutput">upgrd_ptr<></code></a></dt>
+<dt><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__wr_ptr___">Template
+ Class <code class="computeroutput">wr_ptr<></code></a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost { namespace stm {
+
+ template <typename T> class tx_obj;
+ template <typename T, typename U>
+ bool operator==(const tx_obj<T>& lhs, const tx_obj<U>& rhs);
+ template <typename T, typename U>
+ bool operator==(const T& lhs, const tx_obj<U>& rhs);
+ template <typename T, typename U>
+ bool operator==(const tx_obj<T>& lhs, const U& rhs);
+ template <typename T, typename U>
+ bool operator!=(const tx_obj<T>& lhs, const tx_obj<U>& rhs);
+ template <typename T, typename U>
+ bool operator!=(const tx_obj<T>& lhs, const tx_obj<U>& rhs);
+ template<class T> inline void swap(tx_obj<T> & a, tx_obj<T> & b);
+
+ template <typename T> class tx_ptr;
+ template <typename T, typename U>
+ bool operator==(const tx_ptr<T>& lhs, const tx_ptr<U>& rhs);
+ template <typename T, typename U>
+ bool operator!=(const tx_ptr<T>& lhs, const tx_ptr<U>& rhs);
+ template<class T> inline void swap(tx_ptr<T> & a, tx_ptr<T> & b);
+
+ template <typename T>
+ void delete_ptr(tx_ptr<T> ptr);
+ template <typename T>
+ void delete_ptr(transaction& tx, tx_ptr<T> ptr);
+
+ template <typename T, typename U>
+ static tx_ptr<T> tx_static_cast(tx_ptr<U> ptr);
+ template <typename T, typename U>
+ static tx_ptr<T>* tx_dynamic_cast(tx_ptr<U> ptr);
+
+ template <typename T> class rd_ptr;
+ template <typename T>
+ rd_ptr<T> make_rd_ptr(transaction& tx, tx_ptr<T> ptr);
+ template <typename T>
+ rd_ptr<T> make_rd_ptr(transaction& tx, tx_obj<T> const & ref);
+
+ template <typename T>
+ rd_ptr<T> make_rd_ptr(tx_ptr<T> ptr);
+ template <typename T>
+ rd_ptr<T> make_rd_ptr(tx_obj<T> const & ref);
+ template <typename T>
+ void delete_ptr(rd_ptr<T> ptr);
+ template <typename T>
+ void delete_ptr(transaction& tx, rd_ptr<T> ptr);
+
+ template <typename T> class upgrd_ptr;
+ template <typename T>
+ void delete_ptr(upgrd_ptr<T> const& ptr);
+ template <typename T>
+ void delete_ptr(transaction& tx, upgrd_ptr<T> const& ptr);
+
+ template <typename T> class wr_ptr;
+ template <typename T>
+ wr_ptr<T> make_wr_ptr(transaction& tx, tx_ptr<T>& ptr);
+ template <typename T>
+ wr_ptr<T> make_wr_ptr(tx_ptr<T>& ptr);
+ template <typename T>
+ void delete_ptr(wr_ptr<T> ptr);
+ template <typename T>
+ void delete_ptr(transaction& tx, wr_ptr<T> const& ptr);
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__tx_obj___"></a><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__tx_obj___" title="Template
+ Class tx_obj<>">Template
+ Class <code class="computeroutput">tx_obj<></code></a>
+</h6></div></div></div>
+
+ tx_obj is a kind of smart pointer to a wrapped transactional_object
+ T providing builting operators
+ 
+<pre class="programlisting">template <typename T> class tx_obj {
+public:
+ tx_obj();
+ template<ctypename Y> tx_obj(tx_obj<Y> const& r);
+
+ template <typename T1> tx_obj(T1 p1);
+
+ T* operator->();
+ const T* operator->() const;
+ T& operator*();
+ const T& operator*() const;
+ T* get();
+ const T* get() const;
+ T& ref();
+ const T& ref() const;
+
+ tx_obj& operator--();
+ T operator--(int);
+
+ tx_obj& operator++();
+ T operator++(int);
+
+ tx_obj& operator+=(T const &rhs);
+ T operator+(T const &rhs) const;
+};
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__tx_ptr___"></a><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__tx_ptr___" title="Template
+ Class tx_ptr<>">Template
+ Class <code class="computeroutput">tx_ptr<></code></a>
+</h6></div></div></div>
+
+ a tx_ptr<T> is an smart pointer to a transactional_object<T>
+ (which contains an instance of T). Reference fields in linked structures
+ should always be tx_ptrs. The result of derreferencing it will be
+ the pointer to the T instance When this pointer is derreference on
+ a transaction the transactional_object<T> is set a written
+ and the transaction specific storage will be used. Otherwise the
+ shared storage is used.
+ 
+
+ Used to initialize a rd_ptr<T>, wr_ptr<T>, or upgrd_ptr<T>.
+ 
+<pre class="programlisting">template <typename T>
+class tx_ptr {
+public:
+ typedef tx_ptr<T> this_type;
+
+ tx_ptr();
+ template<class Y> explicit tx_ptr(Y * ptr);
+ explicit tx_ptr(transactional_object<T>* ptr);
+ tx_ptr(const tx_obj<T>& r);
+
+ template<class Y> tx_ptr(tx_ptr<Y> const& r);
+ template<class Y> tx_ptr(rd_ptr<Y> const & r);
+ template<class Y> tx_ptr(wr_ptr<Y> const & r);
+ template<class Y> tx_ptr(upgrd_ptr<Y> const & r);
+
+ template<class Y> tx_ptr& operator=(transactional_object<Y>* ptr);
+ template<class Y> tx_ptr & operator=(tx_ptr<Y> const & r);
+
+ T* operator->() const;
+ T& operator*() const;
+ T* get() const;
+
+ typedef transactional_object<T>* this_type::*unspecified_bool_type;
+
+ operator unspecified_bool_type() const;
+ void swap(tx_ptr & other);
+};
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__rd_ptr___"></a><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__rd_ptr___" title="Template
+ Class rd_ptr<>">Template
+ Class <code class="computeroutput">rd_ptr<></code></a>
+</h6></div></div></div>
+
+ A rd_ptr<T> ("read pointer") points to an object
+ that the current transaction has opened for read only access. You
+ can only call a const method through a read pointer.
+ 
+
+ A rd_ptr<T> is constructed from an tx_ptr<T> through
+ an explicit constructor. Once a rd_ptr<T> has been constructed,
+ an tx_ptr<T> can be opened for reading simply by assignment
+ (operator=()) into the constructed rd_ptr<T>.
+ 
+
+ It is not safe to derreference a rd_ptr<T> after having assigned
+ the same tx_ptr<T> to a wr_ptr<T>. If this is the case
+ the readen value do not match the writen one. If it is possible to
+ write on the same transaction use upgrd_ptr instead which is safe.
+ 
+<pre class="programlisting">template <typename T>
+class rd_ptr {
+public:
+ rd_ptr(transaction &t, tx_ptr<T> tx_obj);
+ rd_ptr(transaction &t, tx_obj<T> const& tx_obj);
+
+ template<class Y> rd_ptr & operator=(tx_ptr<Y> r);
+
+ template<class Y> rd_ptr& operator=(tx_obj<Y> const & r);
+
+ const T* get() const;
+
+ inline const T & operator*() const;
+ inline const T* operator->() const;
+
+ operator unspecified_bool_type() const;
+
+};
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__upgrd_ptr___"></a><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__upgrd_ptr___" title="Template
+ Class upgrd_ptr<>">Template
+ Class <code class="computeroutput">upgrd_ptr<></code></a>
+</h6></div></div></div>
+
+ A upgrd_ptr<T> ("upgradable pointer") points to an
+ object that the current transaction has opened for read only access.
+ 
+
+ You can only call const method of the wrapped type through a upgradable
+ pointer.
+ 
+
+ A upgrd_ptr<T> is constructed from an tx_ptr<T> through
+ a constructor having also the transaction as parameter. Once a rd_ptr<T>
+ has been constructed, an tx_ptr<T> can be opened for reading
+ simply by assignment (operator=()) into the constructed rd_ptr<T>.
+ 
+
+ It is safe to derreference a rd_ptr<T> after having assigned
+ the same tx_ptr<T> to a wr_ptr<T>.
+ 
+
+ A upgrd_ptr<T> can be upgraded to a wr_ptr<T> through
+ a constructor.
+ 
+<pre class="programlisting">template <typename T>
+class upgrd_ptr {
+public:
+
+ inline upgrd_ptr(transaction &t, tx_ptr<T> tx_obj);
+ template<class Y>
+ upgrd_ptr & operator=(tx_ptr<Y> const& r);
+
+ const T* get() const;
+
+ inline T const & operator*() const;
+ inline T const * operator->() const;
+
+ operator unspecified_bool_type() const;
+
+ void write_ptr(transactional_object<T>* ptr);
+ T* write_ptr();
+
+};
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.deep_transactional_objects.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__wr_ptr___"></a><a href="deep_transactional_objects.html#toward_boost_stm.reference.deep_transactional_objects.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__wr_ptr___" title="Template
+ Class wr_ptr<>">Template
+ Class <code class="computeroutput">wr_ptr<></code></a>
+</h6></div></div></div>
+
+ A wr_ptr<T> ("write pointer") points to a shared
+ object that the current transaction has opened for writing.
+ 
+
+ A wr_ptr<T> is initialized explicitly from an tx_ptr<T>.
+ 
+
+ A wr_ptr<T> can also be explicitly constructed from a upgrd_ptr<T>
+ as an upgrade-to-writable operation.
+ 
+<pre class="programlisting">template <typename T>
+class wr_ptr {
+public:
+ wr_ptr(transaction &t, tx_ptr<T> tx_obj);
+
+ wr_ptr(transaction &t, upgrd_ptr<T> tx_obj);
+
+ T* get();
+
+ inline T& operator*();
+ inline T* operator->();
+
+ operator unspecified_bool_type() const;
+};
+</pre>
+</div>
+</div>
+</div>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 Justin E. Gottchlich Copyright © 2009 Vicente J. Botet Escriba
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="contention_managers.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="shallow_transactional_objects.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/stm/branches/vbe/libs/stm/doc/html/toward_boost_stm/reference/mixins.html
==============================================================================
--- (empty file)
+++ sandbox/stm/branches/vbe/libs/stm/doc/html/toward_boost_stm/reference/mixins.html 2009-11-11 11:03:52 EST (Wed, 11 Nov 2009)
@@ -0,0 +1,512 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Mixins</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../../index.html" title="Chapter 1. Toward.Boost.STM">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="core.html" title="Core">
+<link rel="next" href="warppers.html" title="Warppers">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="TowardBoostSTM" width="277" height="86" src="../../../image/Toward_Boost_STM.jpg"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="core.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="warppers.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_stm.reference.mixins"></a>Mixins
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects">Deep
+ Transactional objects</a></dt>
+<dd><dl>
+<dt><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.transaction_object_hpp">
+ Header <code class="computeroutput"><boost/stm/transaction_object.hpp></code></a></dt>
+<dt><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.transaction_object_ptr_hpp">
+ Header <code class="computeroutput"><boost/stm/transaction_object_ptr.hpp></code></a></dt>
+<dt><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.tx_numeric_hpp">
+ Header <code class="computeroutput"><boost/stm/tx/numeric.hpp></code></a></dt>
+<dt><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.tx_pointer_hpp">
+ Header <code class="computeroutput"><boost/stm/tx/pointer.hpp></code></a></dt>
+</dl></dd>
+<dt><a href="mixins.html#toward_boost_stm.reference.mixins.shallow_transactional_objects">Shallow
+ Transactional Objects</a></dt>
+<dd><dl><dt><a href="mixins.html#toward_boost_stm.reference.mixins.shallow_transactional_objects.shallow_transaction_object_hpp">
+ Header <code class="computeroutput"><boost/stm/shallow_transaction_object.hpp></code></a></dt></dl></dd>
+<dt><a href="mixins.html#toward_boost_stm.reference.mixins.smart_pointers">Smart
+ pointers</a></dt>
+<dd><dl><dt><a href="mixins.html#toward_boost_stm.reference.mixins.smart_pointers.txs_ptr_hpp">
+ Header <code class="computeroutput"><boost/stm/tx_ptr.hpp></code></a></dt></dl></dd>
+</dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_stm.reference.mixins.deep_transactional_objects"></a><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects" title="Deep
+ Transactional objects">Deep
+ Transactional objects</a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.transaction_object_hpp">
+ Header <code class="computeroutput"><boost/stm/transaction_object.hpp></code></a></dt>
+<dt><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.transaction_object_ptr_hpp">
+ Header <code class="computeroutput"><boost/stm/transaction_object_ptr.hpp></code></a></dt>
+<dt><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.tx_numeric_hpp">
+ Header <code class="computeroutput"><boost/stm/tx/numeric.hpp></code></a></dt>
+<dt><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.tx_pointer_hpp">
+ Header <code class="computeroutput"><boost/stm/tx/pointer.hpp></code></a></dt>
+</dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.mixins.deep_transactional_objects.transaction_object_hpp"></a><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.transaction_object_hpp" title="
+ Header <boost/stm/transaction_object.hpp>">
+ Header <code class="computeroutput"><boost/stm/transaction_object.hpp></code></a>
+</h5></div></div></div>
+<div class="toc"><dl>
+<dt><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.transaction_object_hpp.template_class__transaction_object___">Template
+ Class <code class="computeroutput">transaction_object<></code></a></dt>
+<dt><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.transaction_object_hpp.template_class__native_trans___">Template
+ Class <code class="computeroutput">native_trans<></code></a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost { namespace stm {
+ template <class Derived> class transaction_object;
+ template <typename T> class native_trans;
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins.deep_transactional_objects.transaction_object_hpp.template_class__transaction_object___"></a><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.transaction_object_hpp.template_class__transaction_object___" title="Template
+ Class transaction_object<>">Template
+ Class <code class="computeroutput">transaction_object<></code></a>
+</h6></div></div></div>
+<div class="toc"><dl>
+<dt><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.transaction_object_hpp.template_class__transaction_object___.virtual_function__clone___">Virtual
+ function <code class="computeroutput">clone()</code></a></dt>
+<dt><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.transaction_object_hpp.template_class__transaction_object___.virtual_function__copy_state___">Virtual
+ function <code class="computeroutput">copy_state()</code></a></dt>
+<dt><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.transaction_object_hpp.template_class__transaction_object___.virtual_function__move_state___">Virtual
+ function <code class="computeroutput">move_state()</code></a></dt>
+<dt><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.transaction_object_hpp.template_class__transaction_object___.virtual_function__cache_deallocate___">Virtual
+ function <code class="computeroutput">cache_deallocate()</code></a></dt>
+</dl></div>
+
+ To further simplify the usage of TBoost.STM, an intermediate template
+ class was built which is meant to sit between the base_transaction_object
+ and the user-defined transaction objects. The purpose of this intermediate
+ class is to reduce the code overhead needed for user-defined transaction
+ objects. To do this, the curiously recurring template pattern developed
+ by James Coplien was used.
+ 
+
+ With the templatized transaction_object, client-side transaction objects
+ need only to derive from it and pass their class type as its template
+ parameter. At compile-time the transaction_object generates the necessary
+ code to override copy_state() and implement operator new and operator
+ delete using TBoost.STM's memory manager for all user-defined types
+ derived from it.
+ 
+<pre class="programlisting">template <class Derived>
+class transaction_object : public base_transaction_object {
+public:
+
+ virtual base_transaction_object* clone(transaction* t) const;
+ virtual void copy_state(base_transaction_object const * const rhs);
+ virtual void move_state(base_transaction_object * rhs);
+};
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins.deep_transactional_objects.transaction_object_hpp.template_class__transaction_object___.virtual_function__clone___"></a><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.transaction_object_hpp.template_class__transaction_object___.virtual_function__clone___" title="Virtual
+ function clone()">Virtual
+ function <code class="computeroutput">clone()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual base_transaction_object* clone(transaction* t) const;
+</pre>
+
+ The clone() creates a new Derived instace using the copy constructor.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins.deep_transactional_objects.transaction_object_hpp.template_class__transaction_object___.virtual_function__copy_state___"></a><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.transaction_object_hpp.template_class__transaction_object___.virtual_function__copy_state___" title="Virtual
+ function copy_state()">Virtual
+ function <code class="computeroutput">copy_state()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void copy_state(base_transaction_object const * const rhs);
+</pre>
+
+ The copy_state() assigns the rhs to this instace using the copy-assignement
+ operator.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins.deep_transactional_objects.transaction_object_hpp.template_class__transaction_object___.virtual_function__move_state___"></a><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.transaction_object_hpp.template_class__transaction_object___.virtual_function__move_state___" title="Virtual
+ function move_state()">Virtual
+ function <code class="computeroutput">move_state()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void move_state(base_transaction_object * rhs);
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins.deep_transactional_objects.transaction_object_hpp.template_class__transaction_object___.virtual_function__cache_deallocate___"></a><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.transaction_object_hpp.template_class__transaction_object___.virtual_function__cache_deallocate___" title="Virtual
+ function cache_deallocate()">Virtual
+ function <code class="computeroutput">cache_deallocate()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void cache_deallocate();
+</pre>
+
+ The cache_deallocate() delete this instace using the delete operator.
+ 
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins.deep_transactional_objects.transaction_object_hpp.template_class__native_trans___"></a><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.transaction_object_hpp.template_class__native_trans___" title="Template
+ Class native_trans<>">Template
+ Class <code class="computeroutput">native_trans<></code></a>
+</h6></div></div></div>
+<pre class="programlisting">template <typename T> class native_trans : public transaction_object< native_trans<T> > {
+public:
+ native_trans(){}
+ native_trans(T const &rhs);
+ native_trans(native_trans const &rhs);
+ native_trans(native_trans &&rhs);
+ native_trans& operator=(native_trans &&rhs);
+
+ native_trans& operator=(T const &rhs);
+
+ native_trans& operator--();
+ native_trans operator--(int);
+ native_trans& operator++();
+ native_trans operator++(int);
+ native_trans& operator+=(T const &rhs);
+ native_trans operator+(native_trans const &rhs);
+
+ operator T() const;
+ T& value();
+ T const & value() const;
+};
+</pre>
+</div>
+</div>
+<div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.mixins.deep_transactional_objects.transaction_object_ptr_hpp"></a><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.transaction_object_ptr_hpp" title="
+ Header <boost/stm/transaction_object_ptr.hpp>">
+ Header <code class="computeroutput"><boost/stm/transaction_object_ptr.hpp></code></a>
+</h5></div></div></div></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.mixins.deep_transactional_objects.tx_numeric_hpp"></a><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.tx_numeric_hpp" title="
+ Header <boost/stm/tx/numeric.hpp>">
+ Header <code class="computeroutput"><boost/stm/tx/numeric.hpp></code></a>
+</h5></div></div></div>
+<div class="toc"><dl><dt><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.tx_numeric_hpp.template_class__tx__numeric___">Template
+ Class <code class="computeroutput">tx::numeric<></code></a></dt></dl></div>
+<pre class="programlisting">namespace boost { namespace stm { namespace tx {
+
+ template <typename T> class numeric;
+
+ typedef numeric<bool> boolean;
+ typedef numeric<char> char_t;
+ typedef numeric<unsigned char> uchar_t;
+ typedef numeric<short> short_t;
+ typedef numeric<unsigned short> ushort_t;
+ typedef numeric<int> int_t;
+ typedef numeric<unsigned int> uint_t;
+ typedef numeric<long> long_t;
+ typedef numeric<unsigned long> ulong_t;
+ typedef numeric<float> float_t;
+ typedef numeric<double> double_t;
+
+}}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins.deep_transactional_objects.tx_numeric_hpp.template_class__tx__numeric___"></a><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.tx_numeric_hpp.template_class__tx__numeric___" title="Template
+ Class tx::numeric<>">Template
+ Class <code class="computeroutput">tx::numeric<></code></a>
+</h6></div></div></div>
+<pre class="programlisting">template <typename T>
+class numeric : public transaction_object< numeric<T> >
+{
+protected:
+ T val_;
+public:
+ numeric();
+ template<class U> numeric(numeric<U> const& u);
+ template <typename U> numeric(U v);
+
+ operator T() const;
+ operator T&();
+
+ T& ref();
+ T value();
+
+};
+</pre>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.mixins.deep_transactional_objects.tx_pointer_hpp"></a><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.tx_pointer_hpp" title="
+ Header <boost/stm/tx/pointer.hpp>">
+ Header <code class="computeroutput"><boost/stm/tx/pointer.hpp></code></a>
+</h5></div></div></div>
+<div class="toc"><dl>
+<dt><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.tx_pointer_hpp.template_class__tx__pointer___">Template
+ Class <code class="computeroutput">tx::pointer<></code></a></dt>
+<dt><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.tx_pointer_hpp.template_class__tx__pointer_to_member___">Template
+ Class <code class="computeroutput">tx::pointer_to_member<></code></a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost { namespace stm { namespace tx {
+
+ template <typename T> class pointer;
+ template <typename C, typename R> class pointer_to_member;
+
+}}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins.deep_transactional_objects.tx_pointer_hpp.template_class__tx__pointer___"></a><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.tx_pointer_hpp.template_class__tx__pointer___" title="Template
+ Class tx::pointer<>">Template
+ Class <code class="computeroutput">tx::pointer<></code></a>
+</h6></div></div></div>
+<pre class="programlisting">template <typename T>
+class pointer : public transaction_object< pointer<T> >
+{
+protected:
+ T* val_;
+public:
+ pointer();
+ template<class U> pointer(pointer<U> const& r);
+
+ template <typename U> pointer(U* v);
+ pointer(T* v);
+ ~pointer() {}
+
+ operator T*() const;
+ operator T*&();
+
+ T*& get();
+ T const * get() const;
+
+ T const * operator->() const;
+ T const & operator*() const;
+
+ T * operator->();
+ T & operator*();
+};
+</pre>
+</div>
+<div class="section" lang="en"><div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins.deep_transactional_objects.tx_pointer_hpp.template_class__tx__pointer_to_member___"></a><a href="mixins.html#toward_boost_stm.reference.mixins.deep_transactional_objects.tx_pointer_hpp.template_class__tx__pointer_to_member___" title="Template
+ Class tx::pointer_to_member<>">Template
+ Class <code class="computeroutput">tx::pointer_to_member<></code></a>
+</h6></div></div></div></div>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_stm.reference.mixins.shallow_transactional_objects"></a><a href="mixins.html#toward_boost_stm.reference.mixins.shallow_transactional_objects" title="Shallow
+ Transactional Objects">Shallow
+ Transactional Objects</a>
+</h4></div></div></div>
+<div class="toc"><dl><dt><a href="mixins.html#toward_boost_stm.reference.mixins.shallow_transactional_objects.shallow_transaction_object_hpp">
+ Header <code class="computeroutput"><boost/stm/shallow_transaction_object.hpp></code></a></dt></dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.mixins.shallow_transactional_objects.shallow_transaction_object_hpp"></a><a href="mixins.html#toward_boost_stm.reference.mixins.shallow_transactional_objects.shallow_transaction_object_hpp" title="
+ Header <boost/stm/shallow_transaction_object.hpp>">
+ Header <code class="computeroutput"><boost/stm/shallow_transaction_object.hpp></code></a>
+</h5></div></div></div>
+<div class="toc"><dl><dt><a href="mixins.html#toward_boost_stm.reference.mixins.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___">Template
+ Class <code class="computeroutput">shallow_transaction_object<></code></a></dt></dl></div>
+<pre class="programlisting">namespace boost { namespace stm {
+ template <class Derived, typename Base=base_transaction_object>
+ class shallow_transaction_object;
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___"></a><a href="mixins.html#toward_boost_stm.reference.mixins.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___" title="Template
+ Class shallow_transaction_object<>">Template
+ Class <code class="computeroutput">shallow_transaction_object<></code></a>
+</h6></div></div></div>
+<div class="toc"><dl>
+<dt><a href="mixins.html#toward_boost_stm.reference.mixins.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__clone___">Virtual
+ function <code class="computeroutput">clone()</code></a></dt>
+<dt><a href="mixins.html#toward_boost_stm.reference.mixins.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__copy_state___">Virtual
+ function <code class="computeroutput">copy_state()</code></a></dt>
+<dt><a href="mixins.html#toward_boost_stm.reference.mixins.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__move_state___">Virtual
+ function <code class="computeroutput">move_state()</code></a></dt>
+<dt><a href="mixins.html#toward_boost_stm.reference.mixins.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__cache_deallocate___">Virtual
+ function <code class="computeroutput">cache_deallocate()</code></a></dt>
+</dl></div>
+
+ To further simplify the usage of TBoost.STM, an intermediate template
+ class was built which is meant to sit between the base_transaction_object
+ and the user-defined transaction objects. The purpose of this intermediate
+ class is to reduce the code overhead needed for user-defined transaction
+ objects. To do this, the curiously recurring template pattern developed
+ by James Coplien was used.
+ 
+
+ With the templatized <code class="computeroutput">shallow_transaction_object</code>,
+ client-side transaction objects need only to derive from it and pass
+ their class type as its template parameter. At compile-time the transaction_object
+ generates the necessary code to override copy_state() and implement
+ operator new and operator delete using TBoost.STM's memory manager
+ for all user-defined types derived from it.
+ 
+<pre class="programlisting">template <class Derived, typename Base=base_transaction_object>
+class shallow_transaction_object : public base_transaction_object {
+public:
+
+ virtual base_transaction_object* clone(transaction* t) const;
+ virtual void cache_deallocate();
+
+ virtual void copy_state(base_transaction_object const * const rhs);
+ virtual void move_state(base_transaction_object * rhs);
+};
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__clone___"></a><a href="mixins.html#toward_boost_stm.reference.mixins.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__clone___" title="Virtual
+ function clone()">Virtual
+ function <code class="computeroutput">clone()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual base_transaction_object* clone(transaction* t) const;
+</pre>
+
+ The clone() method calls to the free function cache_new_copy which
+ allocates enough memory for the new object and then do a memcpy by
+ default.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__copy_state___"></a><a href="mixins.html#toward_boost_stm.reference.mixins.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__copy_state___" title="Virtual
+ function copy_state()">Virtual
+ function <code class="computeroutput">copy_state()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void copy_state(base_transaction_object const * const rhs);
+</pre>
+
+ The copy_state() method call to the free function cache_copy which
+ do a memcpy by default.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__move_state___"></a><a href="mixins.html#toward_boost_stm.reference.mixins.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__move_state___" title="Virtual
+ function move_state()">Virtual
+ function <code class="computeroutput">move_state()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void move_state(base_transaction_object * rhs);
+</pre>
+
+ The move_state() method call to the free function cache_copy which
+ do a memcpy by default.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__cache_deallocate___"></a><a href="mixins.html#toward_boost_stm.reference.mixins.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__cache_deallocate___" title="Virtual
+ function cache_deallocate()">Virtual
+ function <code class="computeroutput">cache_deallocate()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void cache_deallocate();
+</pre>
+
+ The cache_deallocate() method call to the free function cache_deallocate
+ which do a memcpy by default.
+ 
+</div>
+</div>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_stm.reference.mixins.smart_pointers"></a><a href="mixins.html#toward_boost_stm.reference.mixins.smart_pointers" title="Smart
+ pointers">Smart
+ pointers</a>
+</h4></div></div></div>
+<div class="toc"><dl><dt><a href="mixins.html#toward_boost_stm.reference.mixins.smart_pointers.txs_ptr_hpp">
+ Header <code class="computeroutput"><boost/stm/tx_ptr.hpp></code></a></dt></dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.mixins.smart_pointers.txs_ptr_hpp"></a><a href="mixins.html#toward_boost_stm.reference.mixins.smart_pointers.txs_ptr_hpp" title="
+ Header <boost/stm/tx_ptr.hpp>">
+ Header <code class="computeroutput"><boost/stm/tx_ptr.hpp></code></a>
+</h5></div></div></div>
+<div class="toc"><dl>
+<dt><a href="mixins.html#toward_boost_stm.reference.mixins.smart_pointers.txs_ptr_hpp.template_class__read_ptr___">Template
+ Class <code class="computeroutput">read_ptr<></code></a></dt>
+<dt><a href="mixins.html#toward_boost_stm.reference.mixins.smart_pointers.txs_ptr_hpp.template_class__write_ptr___">Template
+ Class <code class="computeroutput">write_ptr<></code></a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost { namespace stm {
+ template <typename T> class read_ptr;
+ template <typename T> class write_ptr;
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins.smart_pointers.txs_ptr_hpp.template_class__read_ptr___"></a><a href="mixins.html#toward_boost_stm.reference.mixins.smart_pointers.txs_ptr_hpp.template_class__read_ptr___" title="Template
+ Class read_ptr<>">Template
+ Class <code class="computeroutput">read_ptr<></code></a>
+</h6></div></div></div>
+<pre class="programlisting">template <typename T> class read_ptr {
+public:
+ inline read_ptr(transaction &t, T const &tx_obj);
+ const T* get() const;
+ inline T const & operator*() const;
+ inline T const * operator->() const;
+
+ inline transaction &trans();
+ T* write_ptr();
+};
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins.smart_pointers.txs_ptr_hpp.template_class__write_ptr___"></a><a href="mixins.html#toward_boost_stm.reference.mixins.smart_pointers.txs_ptr_hpp.template_class__write_ptr___" title="Template
+ Class write_ptr<>">Template
+ Class <code class="computeroutput">write_ptr<></code></a>
+</h6></div></div></div>
+<pre class="programlisting">template <typename T> class write_ptr {
+public:
+ inline write_ptr(transaction &t, T & tx_obj);
+
+ T* get() const;
+ inline T& operator*();
+ inline T* operator->();
+</pre>
+</div>
+</div>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 Justin E. Gottchlich Copyright © 2009 Vicente J. Botet Escriba
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="core.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="warppers.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/stm/branches/vbe/libs/stm/doc/html/toward_boost_stm/reference/mixins_transactional_objects.html
==============================================================================
--- (empty file)
+++ sandbox/stm/branches/vbe/libs/stm/doc/html/toward_boost_stm/reference/mixins_transactional_objects.html 2009-11-11 11:03:52 EST (Wed, 11 Nov 2009)
@@ -0,0 +1,522 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Mixins
+ Transactional Objects</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../../index.html" title="Chapter 1. Toward.Boost.STM">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="core.html" title="Core">
+<link rel="next" href="warppers_transactional_objects.html" title="Warppers
+ Transactional Objects">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="TowardBoostSTM" width="277" height="86" src="../../../image/Toward_Boost_STM.jpg"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="core.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="warppers_transactional_objects.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_stm.reference.mixins_transactional_objects"></a><a href="mixins_transactional_objects.html" title="Mixins
+ Transactional Objects">Mixins
+ Transactional Objects</a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy">Deep
+ Copy</a></dt>
+<dd><dl>
+<dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.transaction_object_hpp">
+ Header <code class="computeroutput"><boost/stm/transaction_object.hpp></code></a></dt>
+<dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.transaction_object_ptr_hpp">
+ Header <code class="computeroutput"><boost/stm/transaction_object_ptr.hpp></code></a></dt>
+<dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.tx_numeric_hpp">
+ Header <code class="computeroutput"><boost/stm/tx/numeric.hpp></code></a></dt>
+<dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.tx_pointer_hpp">
+ Header <code class="computeroutput"><boost/stm/tx/pointer.hpp></code></a></dt>
+</dl></dd>
+<dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.shallow_copy">Shallow
+ Copy</a></dt>
+<dd><dl><dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.shallow_copy.shallow_transaction_object_hpp">
+ Header <code class="computeroutput"><boost/stm/shallow_transaction_object.hpp></code></a></dt></dl></dd>
+<dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.smart_pointers">Smart
+ pointers</a></dt>
+<dd><dl><dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.smart_pointers.txs_ptr_hpp">
+ Header <code class="computeroutput"><boost/stm/tx_ptr.hpp></code></a></dt></dl></dd>
+</dl></div>
+
+ Mixing transactional objects can be deep or shallow copied.
+ 
+
+ Both schemas can be used by the same smart pointers.
+ 
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_stm.reference.mixins_transactional_objects.deep_copy"></a><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy" title="Deep
+ Copy">Deep
+ Copy</a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.transaction_object_hpp">
+ Header <code class="computeroutput"><boost/stm/transaction_object.hpp></code></a></dt>
+<dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.transaction_object_ptr_hpp">
+ Header <code class="computeroutput"><boost/stm/transaction_object_ptr.hpp></code></a></dt>
+<dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.tx_numeric_hpp">
+ Header <code class="computeroutput"><boost/stm/tx/numeric.hpp></code></a></dt>
+<dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.tx_pointer_hpp">
+ Header <code class="computeroutput"><boost/stm/tx/pointer.hpp></code></a></dt>
+</dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.mixins_transactional_objects.deep_copy.transaction_object_hpp"></a><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.transaction_object_hpp" title="
+ Header <boost/stm/transaction_object.hpp>">
+ Header <code class="computeroutput"><boost/stm/transaction_object.hpp></code></a>
+</h5></div></div></div>
+<div class="toc"><dl>
+<dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.transaction_object_hpp.template_class__transaction_object___">Template
+ Class <code class="computeroutput">transaction_object<></code></a></dt>
+<dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.transaction_object_hpp.template_class__native_trans___">Template
+ Class <code class="computeroutput">native_trans<></code></a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost { namespace stm {
+ template <class Derived> class transaction_object;
+ template <typename T> class native_trans;
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins_transactional_objects.deep_copy.transaction_object_hpp.template_class__transaction_object___"></a><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.transaction_object_hpp.template_class__transaction_object___" title="Template
+ Class transaction_object<>">Template
+ Class <code class="computeroutput">transaction_object<></code></a>
+</h6></div></div></div>
+<div class="toc"><dl>
+<dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.transaction_object_hpp.template_class__transaction_object___.virtual_function__clone___">Virtual
+ function <code class="computeroutput">clone()</code></a></dt>
+<dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.transaction_object_hpp.template_class__transaction_object___.virtual_function__copy_state___">Virtual
+ function <code class="computeroutput">copy_state()</code></a></dt>
+<dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.transaction_object_hpp.template_class__transaction_object___.virtual_function__move_state___">Virtual
+ function <code class="computeroutput">move_state()</code></a></dt>
+<dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.transaction_object_hpp.template_class__transaction_object___.virtual_function__cache_deallocate___">Virtual
+ function <code class="computeroutput">cache_deallocate()</code></a></dt>
+</dl></div>
+
+ To further simplify the usage of TBoost.STM, an intermediate template
+ class was built which is meant to sit between the base_transaction_object
+ and the user-defined transaction objects. The purpose of this intermediate
+ class is to reduce the code overhead needed for user-defined transaction
+ objects. To do this, the curiously recurring template pattern developed
+ by James Coplien was used.
+ 
+
+ With the templatized transaction_object, client-side transaction objects
+ need only to derive from it and pass their class type as its template
+ parameter. At compile-time the transaction_object generates the necessary
+ code to override copy_state() and implement operator new and operator
+ delete using TBoost.STM's memory manager for all user-defined types
+ derived from it.
+ 
+<pre class="programlisting">template <class Derived>
+class transaction_object : public base_transaction_object {
+public:
+
+ virtual base_transaction_object* clone(transaction* t) const;
+ virtual void copy_state(base_transaction_object const * const rhs);
+ virtual void move_state(base_transaction_object * rhs);
+};
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins_transactional_objects.deep_copy.transaction_object_hpp.template_class__transaction_object___.virtual_function__clone___"></a><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.transaction_object_hpp.template_class__transaction_object___.virtual_function__clone___" title="Virtual
+ function clone()">Virtual
+ function <code class="computeroutput">clone()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual base_transaction_object* clone(transaction* t) const;
+</pre>
+
+ The clone() creates a new Derived instace using the copy constructor.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins_transactional_objects.deep_copy.transaction_object_hpp.template_class__transaction_object___.virtual_function__copy_state___"></a><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.transaction_object_hpp.template_class__transaction_object___.virtual_function__copy_state___" title="Virtual
+ function copy_state()">Virtual
+ function <code class="computeroutput">copy_state()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void copy_state(base_transaction_object const * const rhs);
+</pre>
+
+ The copy_state() assigns the rhs to this instace using the copy-assignement
+ operator.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins_transactional_objects.deep_copy.transaction_object_hpp.template_class__transaction_object___.virtual_function__move_state___"></a><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.transaction_object_hpp.template_class__transaction_object___.virtual_function__move_state___" title="Virtual
+ function move_state()">Virtual
+ function <code class="computeroutput">move_state()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void move_state(base_transaction_object * rhs);
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins_transactional_objects.deep_copy.transaction_object_hpp.template_class__transaction_object___.virtual_function__cache_deallocate___"></a><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.transaction_object_hpp.template_class__transaction_object___.virtual_function__cache_deallocate___" title="Virtual
+ function cache_deallocate()">Virtual
+ function <code class="computeroutput">cache_deallocate()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void cache_deallocate();
+</pre>
+
+ The cache_deallocate() delete this instace using the delete operator.
+ 
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins_transactional_objects.deep_copy.transaction_object_hpp.template_class__native_trans___"></a><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.transaction_object_hpp.template_class__native_trans___" title="Template
+ Class native_trans<>">Template
+ Class <code class="computeroutput">native_trans<></code></a>
+</h6></div></div></div>
+<pre class="programlisting">template <typename T> class native_trans : public transaction_object< native_trans<T> > {
+public:
+ native_trans(){}
+ native_trans(T const &rhs);
+ native_trans(native_trans const &rhs);
+ native_trans(native_trans &&rhs);
+ native_trans& operator=(native_trans &&rhs);
+
+ native_trans& operator=(T const &rhs);
+
+ native_trans& operator--();
+ native_trans operator--(int);
+ native_trans& operator++();
+ native_trans operator++(int);
+ native_trans& operator+=(T const &rhs);
+ native_trans operator+(native_trans const &rhs);
+
+ operator T() const;
+ T& value();
+ T const & value() const;
+};
+</pre>
+</div>
+</div>
+<div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.mixins_transactional_objects.deep_copy.transaction_object_ptr_hpp"></a><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.transaction_object_ptr_hpp" title="
+ Header <boost/stm/transaction_object_ptr.hpp>">
+ Header <code class="computeroutput"><boost/stm/transaction_object_ptr.hpp></code></a>
+</h5></div></div></div></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.mixins_transactional_objects.deep_copy.tx_numeric_hpp"></a><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.tx_numeric_hpp" title="
+ Header <boost/stm/tx/numeric.hpp>">
+ Header <code class="computeroutput"><boost/stm/tx/numeric.hpp></code></a>
+</h5></div></div></div>
+<div class="toc"><dl><dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.tx_numeric_hpp.template_class__tx__numeric___">Template
+ Class <code class="computeroutput">tx::numeric<></code></a></dt></dl></div>
+<pre class="programlisting">namespace boost { namespace stm { namespace tx {
+
+ template <typename T> class numeric;
+
+ typedef numeric<bool> boolean;
+ typedef numeric<char> char_t;
+ typedef numeric<unsigned char> uchar_t;
+ typedef numeric<short> short_t;
+ typedef numeric<unsigned short> ushort_t;
+ typedef numeric<int> int_t;
+ typedef numeric<unsigned int> uint_t;
+ typedef numeric<long> long_t;
+ typedef numeric<unsigned long> ulong_t;
+ typedef numeric<float> float_t;
+ typedef numeric<double> double_t;
+
+}}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins_transactional_objects.deep_copy.tx_numeric_hpp.template_class__tx__numeric___"></a><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.tx_numeric_hpp.template_class__tx__numeric___" title="Template
+ Class tx::numeric<>">Template
+ Class <code class="computeroutput">tx::numeric<></code></a>
+</h6></div></div></div>
+<pre class="programlisting">template <typename T>
+class numeric : public transaction_object< numeric<T> >
+{
+protected:
+ T val_;
+public:
+ numeric();
+ template<class U> numeric(numeric<U> const& u);
+ template <typename U> numeric(U v);
+
+ operator T() const;
+ operator T&();
+
+ T& ref();
+ T value();
+
+};
+</pre>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.mixins_transactional_objects.deep_copy.tx_pointer_hpp"></a><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.tx_pointer_hpp" title="
+ Header <boost/stm/tx/pointer.hpp>">
+ Header <code class="computeroutput"><boost/stm/tx/pointer.hpp></code></a>
+</h5></div></div></div>
+<div class="toc"><dl>
+<dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.tx_pointer_hpp.template_class__tx__pointer___">Template
+ Class <code class="computeroutput">tx::pointer<></code></a></dt>
+<dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.tx_pointer_hpp.template_class__tx__pointer_to_member___">Template
+ Class <code class="computeroutput">tx::pointer_to_member<></code></a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost { namespace stm { namespace tx {
+
+ template <typename T> class pointer;
+ template <typename C, typename R> class pointer_to_member;
+
+}}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins_transactional_objects.deep_copy.tx_pointer_hpp.template_class__tx__pointer___"></a><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.tx_pointer_hpp.template_class__tx__pointer___" title="Template
+ Class tx::pointer<>">Template
+ Class <code class="computeroutput">tx::pointer<></code></a>
+</h6></div></div></div>
+<pre class="programlisting">template <typename T>
+class pointer : public transaction_object< pointer<T> >
+{
+protected:
+ T* val_;
+public:
+ pointer();
+ template<class U> pointer(pointer<U> const& r);
+
+ template <typename U> pointer(U* v);
+ pointer(T* v);
+ ~pointer() {}
+
+ operator T*() const;
+ operator T*&();
+
+ T*& get();
+ T const * get() const;
+
+ T const * operator->() const;
+ T const & operator*() const;
+
+ T * operator->();
+ T & operator*();
+};
+</pre>
+</div>
+<div class="section" lang="en"><div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins_transactional_objects.deep_copy.tx_pointer_hpp.template_class__tx__pointer_to_member___"></a><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.deep_copy.tx_pointer_hpp.template_class__tx__pointer_to_member___" title="Template
+ Class tx::pointer_to_member<>">Template
+ Class <code class="computeroutput">tx::pointer_to_member<></code></a>
+</h6></div></div></div></div>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_stm.reference.mixins_transactional_objects.shallow_copy"></a><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.shallow_copy" title="Shallow
+ Copy">Shallow
+ Copy</a>
+</h4></div></div></div>
+<div class="toc"><dl><dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.shallow_copy.shallow_transaction_object_hpp">
+ Header <code class="computeroutput"><boost/stm/shallow_transaction_object.hpp></code></a></dt></dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.mixins_transactional_objects.shallow_copy.shallow_transaction_object_hpp"></a><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.shallow_copy.shallow_transaction_object_hpp" title="
+ Header <boost/stm/shallow_transaction_object.hpp>">
+ Header <code class="computeroutput"><boost/stm/shallow_transaction_object.hpp></code></a>
+</h5></div></div></div>
+<div class="toc"><dl><dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.shallow_copy.shallow_transaction_object_hpp.template_class__shallow_transaction_object___">Template
+ Class <code class="computeroutput">shallow_transaction_object<></code></a></dt></dl></div>
+<pre class="programlisting">namespace boost { namespace stm {
+ template <class Derived, typename Base=base_transaction_object>
+ class shallow_transaction_object;
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins_transactional_objects.shallow_copy.shallow_transaction_object_hpp.template_class__shallow_transaction_object___"></a><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.shallow_copy.shallow_transaction_object_hpp.template_class__shallow_transaction_object___" title="Template
+ Class shallow_transaction_object<>">Template
+ Class <code class="computeroutput">shallow_transaction_object<></code></a>
+</h6></div></div></div>
+<div class="toc"><dl>
+<dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.shallow_copy.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__clone___">Virtual
+ function <code class="computeroutput">clone()</code></a></dt>
+<dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.shallow_copy.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__copy_state___">Virtual
+ function <code class="computeroutput">copy_state()</code></a></dt>
+<dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.shallow_copy.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__move_state___">Virtual
+ function <code class="computeroutput">move_state()</code></a></dt>
+<dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.shallow_copy.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__cache_deallocate___">Virtual
+ function <code class="computeroutput">cache_deallocate()</code></a></dt>
+</dl></div>
+
+ To further simplify the usage of TBoost.STM, an intermediate template
+ class was built which is meant to sit between the base_transaction_object
+ and the user-defined transaction objects. The purpose of this intermediate
+ class is to reduce the code overhead needed for user-defined transaction
+ objects. To do this, the curiously recurring template pattern developed
+ by James Coplien was used.
+ 
+
+ With the templatized <code class="computeroutput">shallow_transaction_object</code>,
+ client-side transaction objects need only to derive from it and pass
+ their class type as its template parameter. At compile-time the transaction_object
+ generates the necessary code to override copy_state() and implement
+ operator new and operator delete using TBoost.STM's memory manager
+ for all user-defined types derived from it.
+ 
+<pre class="programlisting">template <class Derived, typename Base=base_transaction_object>
+class shallow_transaction_object : public base_transaction_object {
+public:
+
+ virtual base_transaction_object* clone(transaction* t) const;
+ virtual void cache_deallocate();
+
+ virtual void copy_state(base_transaction_object const * const rhs);
+ virtual void move_state(base_transaction_object * rhs);
+};
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins_transactional_objects.shallow_copy.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__clone___"></a><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.shallow_copy.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__clone___" title="Virtual
+ function clone()">Virtual
+ function <code class="computeroutput">clone()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual base_transaction_object* clone(transaction* t) const;
+</pre>
+
+ The clone() method calls to the free function cache_new_copy which
+ allocates enough memory for the new object and then do a memcpy by
+ default.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins_transactional_objects.shallow_copy.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__copy_state___"></a><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.shallow_copy.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__copy_state___" title="Virtual
+ function copy_state()">Virtual
+ function <code class="computeroutput">copy_state()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void copy_state(base_transaction_object const * const rhs);
+</pre>
+
+ The copy_state() method call to the free function cache_copy which
+ do a memcpy by default.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins_transactional_objects.shallow_copy.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__move_state___"></a><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.shallow_copy.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__move_state___" title="Virtual
+ function move_state()">Virtual
+ function <code class="computeroutput">move_state()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void move_state(base_transaction_object * rhs);
+</pre>
+
+ The move_state() method call to the free function cache_copy which
+ do a memcpy by default.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins_transactional_objects.shallow_copy.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__cache_deallocate___"></a><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.shallow_copy.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__cache_deallocate___" title="Virtual
+ function cache_deallocate()">Virtual
+ function <code class="computeroutput">cache_deallocate()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void cache_deallocate();
+</pre>
+
+ The cache_deallocate() method call to the free function cache_deallocate
+ which do a memcpy by default.
+ 
+</div>
+</div>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_stm.reference.mixins_transactional_objects.smart_pointers"></a><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.smart_pointers" title="Smart
+ pointers">Smart
+ pointers</a>
+</h4></div></div></div>
+<div class="toc"><dl><dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.smart_pointers.txs_ptr_hpp">
+ Header <code class="computeroutput"><boost/stm/tx_ptr.hpp></code></a></dt></dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.mixins_transactional_objects.smart_pointers.txs_ptr_hpp"></a><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.smart_pointers.txs_ptr_hpp" title="
+ Header <boost/stm/tx_ptr.hpp>">
+ Header <code class="computeroutput"><boost/stm/tx_ptr.hpp></code></a>
+</h5></div></div></div>
+<div class="toc"><dl>
+<dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.smart_pointers.txs_ptr_hpp.template_class__read_ptr___">Template
+ Class <code class="computeroutput">read_ptr<></code></a></dt>
+<dt><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.smart_pointers.txs_ptr_hpp.template_class__write_ptr___">Template
+ Class <code class="computeroutput">write_ptr<></code></a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost { namespace stm {
+ template <typename T> class read_ptr;
+ template <typename T> class write_ptr;
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins_transactional_objects.smart_pointers.txs_ptr_hpp.template_class__read_ptr___"></a><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.smart_pointers.txs_ptr_hpp.template_class__read_ptr___" title="Template
+ Class read_ptr<>">Template
+ Class <code class="computeroutput">read_ptr<></code></a>
+</h6></div></div></div>
+<pre class="programlisting">template <typename T> class read_ptr {
+public:
+ inline read_ptr(transaction &t, T const &tx_obj);
+ const T* get() const;
+ inline T const & operator*() const;
+ inline T const * operator->() const;
+
+ inline transaction &trans();
+ T* write_ptr();
+};
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.mixins_transactional_objects.smart_pointers.txs_ptr_hpp.template_class__write_ptr___"></a><a href="mixins_transactional_objects.html#toward_boost_stm.reference.mixins_transactional_objects.smart_pointers.txs_ptr_hpp.template_class__write_ptr___" title="Template
+ Class write_ptr<>">Template
+ Class <code class="computeroutput">write_ptr<></code></a>
+</h6></div></div></div>
+<pre class="programlisting">template <typename T> class write_ptr {
+public:
+ inline write_ptr(transaction &t, T & tx_obj);
+
+ T* get() const;
+ inline T& operator*();
+ inline T* operator->();
+</pre>
+</div>
+</div>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 Justin E. Gottchlich Copyright © 2009 Vicente J. Botet Escriba
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="core.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="warppers_transactional_objects.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/stm/branches/vbe/libs/stm/doc/html/toward_boost_stm/reference/shallow_transactional_objects.html
==============================================================================
--- (empty file)
+++ sandbox/stm/branches/vbe/libs/stm/doc/html/toward_boost_stm/reference/shallow_transactional_objects.html 2009-11-11 11:03:52 EST (Wed, 11 Nov 2009)
@@ -0,0 +1,165 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Shallow
+ Transactional Objects</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../../index.html" title="Chapter 1. Toward.Boost.STM">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="deep_transactional_objects.html" title="Deep
+ Transactional objects">
+<link rel="next" href="non_transactional_objects.html" title="Non
+ Transactional Objects">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="TowardBoostSTM" width="277" height="86" src="../../../image/Toward_Boost_STM.jpg"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="deep_transactional_objects.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="non_transactional_objects.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_stm.reference.shallow_transactional_objects"></a><a href="shallow_transactional_objects.html" title="Shallow
+ Transactional Objects">Shallow
+ Transactional Objects</a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="shallow_transactional_objects.html#toward_boost_stm.reference.shallow_transactional_objects.shallow_transaction_object_hpp">
+ Header <code class="computeroutput"><boost/stm/shallow_transaction_object.hpp></code></a></dt>
+<dd><dl><dt><a href="shallow_transactional_objects.html#toward_boost_stm.reference.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___">Template
+ Class <code class="computeroutput">shallow_transaction_object<></code></a></dt></dl></dd>
+</dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_stm.reference.shallow_transactional_objects.shallow_transaction_object_hpp"></a><a href="shallow_transactional_objects.html#toward_boost_stm.reference.shallow_transactional_objects.shallow_transaction_object_hpp" title="
+ Header <boost/stm/shallow_transaction_object.hpp>">
+ Header <code class="computeroutput"><boost/stm/shallow_transaction_object.hpp></code></a>
+</h4></div></div></div>
+<div class="toc"><dl><dt><a href="shallow_transactional_objects.html#toward_boost_stm.reference.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___">Template
+ Class <code class="computeroutput">shallow_transaction_object<></code></a></dt></dl></div>
+<pre class="programlisting">namespace boost { namespace stm {
+ template <class Derived, typename Base=base_transaction_object>
+ class shallow_transaction_object;
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___"></a><a href="shallow_transactional_objects.html#toward_boost_stm.reference.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___" title="Template
+ Class shallow_transaction_object<>">Template
+ Class <code class="computeroutput">shallow_transaction_object<></code></a>
+</h5></div></div></div>
+<div class="toc"><dl>
+<dt><a href="shallow_transactional_objects.html#toward_boost_stm.reference.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__clone___">Virtual
+ function <code class="computeroutput">clone()</code></a></dt>
+<dt><a href="shallow_transactional_objects.html#toward_boost_stm.reference.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__copy_state___">Virtual
+ function <code class="computeroutput">copy_state()</code></a></dt>
+<dt><a href="shallow_transactional_objects.html#toward_boost_stm.reference.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__move_state___">Virtual
+ function <code class="computeroutput">move_state()</code></a></dt>
+<dt><a href="shallow_transactional_objects.html#toward_boost_stm.reference.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__cache_deallocate___">Virtual
+ function <code class="computeroutput">cache_deallocate()</code></a></dt>
+</dl></div>
+
+ To further simplify the usage of TBoost.STM, an intermediate template
+ class was built which is meant to sit between the base_transaction_object
+ and the user-defined transaction objects. The purpose of this intermediate
+ class is to reduce the code overhead needed for user-defined transaction
+ objects. To do this, the curiously recurring template pattern developed
+ by James Coplien was used.
+ 
+
+ With the templatized <code class="computeroutput">shallow_transaction_object</code>,
+ client-side transaction objects need only to derive from it and pass
+ their class type as its template parameter. At compile-time the transaction_object
+ generates the necessary code to override copy_state() and implement operator
+ new and operator delete using TBoost.STM's memory manager for all user-defined
+ types derived from it.
+ 
+<pre class="programlisting">template <class Derived, typename Base=base_transaction_object>
+class shallow_transaction_object : public base_transaction_object {
+public:
+
+ virtual base_transaction_object* clone(transaction* t) const;
+ virtual void cache_deallocate();
+
+ virtual void copy_state(base_transaction_object const * const rhs);
+ virtual void move_state(base_transaction_object * rhs);
+};
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__clone___"></a><a href="shallow_transactional_objects.html#toward_boost_stm.reference.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__clone___" title="Virtual
+ function clone()">Virtual
+ function <code class="computeroutput">clone()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual base_transaction_object* clone(transaction* t) const;
+</pre>
+
+ The clone() method calls to the free function cache_new_copy which
+ allocates enough memory for the new object and then do a memcpy by
+ default.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__copy_state___"></a><a href="shallow_transactional_objects.html#toward_boost_stm.reference.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__copy_state___" title="Virtual
+ function copy_state()">Virtual
+ function <code class="computeroutput">copy_state()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void copy_state(base_transaction_object const * const rhs);
+</pre>
+
+ The copy_state() method call to the free function cache_copy which
+ do a memcpy by default.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__move_state___"></a><a href="shallow_transactional_objects.html#toward_boost_stm.reference.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__move_state___" title="Virtual
+ function move_state()">Virtual
+ function <code class="computeroutput">move_state()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void move_state(base_transaction_object * rhs);
+</pre>
+
+ The move_state() method call to the free function cache_copy which
+ do a memcpy by default.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__cache_deallocate___"></a><a href="shallow_transactional_objects.html#toward_boost_stm.reference.shallow_transactional_objects.shallow_transaction_object_hpp.template_class__shallow_transaction_object___.virtual_function__cache_deallocate___" title="Virtual
+ function cache_deallocate()">Virtual
+ function <code class="computeroutput">cache_deallocate()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void cache_deallocate();
+</pre>
+
+ The cache_deallocate() method call to the free function cache_deallocate
+ which do a memcpy by default.
+ 
+</div>
+</div>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 Justin E. Gottchlich Copyright © 2009 Vicente J. Botet Escriba
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="deep_transactional_objects.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="non_transactional_objects.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/stm/branches/vbe/libs/stm/doc/html/toward_boost_stm/reference/warppers.html
==============================================================================
--- (empty file)
+++ sandbox/stm/branches/vbe/libs/stm/doc/html/toward_boost_stm/reference/warppers.html 2009-11-11 11:03:52 EST (Wed, 11 Nov 2009)
@@ -0,0 +1,488 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Warppers</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../../index.html" title="Chapter 1. Toward.Boost.STM">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="mixins.html" title="Mixins">
+<link rel="next" href="non_transactional_objects.html" title="Non
+ Transactional Objects">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="TowardBoostSTM" width="277" height="86" src="../../../image/Toward_Boost_STM.jpg"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="mixins.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="non_transactional_objects.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_stm.reference.warppers"></a>Warppers
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="warppers.html#toward_boost_stm.reference.warppers.transactional_object_hpp">
+ Header <code class="computeroutput"><boost/stm/transactional_object.hpp></code></a></dt>
+<dd><dl><dt><a href="warppers.html#toward_boost_stm.reference.warppers.transactional_object_hpp.template_class__transactional_object___">Template
+ Class <code class="computeroutput">transactional_object<></code></a></dt></dl></dd>
+<dt><a href="warppers.html#toward_boost_stm.reference.warppers.smart_pointers">Smart
+ pointers</a></dt>
+<dd><dl><dt><a href="warppers.html#toward_boost_stm.reference.warppers.smart_pointers.tx_smart_ptr_hpp">
+ Header <code class="computeroutput"><boost/stm/tx/smart_ptr.hpp></code></a></dt></dl></dd>
+</dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_stm.reference.warppers.transactional_object_hpp"></a><a href="warppers.html#toward_boost_stm.reference.warppers.transactional_object_hpp" title="
+ Header <boost/stm/transactional_object.hpp>">
+ Header <code class="computeroutput"><boost/stm/transactional_object.hpp></code></a>
+</h4></div></div></div>
+<div class="toc"><dl><dt><a href="warppers.html#toward_boost_stm.reference.warppers.transactional_object_hpp.template_class__transactional_object___">Template
+ Class <code class="computeroutput">transactional_object<></code></a></dt></dl></div>
+<pre class="programlisting">namespace boost { namespace stm {
+ template <class T> class transactional_object;
+
+ template <typename T>
+ static transactional_object<T>* tx_up_cast(T* ptr);
+
+ template <typename T, typename U>
+ static transactional_object<T>* tx_static_cast(transactional_object<U>* ptr);
+
+ template <typename T, typename U>
+ static transactional_object<T>* tx_dynamic_cast(transactional_object<U>* ptr);
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.warppers.transactional_object_hpp.template_class__transactional_object___"></a><a href="warppers.html#toward_boost_stm.reference.warppers.transactional_object_hpp.template_class__transactional_object___" title="Template
+ Class transactional_object<>">Template
+ Class <code class="computeroutput">transactional_object<></code></a>
+</h5></div></div></div>
+<div class="toc"><dl>
+<dt><a href="warppers.html#toward_boost_stm.reference.warppers.transactional_object_hpp.template_class__transactional_object___.virtual_function__copy_state___">Virtual
+ function <code class="computeroutput">copy_state()</code></a></dt>
+<dt><a href="warppers.html#toward_boost_stm.reference.warppers.transactional_object_hpp.template_class__transactional_object___.virtual_function__move_state___">Virtual
+ function <code class="computeroutput">move_state()</code></a></dt>
+<dt><a href="warppers.html#toward_boost_stm.reference.warppers.transactional_object_hpp.template_class__transactional_object___.virtual_function__cache_deallocate___">Virtual
+ function <code class="computeroutput">cache_deallocate()</code></a></dt>
+</dl></div>
+
+ Transactional object wrapper. A <code class="computeroutput">transactional_object<T></code> is a base_transaction_object wrapping
+ an instance of type T. Provides the definition of the virtual functions
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ forward constructors to the wrapped type
+ </li>
+<li>
+<code class="computeroutput">copy_state</code>: relaying
+ on the cache_copy<T> generic function
+ </li>
+<li>
+<code class="computeroutput">move_state</code> and
+ </li>
+<li>
+<code class="computeroutput">cache_deallocate</code>: relaying
+ on the cache_copy<T> generic function
+ </li>
+</ul></div>
+
+ Defines in addition the functions <code class="computeroutput">new</code>
+ and <code class="computeroutput">delete</code> when <code class="computeroutput">BOOST_STM_USE_MEMORY_MANAGER</code> is defined
+ 
+
+ If a class D inherits from B we have that <code class="computeroutput">transactional_object<D></code> dont inherits from <code class="computeroutput">transactional_object<B></code>,
+ but we can static/dynamic cast them robustly.
+ 
+
+ Evidently the <code class="computeroutput">std::static_cast</code>/<code class="computeroutput">std::dynamic_cast</code>
+ do not works. We need to define the specific cast
+ 
+<pre class="programlisting">transactional_object<D>* d=...;
+transactional_object<B>* b=tx_static_cast<B>(d);
+
+transactional_object<B>* b=...;
+transactional_object<D>* d=tx_dynamic_cast<B>(b);
+</pre>
+
+ Synopsis
+ 
+<pre class="programlisting">template <typename T>
+class transactional_object : public base_transaction_object {
+public:
+ T value;
+
+ transactional_object();
+ transactional_object(const T*ptr);
+ transactional_object(transactional_object<T> const & r);
+ template <typename T1>
+ transactional_object(T1 const &p1);
+
+ template <typename T1, typename T2>
+ transactional_object(T1 const &p1, T2 const &p2);
+
+ transactional_object & operator=(transactional_object const & r);
+
+ virtual void copy_state(base_transaction_object const * const rhs);
+
+#ifdef BOOST_STM_USE_UNASIGNED_COPY
+ virtual void cache_deallocate();
+#endif
+
+#if BOST_STM_USE_MEMORY_MANAGER
+ void* operator new(size_t size) throw ();
+ void operator delete(void* mem);
+#endif
+
+};
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.warppers.transactional_object_hpp.template_class__transactional_object___.virtual_function__copy_state___"></a><a href="warppers.html#toward_boost_stm.reference.warppers.transactional_object_hpp.template_class__transactional_object___.virtual_function__copy_state___" title="Virtual
+ function copy_state()">Virtual
+ function <code class="computeroutput">copy_state()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void copy_state(base_transaction_object const * const rhs);
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.warppers.transactional_object_hpp.template_class__transactional_object___.virtual_function__move_state___"></a><a href="warppers.html#toward_boost_stm.reference.warppers.transactional_object_hpp.template_class__transactional_object___.virtual_function__move_state___" title="Virtual
+ function move_state()">Virtual
+ function <code class="computeroutput">move_state()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void move_state(base_transaction_object * rhs);
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.warppers.transactional_object_hpp.template_class__transactional_object___.virtual_function__cache_deallocate___"></a><a href="warppers.html#toward_boost_stm.reference.warppers.transactional_object_hpp.template_class__transactional_object___.virtual_function__cache_deallocate___" title="Virtual
+ function cache_deallocate()">Virtual
+ function <code class="computeroutput">cache_deallocate()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void cache_deallocate()=0;
+</pre>
+</div>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_stm.reference.warppers.smart_pointers"></a><a href="warppers.html#toward_boost_stm.reference.warppers.smart_pointers" title="Smart
+ pointers">Smart
+ pointers</a>
+</h4></div></div></div>
+<div class="toc"><dl><dt><a href="warppers.html#toward_boost_stm.reference.warppers.smart_pointers.tx_smart_ptr_hpp">
+ Header <code class="computeroutput"><boost/stm/tx/smart_ptr.hpp></code></a></dt></dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.warppers.smart_pointers.tx_smart_ptr_hpp"></a><a href="warppers.html#toward_boost_stm.reference.warppers.smart_pointers.tx_smart_ptr_hpp" title="
+ Header <boost/stm/tx/smart_ptr.hpp>">
+ Header <code class="computeroutput"><boost/stm/tx/smart_ptr.hpp></code></a>
+</h5></div></div></div>
+<div class="toc"><dl>
+<dt><a href="warppers.html#toward_boost_stm.reference.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__tx_obj___">Template
+ Class <code class="computeroutput">tx_obj<></code></a></dt>
+<dt><a href="warppers.html#toward_boost_stm.reference.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__tx_ptr___">Template
+ Class <code class="computeroutput">tx_ptr<></code></a></dt>
+<dt><a href="warppers.html#toward_boost_stm.reference.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__rd_ptr___">Template
+ Class <code class="computeroutput">rd_ptr<></code></a></dt>
+<dt><a href="warppers.html#toward_boost_stm.reference.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__upgrd_ptr___">Template
+ Class <code class="computeroutput">upgrd_ptr<></code></a></dt>
+<dt><a href="warppers.html#toward_boost_stm.reference.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__wr_ptr___">Template
+ Class <code class="computeroutput">wr_ptr<></code></a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost { namespace stm {
+
+ template <typename T> class tx_obj;
+ template <typename T, typename U>
+ bool operator==(const tx_obj<T>& lhs, const tx_obj<U>& rhs);
+ template <typename T, typename U>
+ bool operator==(const T& lhs, const tx_obj<U>& rhs);
+ template <typename T, typename U>
+ bool operator==(const tx_obj<T>& lhs, const U& rhs);
+ template <typename T, typename U>
+ bool operator!=(const tx_obj<T>& lhs, const tx_obj<U>& rhs);
+ template <typename T, typename U>
+ bool operator!=(const tx_obj<T>& lhs, const tx_obj<U>& rhs);
+ template<class T> inline void swap(tx_obj<T> & a, tx_obj<T> & b);
+
+ template <typename T> class tx_ptr;
+ template <typename T, typename U>
+ bool operator==(const tx_ptr<T>& lhs, const tx_ptr<U>& rhs);
+ template <typename T, typename U>
+ bool operator!=(const tx_ptr<T>& lhs, const tx_ptr<U>& rhs);
+ template<class T> inline void swap(tx_ptr<T> & a, tx_ptr<T> & b);
+
+ template <typename T>
+ void delete_ptr(tx_ptr<T> ptr);
+ template <typename T>
+ void delete_ptr(transaction& tx, tx_ptr<T> ptr);
+
+ template <typename T, typename U>
+ static tx_ptr<T> tx_static_cast(tx_ptr<U> ptr);
+ template <typename T, typename U>
+ static tx_ptr<T>* tx_dynamic_cast(tx_ptr<U> ptr);
+
+ template <typename T> class rd_ptr;
+ template <typename T>
+ rd_ptr<T> make_rd_ptr(transaction& tx, tx_ptr<T> ptr);
+ template <typename T>
+ rd_ptr<T> make_rd_ptr(transaction& tx, tx_obj<T> const & ref);
+
+ template <typename T>
+ rd_ptr<T> make_rd_ptr(tx_ptr<T> ptr);
+ template <typename T>
+ rd_ptr<T> make_rd_ptr(tx_obj<T> const & ref);
+ template <typename T>
+ void delete_ptr(rd_ptr<T> ptr);
+ template <typename T>
+ void delete_ptr(transaction& tx, rd_ptr<T> ptr);
+
+ template <typename T> class upgrd_ptr;
+ template <typename T>
+ void delete_ptr(upgrd_ptr<T> const& ptr);
+ template <typename T>
+ void delete_ptr(transaction& tx, upgrd_ptr<T> const& ptr);
+
+ template <typename T> class wr_ptr;
+ template <typename T>
+ wr_ptr<T> make_wr_ptr(transaction& tx, tx_ptr<T>& ptr);
+ template <typename T>
+ wr_ptr<T> make_wr_ptr(tx_ptr<T>& ptr);
+ template <typename T>
+ void delete_ptr(wr_ptr<T> ptr);
+ template <typename T>
+ void delete_ptr(transaction& tx, wr_ptr<T> const& ptr);
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__tx_obj___"></a><a href="warppers.html#toward_boost_stm.reference.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__tx_obj___" title="Template
+ Class tx_obj<>">Template
+ Class <code class="computeroutput">tx_obj<></code></a>
+</h6></div></div></div>
+
+ tx_obj is a kind of smart pointer to a wrapped transactional_object
+ T providing builting operators
+ 
+<pre class="programlisting">template <typename T> class tx_obj {
+public:
+ tx_obj();
+ template<ctypename Y> tx_obj(tx_obj<Y> const& r);
+
+ template <typename T1> tx_obj(T1 p1);
+
+ T* operator->();
+ const T* operator->() const;
+ T& operator*();
+ const T& operator*() const;
+ T* get();
+ const T* get() const;
+ T& ref();
+ const T& ref() const;
+
+ tx_obj& operator--();
+ T operator--(int);
+
+ tx_obj& operator++();
+ T operator++(int);
+
+ tx_obj& operator+=(T const &rhs);
+ T operator+(T const &rhs) const;
+};
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__tx_ptr___"></a><a href="warppers.html#toward_boost_stm.reference.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__tx_ptr___" title="Template
+ Class tx_ptr<>">Template
+ Class <code class="computeroutput">tx_ptr<></code></a>
+</h6></div></div></div>
+
+ a tx_ptr<T> is an smart pointer to a transactional_object<T>
+ (which contains an instance of T). Reference fields in linked structures
+ should always be tx_ptrs. The result of derreferencing it will be the
+ pointer to the T instance When this pointer is derreference on a transaction
+ the transactional_object<T> is set a written and the transaction
+ specific storage will be used. Otherwise the shared storage is used.
+ 
+
+ Used to initialize a rd_ptr<T>, wr_ptr<T>, or upgrd_ptr<T>.
+ 
+<pre class="programlisting">template <typename T>
+class tx_ptr {
+public:
+ typedef tx_ptr<T> this_type;
+
+ tx_ptr();
+ template<class Y> explicit tx_ptr(Y * ptr);
+ explicit tx_ptr(transactional_object<T>* ptr);
+ tx_ptr(const tx_obj<T>& r);
+
+ template<class Y> tx_ptr(tx_ptr<Y> const& r);
+ template<class Y> tx_ptr(rd_ptr<Y> const & r);
+ template<class Y> tx_ptr(wr_ptr<Y> const & r);
+ template<class Y> tx_ptr(upgrd_ptr<Y> const & r);
+
+ template<class Y> tx_ptr& operator=(transactional_object<Y>* ptr);
+ template<class Y> tx_ptr & operator=(tx_ptr<Y> const & r);
+
+ T* operator->() const;
+ T& operator*() const;
+ T* get() const;
+
+ typedef transactional_object<T>* this_type::*unspecified_bool_type;
+
+ operator unspecified_bool_type() const;
+ void swap(tx_ptr & other);
+};
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__rd_ptr___"></a><a href="warppers.html#toward_boost_stm.reference.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__rd_ptr___" title="Template
+ Class rd_ptr<>">Template
+ Class <code class="computeroutput">rd_ptr<></code></a>
+</h6></div></div></div>
+
+ A rd_ptr<T> ("read pointer") points to an object that
+ the current transaction has opened for read only access. You can only
+ call a const method through a read pointer.
+ 
+
+ A rd_ptr<T> is constructed from an tx_ptr<T> through an
+ explicit constructor. Once a rd_ptr<T> has been constructed,
+ an tx_ptr<T> can be opened for reading simply by assignment (operator=())
+ into the constructed rd_ptr<T>.
+ 
+
+ It is not safe to derreference a rd_ptr<T> after having assigned
+ the same tx_ptr<T> to a wr_ptr<T>. If this is the case
+ the readen value do not match the writen one. If it is possible to
+ write on the same transaction use upgrd_ptr instead which is safe.
+ 
+<pre class="programlisting">template <typename T>
+class rd_ptr {
+public:
+ rd_ptr(transaction &t, tx_ptr<T> tx_obj);
+ rd_ptr(transaction &t, tx_obj<T> const& tx_obj);
+
+ template<class Y> rd_ptr & operator=(tx_ptr<Y> r);
+
+ template<class Y> rd_ptr& operator=(tx_obj<Y> const & r);
+
+ const T* get() const;
+
+ inline const T & operator*() const;
+ inline const T* operator->() const;
+
+ operator unspecified_bool_type() const;
+
+};
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__upgrd_ptr___"></a><a href="warppers.html#toward_boost_stm.reference.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__upgrd_ptr___" title="Template
+ Class upgrd_ptr<>">Template
+ Class <code class="computeroutput">upgrd_ptr<></code></a>
+</h6></div></div></div>
+
+ A upgrd_ptr<T> ("upgradable pointer") points to an
+ object that the current transaction has opened for read only access.
+ 
+
+ You can only call const method of the wrapped type through a upgradable
+ pointer.
+ 
+
+ A upgrd_ptr<T> is constructed from an tx_ptr<T> through
+ a constructor having also the transaction as parameter. Once a rd_ptr<T>
+ has been constructed, an tx_ptr<T> can be opened for reading
+ simply by assignment (operator=()) into the constructed rd_ptr<T>.
+ 
+
+ It is safe to derreference a rd_ptr<T> after having assigned
+ the same tx_ptr<T> to a wr_ptr<T>.
+ 
+
+ A upgrd_ptr<T> can be upgraded to a wr_ptr<T> through a
+ constructor.
+ 
+<pre class="programlisting">template <typename T>
+class upgrd_ptr {
+public:
+
+ inline upgrd_ptr(transaction &t, tx_ptr<T> tx_obj);
+ template<class Y>
+ upgrd_ptr & operator=(tx_ptr<Y> const& r);
+
+ const T* get() const;
+
+ inline T const & operator*() const;
+ inline T const * operator->() const;
+
+ operator unspecified_bool_type() const;
+
+ void write_ptr(transactional_object<T>* ptr);
+ T* write_ptr();
+
+};
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__wr_ptr___"></a><a href="warppers.html#toward_boost_stm.reference.warppers.smart_pointers.tx_smart_ptr_hpp.template_class__wr_ptr___" title="Template
+ Class wr_ptr<>">Template
+ Class <code class="computeroutput">wr_ptr<></code></a>
+</h6></div></div></div>
+
+ A wr_ptr<T> ("write pointer") points to a shared object
+ that the current transaction has opened for writing.
+ 
+
+ A wr_ptr<T> is initialized explicitly from an tx_ptr<T>.
+ 
+
+ A wr_ptr<T> can also be explicitly constructed from a upgrd_ptr<T>
+ as an upgrade-to-writable operation.
+ 
+<pre class="programlisting">template <typename T>
+class wr_ptr {
+public:
+ wr_ptr(transaction &t, tx_ptr<T> tx_obj);
+
+ wr_ptr(transaction &t, upgrd_ptr<T> tx_obj);
+
+ T* get();
+
+ inline T& operator*();
+ inline T* operator->();
+
+ operator unspecified_bool_type() const;
+};
+</pre>
+</div>
+</div>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 Justin E. Gottchlich Copyright © 2009 Vicente J. Botet Escriba
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="mixins.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="non_transactional_objects.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/stm/branches/vbe/libs/stm/doc/html/toward_boost_stm/reference/warppers_transactional_objects.html
==============================================================================
--- (empty file)
+++ sandbox/stm/branches/vbe/libs/stm/doc/html/toward_boost_stm/reference/warppers_transactional_objects.html 2009-11-11 11:03:52 EST (Wed, 11 Nov 2009)
@@ -0,0 +1,492 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Warppers
+ Transactional Objects</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../../index.html" title="Chapter 1. Toward.Boost.STM">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="mixins_transactional_objects.html" title="Mixins
+ Transactional Objects">
+<link rel="next" href="non_transactional_objects.html" title="Non
+ Transactional Objects">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="TowardBoostSTM" width="277" height="86" src="../../../image/Toward_Boost_STM.jpg"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="mixins_transactional_objects.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="non_transactional_objects.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_stm.reference.warppers_transactional_objects"></a><a href="warppers_transactional_objects.html" title="Warppers
+ Transactional Objects">Warppers
+ Transactional Objects</a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="warppers_transactional_objects.html#toward_boost_stm.reference.warppers_transactional_objects.transactional_object_hpp">
+ Header <code class="computeroutput"><boost/stm/transactional_object.hpp></code></a></dt>
+<dd><dl><dt><a href="warppers_transactional_objects.html#toward_boost_stm.reference.warppers_transactional_objects.transactional_object_hpp.template_class__transactional_object___">Template
+ Class <code class="computeroutput">transactional_object<></code></a></dt></dl></dd>
+<dt><a href="warppers_transactional_objects.html#toward_boost_stm.reference.warppers_transactional_objects.smart_pointers">Smart
+ pointers</a></dt>
+<dd><dl><dt><a href="warppers_transactional_objects.html#toward_boost_stm.reference.warppers_transactional_objects.smart_pointers.tx_smart_ptr_hpp">
+ Header <code class="computeroutput"><boost/stm/tx/smart_ptr.hpp></code></a></dt></dl></dd>
+</dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_stm.reference.warppers_transactional_objects.transactional_object_hpp"></a><a href="warppers_transactional_objects.html#toward_boost_stm.reference.warppers_transactional_objects.transactional_object_hpp" title="
+ Header <boost/stm/transactional_object.hpp>">
+ Header <code class="computeroutput"><boost/stm/transactional_object.hpp></code></a>
+</h4></div></div></div>
+<div class="toc"><dl><dt><a href="warppers_transactional_objects.html#toward_boost_stm.reference.warppers_transactional_objects.transactional_object_hpp.template_class__transactional_object___">Template
+ Class <code class="computeroutput">transactional_object<></code></a></dt></dl></div>
+<pre class="programlisting">namespace boost { namespace stm {
+ template <class T> class transactional_object;
+
+ template <typename T>
+ static transactional_object<T>* tx_up_cast(T* ptr);
+
+ template <typename T, typename U>
+ static transactional_object<T>* tx_static_cast(transactional_object<U>* ptr);
+
+ template <typename T, typename U>
+ static transactional_object<T>* tx_dynamic_cast(transactional_object<U>* ptr);
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.warppers_transactional_objects.transactional_object_hpp.template_class__transactional_object___"></a><a href="warppers_transactional_objects.html#toward_boost_stm.reference.warppers_transactional_objects.transactional_object_hpp.template_class__transactional_object___" title="Template
+ Class transactional_object<>">Template
+ Class <code class="computeroutput">transactional_object<></code></a>
+</h5></div></div></div>
+<div class="toc"><dl>
+<dt><a href="warppers_transactional_objects.html#toward_boost_stm.reference.warppers_transactional_objects.transactional_object_hpp.template_class__transactional_object___.virtual_function__copy_state___">Virtual
+ function <code class="computeroutput">copy_state()</code></a></dt>
+<dt><a href="warppers_transactional_objects.html#toward_boost_stm.reference.warppers_transactional_objects.transactional_object_hpp.template_class__transactional_object___.virtual_function__move_state___">Virtual
+ function <code class="computeroutput">move_state()</code></a></dt>
+<dt><a href="warppers_transactional_objects.html#toward_boost_stm.reference.warppers_transactional_objects.transactional_object_hpp.template_class__transactional_object___.virtual_function__cache_deallocate___">Virtual
+ function <code class="computeroutput">cache_deallocate()</code></a></dt>
+</dl></div>
+
+ Transactional object wrapper. A <code class="computeroutput">transactional_object<T></code> is a base_transaction_object wrapping
+ an instance of type T. Provides the definition of the virtual functions
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ forward constructors to the wrapped type
+ </li>
+<li>
+<code class="computeroutput">copy_state</code>: relaying
+ on the cache_copy<T> generic function
+ </li>
+<li>
+<code class="computeroutput">move_state</code> and
+ </li>
+<li>
+<code class="computeroutput">cache_deallocate</code>: relaying
+ on the cache_copy<T> generic function
+ </li>
+</ul></div>
+
+ Defines in addition the functions <code class="computeroutput">new</code>
+ and <code class="computeroutput">delete</code> when <code class="computeroutput">BOOST_STM_USE_MEMORY_MANAGER</code> is defined
+ 
+
+ If a class D inherits from B we have that <code class="computeroutput">transactional_object<D></code> dont inherits from <code class="computeroutput">transactional_object<B></code>,
+ but we can static/dynamic cast them robustly.
+ 
+
+ Evidently the <code class="computeroutput">std::static_cast</code>/<code class="computeroutput">std::dynamic_cast</code>
+ do not works. We need to define the specific cast
+ 
+<pre class="programlisting">transactional_object<D>* d=...;
+transactional_object<B>* b=tx_static_cast<B>(d);
+
+transactional_object<B>* b=...;
+transactional_object<D>* d=tx_dynamic_cast<B>(b);
+</pre>
+
+ Synopsis
+ 
+<pre class="programlisting">template <typename T>
+class transactional_object : public base_transaction_object {
+public:
+ T value;
+
+ transactional_object();
+ transactional_object(const T*ptr);
+ transactional_object(transactional_object<T> const & r);
+ template <typename T1>
+ transactional_object(T1 const &p1);
+
+ template <typename T1, typename T2>
+ transactional_object(T1 const &p1, T2 const &p2);
+
+ transactional_object & operator=(transactional_object const & r);
+
+ virtual void copy_state(base_transaction_object const * const rhs);
+
+#ifdef BOOST_STM_USE_UNASIGNED_COPY
+ virtual void cache_deallocate();
+#endif
+
+#if BOST_STM_USE_MEMORY_MANAGER
+ void* operator new(size_t size) throw ();
+ void operator delete(void* mem);
+#endif
+
+};
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.warppers_transactional_objects.transactional_object_hpp.template_class__transactional_object___.virtual_function__copy_state___"></a><a href="warppers_transactional_objects.html#toward_boost_stm.reference.warppers_transactional_objects.transactional_object_hpp.template_class__transactional_object___.virtual_function__copy_state___" title="Virtual
+ function copy_state()">Virtual
+ function <code class="computeroutput">copy_state()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void copy_state(base_transaction_object const * const rhs);
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.warppers_transactional_objects.transactional_object_hpp.template_class__transactional_object___.virtual_function__move_state___"></a><a href="warppers_transactional_objects.html#toward_boost_stm.reference.warppers_transactional_objects.transactional_object_hpp.template_class__transactional_object___.virtual_function__move_state___" title="Virtual
+ function move_state()">Virtual
+ function <code class="computeroutput">move_state()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void move_state(base_transaction_object * rhs);
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.warppers_transactional_objects.transactional_object_hpp.template_class__transactional_object___.virtual_function__cache_deallocate___"></a><a href="warppers_transactional_objects.html#toward_boost_stm.reference.warppers_transactional_objects.transactional_object_hpp.template_class__transactional_object___.virtual_function__cache_deallocate___" title="Virtual
+ function cache_deallocate()">Virtual
+ function <code class="computeroutput">cache_deallocate()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">virtual void cache_deallocate()=0;
+</pre>
+</div>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_stm.reference.warppers_transactional_objects.smart_pointers"></a><a href="warppers_transactional_objects.html#toward_boost_stm.reference.warppers_transactional_objects.smart_pointers" title="Smart
+ pointers">Smart
+ pointers</a>
+</h4></div></div></div>
+<div class="toc"><dl><dt><a href="warppers_transactional_objects.html#toward_boost_stm.reference.warppers_transactional_objects.smart_pointers.tx_smart_ptr_hpp">
+ Header <code class="computeroutput"><boost/stm/tx/smart_ptr.hpp></code></a></dt></dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_stm.reference.warppers_transactional_objects.smart_pointers.tx_smart_ptr_hpp"></a><a href="warppers_transactional_objects.html#toward_boost_stm.reference.warppers_transactional_objects.smart_pointers.tx_smart_ptr_hpp" title="
+ Header <boost/stm/tx/smart_ptr.hpp>">
+ Header <code class="computeroutput"><boost/stm/tx/smart_ptr.hpp></code></a>
+</h5></div></div></div>
+<div class="toc"><dl>
+<dt><a href="warppers_transactional_objects.html#toward_boost_stm.reference.warppers_transactional_objects.smart_pointers.tx_smart_ptr_hpp.template_class__tx_obj___">Template
+ Class <code class="computeroutput">tx_obj<></code></a></dt>
+<dt><a href="warppers_transactional_objects.html#toward_boost_stm.reference.warppers_transactional_objects.smart_pointers.tx_smart_ptr_hpp.template_class__tx_ptr___">Template
+ Class <code class="computeroutput">tx_ptr<></code></a></dt>
+<dt><a href="warppers_transactional_objects.html#toward_boost_stm.reference.warppers_transactional_objects.smart_pointers.tx_smart_ptr_hpp.template_class__rd_ptr___">Template
+ Class <code class="computeroutput">rd_ptr<></code></a></dt>
+<dt><a href="warppers_transactional_objects.html#toward_boost_stm.reference.warppers_transactional_objects.smart_pointers.tx_smart_ptr_hpp.template_class__upgrd_ptr___">Template
+ Class <code class="computeroutput">upgrd_ptr<></code></a></dt>
+<dt><a href="warppers_transactional_objects.html#toward_boost_stm.reference.warppers_transactional_objects.smart_pointers.tx_smart_ptr_hpp.template_class__wr_ptr___">Template
+ Class <code class="computeroutput">wr_ptr<></code></a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost { namespace stm {
+
+ template <typename T> class tx_obj;
+ template <typename T, typename U>
+ bool operator==(const tx_obj<T>& lhs, const tx_obj<U>& rhs);
+ template <typename T, typename U>
+ bool operator==(const T& lhs, const tx_obj<U>& rhs);
+ template <typename T, typename U>
+ bool operator==(const tx_obj<T>& lhs, const U& rhs);
+ template <typename T, typename U>
+ bool operator!=(const tx_obj<T>& lhs, const tx_obj<U>& rhs);
+ template <typename T, typename U>
+ bool operator!=(const tx_obj<T>& lhs, const tx_obj<U>& rhs);
+ template<class T> inline void swap(tx_obj<T> & a, tx_obj<T> & b);
+
+ template <typename T> class tx_ptr;
+ template <typename T, typename U>
+ bool operator==(const tx_ptr<T>& lhs, const tx_ptr<U>& rhs);
+ template <typename T, typename U>
+ bool operator!=(const tx_ptr<T>& lhs, const tx_ptr<U>& rhs);
+ template<class T> inline void swap(tx_ptr<T> & a, tx_ptr<T> & b);
+
+ template <typename T>
+ void delete_ptr(tx_ptr<T> ptr);
+ template <typename T>
+ void delete_ptr(transaction& tx, tx_ptr<T> ptr);
+
+ template <typename T, typename U>
+ static tx_ptr<T> tx_static_cast(tx_ptr<U> ptr);
+ template <typename T, typename U>
+ static tx_ptr<T>* tx_dynamic_cast(tx_ptr<U> ptr);
+
+ template <typename T> class rd_ptr;
+ template <typename T>
+ rd_ptr<T> make_rd_ptr(transaction& tx, tx_ptr<T> ptr);
+ template <typename T>
+ rd_ptr<T> make_rd_ptr(transaction& tx, tx_obj<T> const & ref);
+
+ template <typename T>
+ rd_ptr<T> make_rd_ptr(tx_ptr<T> ptr);
+ template <typename T>
+ rd_ptr<T> make_rd_ptr(tx_obj<T> const & ref);
+ template <typename T>
+ void delete_ptr(rd_ptr<T> ptr);
+ template <typename T>
+ void delete_ptr(transaction& tx, rd_ptr<T> ptr);
+
+ template <typename T> class upgrd_ptr;
+ template <typename T>
+ void delete_ptr(upgrd_ptr<T> const& ptr);
+ template <typename T>
+ void delete_ptr(transaction& tx, upgrd_ptr<T> const& ptr);
+
+ template <typename T> class wr_ptr;
+ template <typename T>
+ wr_ptr<T> make_wr_ptr(transaction& tx, tx_ptr<T>& ptr);
+ template <typename T>
+ wr_ptr<T> make_wr_ptr(tx_ptr<T>& ptr);
+ template <typename T>
+ void delete_ptr(wr_ptr<T> ptr);
+ template <typename T>
+ void delete_ptr(transaction& tx, wr_ptr<T> const& ptr);
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.warppers_transactional_objects.smart_pointers.tx_smart_ptr_hpp.template_class__tx_obj___"></a><a href="warppers_transactional_objects.html#toward_boost_stm.reference.warppers_transactional_objects.smart_pointers.tx_smart_ptr_hpp.template_class__tx_obj___" title="Template
+ Class tx_obj<>">Template
+ Class <code class="computeroutput">tx_obj<></code></a>
+</h6></div></div></div>
+
+ tx_obj is a kind of smart pointer to a wrapped transactional_object
+ T providing builting operators
+ 
+<pre class="programlisting">template <typename T> class tx_obj {
+public:
+ tx_obj();
+ template<ctypename Y> tx_obj(tx_obj<Y> const& r);
+
+ template <typename T1> tx_obj(T1 p1);
+
+ T* operator->();
+ const T* operator->() const;
+ T& operator*();
+ const T& operator*() const;
+ T* get();
+ const T* get() const;
+ T& ref();
+ const T& ref() const;
+
+ tx_obj& operator--();
+ T operator--(int);
+
+ tx_obj& operator++();
+ T operator++(int);
+
+ tx_obj& operator+=(T const &rhs);
+ T operator+(T const &rhs) const;
+};
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.warppers_transactional_objects.smart_pointers.tx_smart_ptr_hpp.template_class__tx_ptr___"></a><a href="warppers_transactional_objects.html#toward_boost_stm.reference.warppers_transactional_objects.smart_pointers.tx_smart_ptr_hpp.template_class__tx_ptr___" title="Template
+ Class tx_ptr<>">Template
+ Class <code class="computeroutput">tx_ptr<></code></a>
+</h6></div></div></div>
+
+ a tx_ptr<T> is an smart pointer to a transactional_object<T>
+ (which contains an instance of T). Reference fields in linked structures
+ should always be tx_ptrs. The result of derreferencing it will be the
+ pointer to the T instance When this pointer is derreference on a transaction
+ the transactional_object<T> is set a written and the transaction
+ specific storage will be used. Otherwise the shared storage is used.
+ 
+
+ Used to initialize a rd_ptr<T>, wr_ptr<T>, or upgrd_ptr<T>.
+ 
+<pre class="programlisting">template <typename T>
+class tx_ptr {
+public:
+ typedef tx_ptr<T> this_type;
+
+ tx_ptr();
+ template<class Y> explicit tx_ptr(Y * ptr);
+ explicit tx_ptr(transactional_object<T>* ptr);
+ tx_ptr(const tx_obj<T>& r);
+
+ template<class Y> tx_ptr(tx_ptr<Y> const& r);
+ template<class Y> tx_ptr(rd_ptr<Y> const & r);
+ template<class Y> tx_ptr(wr_ptr<Y> const & r);
+ template<class Y> tx_ptr(upgrd_ptr<Y> const & r);
+
+ template<class Y> tx_ptr& operator=(transactional_object<Y>* ptr);
+ template<class Y> tx_ptr & operator=(tx_ptr<Y> const & r);
+
+ T* operator->() const;
+ T& operator*() const;
+ T* get() const;
+
+ typedef transactional_object<T>* this_type::*unspecified_bool_type;
+
+ operator unspecified_bool_type() const;
+ void swap(tx_ptr & other);
+};
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.warppers_transactional_objects.smart_pointers.tx_smart_ptr_hpp.template_class__rd_ptr___"></a><a href="warppers_transactional_objects.html#toward_boost_stm.reference.warppers_transactional_objects.smart_pointers.tx_smart_ptr_hpp.template_class__rd_ptr___" title="Template
+ Class rd_ptr<>">Template
+ Class <code class="computeroutput">rd_ptr<></code></a>
+</h6></div></div></div>
+
+ A rd_ptr<T> ("read pointer") points to an object that
+ the current transaction has opened for read only access. You can only
+ call a const method through a read pointer.
+ 
+
+ A rd_ptr<T> is constructed from an tx_ptr<T> through an
+ explicit constructor. Once a rd_ptr<T> has been constructed,
+ an tx_ptr<T> can be opened for reading simply by assignment (operator=())
+ into the constructed rd_ptr<T>.
+ 
+
+ It is not safe to derreference a rd_ptr<T> after having assigned
+ the same tx_ptr<T> to a wr_ptr<T>. If this is the case
+ the readen value do not match the writen one. If it is possible to
+ write on the same transaction use upgrd_ptr instead which is safe.
+ 
+<pre class="programlisting">template <typename T>
+class rd_ptr {
+public:
+ rd_ptr(transaction &t, tx_ptr<T> tx_obj);
+ rd_ptr(transaction &t, tx_obj<T> const& tx_obj);
+
+ template<class Y> rd_ptr & operator=(tx_ptr<Y> r);
+
+ template<class Y> rd_ptr& operator=(tx_obj<Y> const & r);
+
+ const T* get() const;
+
+ inline const T & operator*() const;
+ inline const T* operator->() const;
+
+ operator unspecified_bool_type() const;
+
+};
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.warppers_transactional_objects.smart_pointers.tx_smart_ptr_hpp.template_class__upgrd_ptr___"></a><a href="warppers_transactional_objects.html#toward_boost_stm.reference.warppers_transactional_objects.smart_pointers.tx_smart_ptr_hpp.template_class__upgrd_ptr___" title="Template
+ Class upgrd_ptr<>">Template
+ Class <code class="computeroutput">upgrd_ptr<></code></a>
+</h6></div></div></div>
+
+ A upgrd_ptr<T> ("upgradable pointer") points to an
+ object that the current transaction has opened for read only access.
+ 
+
+ You can only call const method of the wrapped type through a upgradable
+ pointer.
+ 
+
+ A upgrd_ptr<T> is constructed from an tx_ptr<T> through
+ a constructor having also the transaction as parameter. Once a rd_ptr<T>
+ has been constructed, an tx_ptr<T> can be opened for reading
+ simply by assignment (operator=()) into the constructed rd_ptr<T>.
+ 
+
+ It is safe to derreference a rd_ptr<T> after having assigned
+ the same tx_ptr<T> to a wr_ptr<T>.
+ 
+
+ A upgrd_ptr<T> can be upgraded to a wr_ptr<T> through a
+ constructor.
+ 
+<pre class="programlisting">template <typename T>
+class upgrd_ptr {
+public:
+
+ inline upgrd_ptr(transaction &t, tx_ptr<T> tx_obj);
+ template<class Y>
+ upgrd_ptr & operator=(tx_ptr<Y> const& r);
+
+ const T* get() const;
+
+ inline T const & operator*() const;
+ inline T const * operator->() const;
+
+ operator unspecified_bool_type() const;
+
+ void write_ptr(transactional_object<T>* ptr);
+ T* write_ptr();
+
+};
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="toward_boost_stm.reference.warppers_transactional_objects.smart_pointers.tx_smart_ptr_hpp.template_class__wr_ptr___"></a><a href="warppers_transactional_objects.html#toward_boost_stm.reference.warppers_transactional_objects.smart_pointers.tx_smart_ptr_hpp.template_class__wr_ptr___" title="Template
+ Class wr_ptr<>">Template
+ Class <code class="computeroutput">wr_ptr<></code></a>
+</h6></div></div></div>
+
+ A wr_ptr<T> ("write pointer") points to a shared object
+ that the current transaction has opened for writing.
+ 
+
+ A wr_ptr<T> is initialized explicitly from an tx_ptr<T>.
+ 
+
+ A wr_ptr<T> can also be explicitly constructed from a upgrd_ptr<T>
+ as an upgrade-to-writable operation.
+ 
+<pre class="programlisting">template <typename T>
+class wr_ptr {
+public:
+ wr_ptr(transaction &t, tx_ptr<T> tx_obj);
+
+ wr_ptr(transaction &t, upgrd_ptr<T> tx_obj);
+
+ T* get();
+
+ inline T& operator*();
+ inline T* operator->();
+
+ operator unspecified_bool_type() const;
+};
+</pre>
+</div>
+</div>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 Justin E. Gottchlich Copyright © 2009 Vicente J. Botet Escriba
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="mixins_transactional_objects.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="non_transactional_objects.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Date view	Thread view	Subject view	Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk