projects / ceph.git / blame
| Commit | Line | Data |
|---|---|---|
| 7c673cae FG |
1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0.1 Transitional//EN"> |
| 2 | ||
| 3 | <html> | |
| 4 | <head> | |
| 5 | <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> | |
| 6 | <title>Boost.Flyweight Documentation - Reference</title> | |
| 7 | <link rel="stylesheet" href="../style.css" type="text/css"> | |
| 8 | <link rel="start" href="../index.html"> | |
| 9 | <link rel="prev" href="../tutorial/lambda_expressions.html"> | |
| 10 | <link rel="up" href="../index.html"> | |
| 11 | <link rel="next" href="flyweight.html"> | |
| 12 | </head> | |
| 13 | ||
| 14 | <body> | |
| 15 | <h1><img src="../../../../boost.png" alt="Boost logo" align= | |
| 16 | "middle" width="277" height="86">Boost.Flyweight Reference</h1> | |
| 17 | ||
| 18 | <div class="prev_link"><a href="../tutorial/lambda_expressions.html"><img src="../prev.gif" alt="annex: MPL lambda expressions" border="0"><br> | |
| 19 | Annex: MPL lambda expressions | |
| 20 | </a></div> | |
| 21 | <div class="up_link"><a href="../index.html"><img src="../up.gif" alt="index" border="0"><br> | |
| 22 | Index | |
| 23 | </a></div> | |
| 24 | <div class="next_link"><a href="flyweight.html"><img src="../next.gif" alt="flyweight reference" border="0"><br> | |
| 25 | <code>flyweight</code> reference | |
| 26 | </a></div><br clear="all" style="clear: all;"> | |
| 27 | ||
| 28 | <hr> | |
| 29 | ||
| 30 | <h2>Contents</h2> | |
| 31 | ||
| 32 | <ul> | |
| 33 | <li><a href="#headers">Header summary</a></li> | |
| 34 | <li><a href="#dependencies">Dependencies</a></li> | |
| 35 | <li><a href="#flyweight_synopsis">Header | |
| 36 | <code>"boost/flyweight.hpp"</code> synopsis</a></li> | |
| 37 | <li><a href="flyweight.html">Class template <code>flyweight</code></a></li> | |
| 38 | <li><a href="key_value.html">Key-value flyweights</a></li> | |
| 39 | <li><a href="tags.html">Tags</a></li> | |
| 40 | <li><a href="factories.html">Factories</a></li> | |
| 41 | <li><a href="holders.html">Holders</a></li> | |
| 42 | <li><a href="locking.html">Locking policies</a></li> | |
| 43 | <li><a href="tracking.html">Tracking policies</a></li> | |
| 44 | </ul> | |
| 45 | ||
| 46 | <h2><a name="headers">Header summary</a></h2> | |
| 47 | ||
| 48 | <p> | |
| 49 | Boost.Flyweight comprises the following public headers: | |
| 50 | <ul> | |
| 51 | <li><a href="#flyweight_synopsis"><code>"boost/flyweight.hpp"</code></a></li> | |
| 52 | <li>Class template <code>flyweight</code> | |
| 53 | <ul> | |
| 54 | <li><a href="flyweight.html#flyweight_fwd_synopsis"><code>"boost/flyweight/flyweight_fwd.hpp"</code></a></li> | |
| 55 | <li><a href="flyweight.html#synopsis"><code>"boost/flyweight/flyweight.hpp"</code></a></li> | |
| 56 | <li><a href="flyweight.html#serialize_synopsis"><code>"boost/flyweight/flyweight_serialize.hpp"</code></a></li> | |
| 57 | </ul> | |
| 58 | </li> | |
| 59 | <li>Key-value flyweights | |
| 60 | <ul> | |
| 61 | <li><a href="key_value.html#key_value_fwd_synopsis"><code>"boost/flyweight/key_value_fwd.hpp"</code></a></li> | |
| 62 | <li><a href="key_value.html#synopsis"><code>"boost/flyweight/key_value.hpp"</code></a></li> | |
| 63 | </ul> | |
| 64 | </li> | |
| 65 | <li>Tags | |
| 66 | <ul> | |
| 67 | <li><a href="tags.html#tag_synopsis"><code>"boost/flyweight/tag.hpp"</code></a></li> | |
| 68 | </ul> | |
| 69 | </li> | |
| 70 | <li>Factories | |
| 71 | <ul> | |
| 72 | <li><a href="factories.html#factory_tag_synopsis"><code>"boost/flyweight/factory_tag.hpp"</code></a></li> | |
| 73 | <li><a href="factories.html#hashed_factory_fwd_synopsis"><code>"boost/flyweight/hashed_factory_fwd.hpp"</code></a></li> | |
| 74 | <li><a href="factories.html#hashed_factory_synopsis"><code>"boost/flyweight/hashed_factory.hpp"</code></a></li> | |
| 75 | <li><a href="factories.html#set_factory_fwd_synopsis"><code>"boost/flyweight/set_factory_fwd.hpp"</code></a></li> | |
| 76 | <li><a href="factories.html#set_factory_synopsis"><code>"boost/flyweight/set_factory.hpp"</code></a></li> | |
| 77 | <li><a href="factories.html#assoc_container_factory_fwd_synopsis"><code>"boost/flyweight/assoc_container_factory_fwd.hpp"</code></a></li> | |
| 78 | <li><a href="factories.html#assoc_container_factory_synopsis"><code>"boost/flyweight/assoc_container_factory.hpp"</code></a></li> | |
| 79 | </ul> | |
| 80 | </li> | |
| 81 | <li>Holders | |
| 82 | <ul> | |
| 83 | <li><a href="holders.html#holder_tag_synopsis"><code>"boost/flyweight/holder_tag.hpp"</code></a></li> | |
| 84 | <li><a href="holders.html#static_holder_fwd_synopsis"><code>"boost/flyweight/static_holder_fwd.hpp"</code></a></li> | |
| 85 | <li><a href="holders.html#static_holder_synopsis"><code>"boost/flyweight/static_holder.hpp"</code></a></li> | |
| 86 | <li><a href="holders.html#intermodule_holder_fwd_synopsis"><code>"boost/flyweight/intermodule_holder_fwd.hpp"</code></a></li> | |
| 87 | <li><a href="holders.html#intermodule_holder_synopsis"><code>"boost/flyweight/intermodule_holder.hpp"</code></a></li> | |
| 88 | </ul> | |
| 89 | </li> | |
| 90 | <li>Locking policies | |
| 91 | <ul> | |
| 92 | <li><a href="locking.html#locking_tag_synopsis"><code>"boost/flyweight/locking_tag.hpp"</code></a></li> | |
| 93 | <li><a href="locking.html#simple_locking_fwd_synopsis"><code>"boost/flyweight/simple_locking_fwd.hpp"</code></a></li> | |
| 94 | <li><a href="locking.html#simple_locking_synopsis"><code>"boost/flyweight/simple_locking.hpp"</code></a></li> | |
| 95 | <li><a href="locking.html#no_locking_fwd_synopsis"><code>"boost/flyweight/no_locking_fwd.hpp"</code></a></li> | |
| 96 | <li><a href="locking.html#no_locking_synopsis"><code>"boost/flyweight/no_locking.hpp"</code></a></li> | |
| 97 | </ul> | |
| 98 | </li> | |
| 99 | <li>Tracking policies | |
| 100 | <ul> | |
| 101 | <li><a href="tracking.html#tracking_tag_synopsis"><code>"boost/flyweight/tracking_tag.hpp"</code></a></li> | |
| 102 | <li><a href="tracking.html#refcounted_fwd_synopsis"><code>"boost/flyweight/refcounted_fwd.hpp"</code></a></li> | |
| 103 | <li><a href="tracking.html#refcounted_synopsis"><code>"boost/flyweight/refcounted.hpp"</code></a></li> | |
| 104 | <li><a href="tracking.html#no_tracking_fwd_synopsis"><code>"boost/flyweight/no_tracking_fwd.hpp"</code></a></li> | |
| 105 | <li><a href="tracking.html#no_tracking_synopsis"><code>"boost/flyweight/no_tracking.hpp"</code></a></li> | |
| 106 | </ul> | |
| 107 | </li> | |
| 108 | </ul> | |
| 109 | </p> | |
| 110 | ||
| 111 | <h2><a name="dependencies">Dependencies</a></h2> | |
| 112 | ||
| 113 | <p> | |
| 114 | In order to use the serialization capabilities of Boost.Flyweight, | |
| 115 | the appropriate Boost.Serialization library module must be linked. Other | |
| 116 | than that, Boost.Flyweight is a header-only library, requiring no additional | |
| 117 | object modules. The default <a href="locking.html#simple_locking"><code>simple_locking</code></a> | |
| 118 | locking policy introduces a dependency on the Pthreads library on those POSIX-compliant | |
| 119 | environments where the <a href="../../../config/doc/html/index.html">Boost.Config</a> macro | |
| 120 | <code>BOOST_HAS_PTHREADS</code> is set. | |
| 121 | </p> | |
| 122 | ||
| 123 | <h2> | |
| 124 | <a name="flyweight_synopsis">Header | |
| 125 | <a href="../../../../boost/flyweight.hpp"><code>"boost/flyweight.hpp"</code></a> | |
| 126 | synopsis</a> | |
| 127 | </h2> | |
| 128 | ||
| 129 | <blockquote><pre> | |
| 130 | <span class=preprocessor>#include</span> <span class=special><</span><span class=identifier>boost</span><span class=special>/</span><span class=identifier>flyweight</span><span class=special>/</span><span class=identifier>flyweight</span><span class=special>.</span><span class=identifier>hpp</span><span class=special>></span> | |
| 131 | <span class=preprocessor>#include</span> <span class=special><</span><span class=identifier>boost</span><span class=special>/</span><span class=identifier>flyweight</span><span class=special>/</span><span class=identifier>hashed_factory</span><span class=special>.</span><span class=identifier>hpp</span><span class=special>></span> | |
| 132 | <span class=preprocessor>#include</span> <span class=special><</span><span class=identifier>boost</span><span class=special>/</span><span class=identifier>flyweight</span><span class=special>/</span><span class=identifier>refcounted</span><span class=special>.</span><span class=identifier>hpp</span><span class=special>></span> | |
| 133 | <span class=preprocessor>#include</span> <span class=special><</span><span class=identifier>boost</span><span class=special>/</span><span class=identifier>flyweight</span><span class=special>/</span><span class=identifier>simple_locking</span><span class=special>.</span><span class=identifier>hpp</span><span class=special>></span> | |
| 134 | <span class=preprocessor>#include</span> <span class=special><</span><span class=identifier>boost</span><span class=special>/</span><span class=identifier>flyweight</span><span class=special>/</span><span class=identifier>static_holder</span><span class=special>.</span><span class=identifier>hpp</span><span class=special>></span> | |
| 135 | </pre></blockquote> | |
| 136 | ||
| 137 | <p> | |
| 138 | This convenience header includes the main class template | |
| 139 | <a href="flyweight.html#flyweight"><code>flyweight</code></a> along with | |
| 140 | the default components used by <code>flyweight</code>. | |
| 141 | </p> | |
| 142 | ||
| 143 | <hr> | |
| 144 | ||
| 145 | <div class="prev_link"><a href="../tutorial/lambda_expressions.html"><img src="../prev.gif" alt="annex: MPL lambda expressions" border="0"><br> | |
| 146 | Annex: MPL lambda expressions | |
| 147 | </a></div> | |
| 148 | <div class="up_link"><a href="../index.html"><img src="../up.gif" alt="index" border="0"><br> | |
| 149 | Index | |
| 150 | </a></div> | |
| 151 | <div class="next_link"><a href="flyweight.html"><img src="../next.gif" alt="flyweight reference" border="0"><br> | |
| 152 | <code>flyweight</code> reference | |
| 153 | </a></div><br clear="all" style="clear: all;"> | |
| 154 | ||
| 155 | <br> | |
| 156 | ||
| 157 | <p>Revised September 1st 2014</p> | |
| 158 | ||
| 159 | <p>© Copyright 2006-2014 Joaquín M López Muñoz. | |
| 160 | Distributed under the Boost Software | |
| 161 | License, Version 1.0. (See accompanying file <a href="../../../../LICENSE_1_0.txt"> | |
| 162 | LICENSE_1_0.txt</a> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt"> | |
| 163 | http://www.boost.org/LICENSE_1_0.txt</a>) | |
| 164 | </p> | |
| 165 | ||
| 166 | </body> | |
| 167 | </html> |