libs/log/doc/html/boost/log/type_dispatcher.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class type_dispatcher</title>
   5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;Boost.Log v2">
   8 <link rel="up" href="../../utilities.html#header.boost.log.utility.type_dispatch.type_dispatcher_hpp" title="Header &lt;boost/log/utility/type_dispatch/type_dispatcher.hpp&gt;">
   9 <link rel="prev" href="static_type_dispatcher.html" title="Class template static_type_dispatcher">
  10 <link rel="next" href="type_dispatcher/callback.html" title="Class template callback">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr><td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td></tr></table>
  14 <hr>
  15 <div class="spirit-nav">
  16 <a accesskey="p" href="static_type_dispatcher.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../utilities.html#header.boost.log.utility.type_dispatch.type_dispatcher_hpp"><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="type_dispatcher/callback.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.type_dispatcher"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class type_dispatcher</span></h2>
  22 <p>boost::log::type_dispatcher &#8212; A type dispatcher interface. </p>
  23 </div>
  24 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  25 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../utilities.html#header.boost.log.utility.type_dispatch.type_dispatcher_hpp" title="Header &lt;boost/log/utility/type_dispatch/type_dispatcher.hpp&gt;">boost/log/utility/type_dispatch/type_dispatcher.hpp</a>&gt;
  26
  27 </span>
  28 <span class="keyword">class</span> <a class="link" href="type_dispatcher.html" title="Class type_dispatcher">type_dispatcher</a> <span class="special">{</span>
  29 <span class="keyword">public</span><span class="special">:</span>
  30   <span class="comment">// member classes/structs/unions</span>
  31   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
  32   <span class="keyword">class</span> <a class="link" href="type_dispatcher/callback.html" title="Class template callback">callback</a> <span class="special">{</span>
  33   <span class="keyword">public</span><span class="special">:</span>
  34
  35     <span class="comment">// <a class="link" href="type_dispatcher/callback.html#idm45711342350432-bb">public member functions</a></span>
  36     <span class="keyword">void</span> <a class="link" href="type_dispatcher/callback.html#idm45711342349872-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  37     <span class="keyword">explicit</span> <a class="link" href="type_dispatcher/callback.html#idm45711342346896-bb"><span class="keyword">operator</span> <span class="keyword">bool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  38     <span class="keyword">bool</span> <a class="link" href="type_dispatcher/callback.html#idm45711342345040-bb"><span class="keyword">operator</span><span class="special">!</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  39   <span class="special">}</span><span class="special">;</span>
  40   <span class="comment">// <a class="link" href="type_dispatcher.html#boost.log.type_dispatcherconstruct-copy-destruct">construct/copy/destruct</a></span>
  41   <span class="keyword">explicit</span> <a class="link" href="type_dispatcher.html#idm45711342337888-bb"><span class="identifier">type_dispatcher</span></a><span class="special">(</span><span class="identifier">get_callback_impl_type</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  42
  43   <span class="comment">// <a class="link" href="type_dispatcher.html#idm45711342343296-bb">protected member functions</a></span>
  44    <a class="link" href="type_dispatcher.html#idm45711342342720-bb"><span class="identifier">BOOST_DEFAULTED_FUNCTION</span></a><span class="special">(</span><a class="link" href="type_dispatcher.html" title="Class type_dispatcher">type_dispatcher</a><span class="special">(</span><a class="link" href="type_dispatcher.html" title="Class type_dispatcher">type_dispatcher</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="identifier">that</span><span class="special">)</span><span class="special">,</span>
  45                             <span class="special">:</span><span class="identifier">m_get_callback_impl</span><span class="special">(</span><span class="identifier">that</span><span class="special">.</span><span class="identifier">m_get_callback_impl</span><span class="special">)</span> <span class="special">{</span><span class="special">}</span><span class="special">)</span><span class="special">;</span>
  46 <span class="special">}</span><span class="special">;</span></pre></div>
  47 <div class="refsect1">
  48 <a name="idm45554718483664"></a><h2>Description</h2>
  49 <p>All type dispatchers support this interface. It is used to acquire the visitor interface for the requested type. </p>
  50 <div class="refsect2">
  51 <a name="idm45554718482864"></a><h3>
  52 <a name="boost.log.type_dispatcherconstruct-copy-destruct"></a><code class="computeroutput">type_dispatcher</code>
  53         public
  54        construct/copy/destruct</h3>
  55 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  56 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45711342337888-bb"></a><span class="identifier">type_dispatcher</span><span class="special">(</span><span class="identifier">get_callback_impl_type</span> get_callback_impl<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
  57 <p>Initializing constructor </p>
  58 </li></ol></div>
  59 </div>
  60 <div class="refsect2">
  61 <a name="idm45554718474576"></a><h3>
  62 <a name="idm45711342343296-bb"></a><code class="computeroutput">type_dispatcher</code> protected member functions</h3>
  63 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  64 <pre class="literallayout"> <a name="idm45711342342720-bb"></a><span class="identifier">BOOST_DEFAULTED_FUNCTION</span><span class="special">(</span><a class="link" href="type_dispatcher.html" title="Class type_dispatcher">type_dispatcher</a><span class="special">(</span><a class="link" href="type_dispatcher.html" title="Class type_dispatcher">type_dispatcher</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="identifier">that</span><span class="special">)</span><span class="special">,</span>
  65                           <span class="special">:</span><span class="identifier">m_get_callback_impl</span><span class="special">(</span><span class="identifier">that</span><span class="special">.</span><span class="identifier">m_get_callback_impl</span><span class="special">)</span> <span class="special">{</span><span class="special">}</span><span class="special">)</span><span class="special">;</span></pre>
  66 <p>The method requests a callback for the value of type <code class="computeroutput">T</code> </p>
  67 <p>
  68 </p>
  69 <div class="variablelist"><table border="0" class="variablelist compact">
  70 <colgroup>
  71 <col align="left" valign="top">
  72 <col>
  73 </colgroup>
  74 <tbody><tr>
  75 <td><p><span class="term">Returns:</span></p></td>
  76 <td><p>The type-specific callback or an empty value, if the type is not supported </p></td>
  77 </tr></tbody>
  78 </table></div>
  79 </li></ol></div>
  80 </div>
  81 </div>
  82 </div>
  83 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  84 <td align="left"></td>
  85 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
  86         Distributed under the Boost Software License, Version 1.0. (See accompanying
  87         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>).
  88       </p>
  89 </div></td>
  90 </tr></table>
  91 <hr>
  92 <div class="spirit-nav">
  93 <a accesskey="p" href="static_type_dispatcher.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../utilities.html#header.boost.log.utility.type_dispatch.type_dispatcher_hpp"><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="type_dispatcher/callback.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  94 </div>
  95 </body>
  96 </html>