doc/html/boost/interprocess/basic_bufferbuf.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template basic_bufferbuf</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.streams.bufferstream_hpp" title="Header &lt;boost/interprocess/streams/bufferstream.hpp&gt;">
   9 <link rel="prev" href="make_managed_weak_ptr.html" title="Function template make_managed_weak_ptr">
  10 <link rel="next" href="basic_ibufferstream.html" title="Class template basic_ibufferstream">
  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="make_managed_weak_ptr.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.streams.bufferstream_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="basic_ibufferstream.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.interprocess.basic_bufferbuf"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template basic_bufferbuf</span></h2>
  29 <p>boost::interprocess::basic_bufferbuf</p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <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="../../interprocess/indexes_reference.html#header.boost.interprocess.streams.bufferstream_hpp" title="Header &lt;boost/interprocess/streams/bufferstream.hpp&gt;">boost/interprocess/streams/bufferstream.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> CharTraits<span class="special">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="basic_bufferbuf.html" title="Class template basic_bufferbuf">basic_bufferbuf</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_streambuf</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">&gt;</span> <span class="special">{</span>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// types</span>
  38   <span class="keyword">typedef</span> <span class="identifier">CharT</span>                                          <a name="boost.interprocess.basic_bufferbuf.char_type"></a><span class="identifier">char_type</span><span class="special">;</span>
  39   <span class="keyword">typedef</span> <span class="identifier">CharTraits</span><span class="special">::</span><span class="identifier">int_type</span>                           <a name="boost.interprocess.basic_bufferbuf.int_type"></a><span class="identifier">int_type</span><span class="special">;</span>
  40   <span class="keyword">typedef</span> <span class="identifier">CharTraits</span><span class="special">::</span><span class="identifier">pos_type</span>                           <a name="boost.interprocess.basic_bufferbuf.pos_type"></a><span class="identifier">pos_type</span><span class="special">;</span>
  41   <span class="keyword">typedef</span> <span class="identifier">CharTraits</span><span class="special">::</span><span class="identifier">off_type</span>                           <a name="boost.interprocess.basic_bufferbuf.off_type"></a><span class="identifier">off_type</span><span class="special">;</span>
  42   <span class="keyword">typedef</span> <span class="identifier">CharTraits</span>                                     <a name="boost.interprocess.basic_bufferbuf.traits_type"></a><span class="identifier">traits_type</span><span class="special">;</span>
  43   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_streambuf</span><span class="special">&lt;</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="identifier">traits_type</span> <span class="special">&gt;</span> <a name="boost.interprocess.basic_bufferbuf.base_t"></a><span class="identifier">base_t</span><span class="special">;</span>
  44
  45   <span class="comment">// <a class="link" href="basic_bufferbuf.html#boost.interprocess.basic_bufferbufconstruct-copy-destruct">construct/copy/destruct</a></span>
  46   <span class="keyword">explicit</span> <a class="link" href="basic_bufferbuf.html#idp66359824-bb"><span class="identifier">basic_bufferbuf</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span>
  47   <span class="keyword">explicit</span> <a class="link" href="basic_bufferbuf.html#idp66361808-bb"><span class="identifier">basic_bufferbuf</span></a><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span>
  48                            <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span>
  49   <a class="link" href="basic_bufferbuf.html#idp66365200-bb"><span class="special">~</span><span class="identifier">basic_bufferbuf</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  50
  51   <span class="comment">// <a class="link" href="basic_bufferbuf.html#idp66354816-bb">public member functions</a></span>
  52   <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span> <span class="identifier">CharT</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">&gt;</span> <a class="link" href="basic_bufferbuf.html#idp66355376-bb"><span class="identifier">buffer</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  53   <span class="keyword">void</span> <a class="link" href="basic_bufferbuf.html#idp66356976-bb"><span class="identifier">buffer</span></a><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span>
  54 <span class="special">}</span><span class="special">;</span></pre></div>
  55 <div class="refsect1">
  56 <a name="idp246691408"></a><h2>Description</h2>
  57 <p>A streambuf class that controls the transmission of elements to and from a basic_xbufferstream. The elements are transmitted from a to a fixed size buffer </p>
  58 <div class="refsect2">
  59 <a name="idp246692256"></a><h3>
  60 <a name="boost.interprocess.basic_bufferbufconstruct-copy-destruct"></a><code class="computeroutput">basic_bufferbuf</code>
  61         public
  62        construct/copy/destruct</h3>
  63 <div class="orderedlist"><ol class="orderedlist" type="1">
  64 <li class="listitem">
  65 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idp66359824-bb"></a><span class="identifier">basic_bufferbuf</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span></pre>
  66 <p>Constructor. Does not throw. </p>
  67 </li>
  68 <li class="listitem">
  69 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idp66361808-bb"></a><span class="identifier">basic_bufferbuf</span><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</span> buf<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> length<span class="special">,</span>
  70                          <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span></pre>
  71 <p>Constructor. Assigns formatting buffer. Does not throw. </p>
  72 </li>
  73 <li class="listitem"><pre class="literallayout"><a name="idp66365200-bb"></a><span class="special">~</span><span class="identifier">basic_bufferbuf</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
  74 </ol></div>
  75 </div>
  76 <div class="refsect2">
  77 <a name="idp246731136"></a><h3>
  78 <a name="idp66354816-bb"></a><code class="computeroutput">basic_bufferbuf</code> public member functions</h3>
  79 <div class="orderedlist"><ol class="orderedlist" type="1">
  80 <li class="listitem">
  81 <pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span> <span class="identifier">CharT</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">&gt;</span> <a name="idp66355376-bb"></a><span class="identifier">buffer</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
  82 <p>Returns the pointer and size of the internal buffer. Does not throw. </p>
  83 </li>
  84 <li class="listitem">
  85 <pre class="literallayout"><span class="keyword">void</span> <a name="idp66356976-bb"></a><span class="identifier">buffer</span><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</span> buf<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> length<span class="special">)</span><span class="special">;</span></pre>
  86 <p>Sets the underlying buffer to a new value Does not throw. </p>
  87 </li>
  88 </ol></div>
  89 </div>
  90 </div>
  91 </div>
  92 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  93 <td align="left"></td>
  94 <td align="right"><div class="copyright-footer">Copyright &#169; 2005-2012 Ion Gaztanaga<p>
  95         Distributed under the Boost Software License, Version 1.0. (See accompanying
  96         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>)
  97       </p>
  98 </div></td>
  99 </tr></table>
 100 <hr>
 101 <div class="spirit-nav">
 102 <a accesskey="p" href="make_managed_weak_ptr.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.streams.bufferstream_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="basic_ibufferstream.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 103 </div>
 104 </body>
 105 </html>