• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<html>
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5<title>Class template basic_bufferbuf</title>
6<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
8<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
9<link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.streams.bufferstream_hpp" title="Header &lt;boost/interprocess/streams/bufferstream.hpp&gt;">
10<link rel="prev" href="make_managed_weak_ptr.html" title="Function template make_managed_weak_ptr">
11<link rel="next" href="basic_bufferstream.html" title="Class template basic_bufferstream">
12</head>
13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
14<table cellpadding="2" width="100%"><tr>
15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
16<td align="center"><a href="../../../../index.html">Home</a></td>
17<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
20<td align="center"><a href="../../../../more/index.htm">More</a></td>
21</tr></table>
22<hr>
23<div class="spirit-nav">
24<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_bufferstream.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
25</div>
26<div class="refentry">
27<a name="boost.interprocess.basic_bufferbuf"></a><div class="titlepage"></div>
28<div class="refnamediv">
29<h2><span class="refentrytitle">Class template basic_bufferbuf</span></h2>
30<p>boost::interprocess::basic_bufferbuf</p>
31</div>
32<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
33<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;
34
35</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>
36<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>
37<span class="keyword">public</span><span class="special">:</span>
38  <span class="comment">// types</span>
39  <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>
40  <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>
41  <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>
42  <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>
43  <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>
44  <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.basic_streambuf_t"></a><span class="identifier">basic_streambuf_t</span><span class="special">;</span>
45
46  <span class="comment">// <a class="link" href="basic_bufferbuf.html#boost.interprocess.basic_bufferbufconstruct-copy-destruct">construct/copy/destruct</a></span>
47  <span class="keyword">explicit</span> <a class="link" href="basic_bufferbuf.html#idm45304010641888-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>
48  <span class="keyword">explicit</span> <a class="link" href="basic_bufferbuf.html#idm45304010639904-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>
49                           <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>
50  <a class="link" href="basic_bufferbuf.html#idm45304010636512-bb"><span class="special">~</span><span class="identifier">basic_bufferbuf</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
51
52  <span class="comment">// <a class="link" href="basic_bufferbuf.html#idm45304010646896-bb">public member functions</a></span>
53  <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#idm45304010646336-bb"><span class="identifier">buffer</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
54  <span class="keyword">void</span> <a class="link" href="basic_bufferbuf.html#idm45304010644736-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>
55<span class="special">}</span><span class="special">;</span></pre></div>
56<div class="refsect1">
57<a name="id-1.3.19.17.3.55.4.4"></a><h2>Description</h2>
58<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>
59<div class="refsect2">
60<a name="id-1.3.19.17.3.55.4.4.3"></a><h3>
61<a name="boost.interprocess.basic_bufferbufconstruct-copy-destruct"></a><code class="computeroutput">basic_bufferbuf</code>
62        public
63       construct/copy/destruct</h3>
64<div class="orderedlist"><ol class="orderedlist" type="1">
65<li class="listitem">
66<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45304010641888-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>
67<p>Constructor. Does not throw. </p>
68</li>
69<li class="listitem">
70<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45304010639904-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>
71                         <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>
72<p>Constructor. Assigns formatting buffer. Does not throw. </p>
73</li>
74<li class="listitem"><pre class="literallayout"><a name="idm45304010636512-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>
75</ol></div>
76</div>
77<div class="refsect2">
78<a name="id-1.3.19.17.3.55.4.4.4"></a><h3>
79<a name="idm45304010646896-bb"></a><code class="computeroutput">basic_bufferbuf</code> public member functions</h3>
80<div class="orderedlist"><ol class="orderedlist" type="1">
81<li class="listitem">
82<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="idm45304010646336-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>
83<p>Returns the pointer and size of the internal buffer. Does not throw. </p>
84</li>
85<li class="listitem">
86<pre class="literallayout"><span class="keyword">void</span> <a name="idm45304010644736-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>
87<p>Sets the underlying buffer to a new value Does not throw. </p>
88</li>
89</ol></div>
90</div>
91</div>
92</div>
93<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
94<td align="left"></td>
95<td align="right"><div class="copyright-footer">Copyright © 2005-2015 Ion Gaztanaga<p>
96        Distributed under the Boost Software License, Version 1.0. (See accompanying
97        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>)
98      </p>
99</div></td>
100</tr></table>
101<hr>
102<div class="spirit-nav">
103<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_bufferstream.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
104</div>
105</body>
106</html>
107