ceph/src/boost/libs/pool/doc/html/boost_pool/pool/usage.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>How do I use Pool?</title>
   5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="../../index.html" title="Boost.Pool">
   8 <link rel="up" href="../pool.html" title="Introduction and Overview">
   9 <link rel="prev" href="introduction.html" title="Introduction">
  10 <link rel="next" href="installation.html" title="Installation">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="introduction.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../pool.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="installation.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h3 class="title">
  27 <a name="boost_pool.pool.usage"></a><a class="link" href="usage.html" title="How do I use Pool?">How do I use Pool?</a>
  28 </h3></div></div></div>
  29 <p>
  30         See the <a class="link" href="interfaces.html" title="Boost Pool Interfaces - What interfaces are provided and when to use each one.">Pool Interfaces</a>
  31         section that covers the different Pool interfaces supplied by this library.
  32       </p>
  33 <h6>
  34 <a name="boost_pool.pool.usage.h0"></a>
  35         <span><a name="boost_pool.pool.usage.library_structure_and_dependencies"></a></span><a class="link" href="usage.html#boost_pool.pool.usage.library_structure_and_dependencies">Library
  36         Structure and Dependencies</a>
  37       </h6>
  38 <p>
  39         Forward declarations of all the exposed symbols for this library are in the
  40         header made inscope by <code class="computeroutput"><span class="preprocessor">#include</span>
  41         <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">pool</span><span class="special">/</span><span class="identifier">poolfwd</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>.
  42       </p>
  43 <p>
  44         The library may use macros, which will be prefixed with <code class="computeroutput"><span class="identifier">BOOST_POOL_</span></code>.
  45         The exception to this rule are the include file guards, which (for file
  46         <code class="computeroutput"><span class="identifier">xxx</span><span class="special">.</span><span class="identifier">hpp</span></code>) is <code class="computeroutput"><span class="identifier">BOOST_xxx_HPP</span></code>.
  47       </p>
  48 <p>
  49         All exposed symbols defined by the library will be in namespace boost::.
  50         All symbols used only by the implementation will be in namespace boost::details::pool.
  51       </p>
  52 <p>
  53         Every header used only by the implementation is in the subdirectory <code class="computeroutput"><span class="special">/</span><span class="identifier">detail</span><span class="special">/</span></code>.
  54       </p>
  55 <p>
  56         Any header in the library may include any other header in the library or
  57         any system-supplied header at its discretion.
  58       </p>
  59 </div>
  60 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  61 <td align="left"></td>
  62 <td align="right"><div class="copyright-footer">Copyright &#169; 2000-2006 Stephen Cleary<br>Copyright &#169; 2011 Paul A. Bristow<p>
  63         Distributed under the Boost Software License, Version 1.0. (See accompanying
  64         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  65       </p>
  66 </div></td>
  67 </tr></table>
  68 <hr>
  69 <div class="spirit-nav">
  70 <a accesskey="p" href="introduction.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../pool.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="installation.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  71 </div>
  72 </body>
  73 </html>