<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template basic_vectorbuf</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../../boost_interprocess_reference.html#header.boost.interprocess.streams.vectorstream_hpp" title="Header <boost/interprocess/streams/vectorstream.hpp>">
<link rel="prev" href="basic_bufferstream.html" title="Class template basic_bufferstream">
<link rel="next" href="basic_ivectorstream.html" title="Class template basic_ivectorstream">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="basic_bufferstream.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_reference.html#header.boost.interprocess.streams.vectorstream_hpp"><img src="../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="basic_ivectorstream.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="refentry" title="Class template basic_vectorbuf">
<a name="boost.interprocess.basic_vectorbuf"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template basic_vectorbuf</span></h2>
<p>boost::interprocess::basic_vectorbuf</p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="emphasis"><em>// In header: <<a class="link" href="../../boost_interprocess_reference.html#header.boost.interprocess.streams.vectorstream_hpp" title="Header <boost/interprocess/streams/vectorstream.hpp>">boost/interprocess/streams/vectorstream.hpp</a>>
</em></span><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> CharVector, <span class="bold"><strong>typename</strong></span> CharTraits>
<span class="bold"><strong>class</strong></span> <a class="link" href="basic_vectorbuf.html" title="Class template basic_vectorbuf">basic_vectorbuf</a> {
<span class="bold"><strong>public</strong></span>:
<span class="emphasis"><em>// types</em></span>
<span class="bold"><strong>typedef</strong></span> CharVector <a name="boost.interprocess.basic_vectorbuf.vector_type"></a>vector_type;
<span class="bold"><strong>typedef</strong></span> CharVector::value_type <a name="boost.interprocess.basic_vectorbuf.char_type"></a>char_type;
<span class="bold"><strong>typedef</strong></span> CharTraits::int_type <a name="boost.interprocess.basic_vectorbuf.int_type"></a>int_type;
<span class="bold"><strong>typedef</strong></span> CharTraits::pos_type <a name="boost.interprocess.basic_vectorbuf.pos_type"></a>pos_type;
<span class="bold"><strong>typedef</strong></span> CharTraits::off_type <a name="boost.interprocess.basic_vectorbuf.off_type"></a>off_type;
<span class="bold"><strong>typedef</strong></span> CharTraits <a name="boost.interprocess.basic_vectorbuf.traits_type"></a>traits_type;
<span class="emphasis"><em>// <a class="link" href="basic_vectorbuf.html#boost.interprocess.basic_vectorbufconstruct-copy-destruct">construct/copy/destruct</a></em></span>
<a class="link" href="basic_vectorbuf.html#id820184-bb">basic_vectorbuf</a>(std::ios_base::openmode = std::ios_base::in|std::ios_base::out);
<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> VectorParameter>
<a class="link" href="basic_vectorbuf.html#id820198-bb">basic_vectorbuf</a>(<span class="bold"><strong>const</strong></span> VectorParameter &,
std::ios_base::openmode = std::ios_base::in|std::ios_base::out);
<a class="link" href="basic_vectorbuf.html#id820225-bb">~basic_vectorbuf</a>();
<span class="emphasis"><em>// <a class="link" href="basic_vectorbuf.html#id820117-bb">public member functions</a></em></span>
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="basic_vectorbuf.html#id820120-bb">swap_vector</a>(vector_type &) ;
<span class="type"><span class="bold"><strong>const</strong></span> vector_type &</span> <a class="link" href="basic_vectorbuf.html#id820139-bb">vector</a>() <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="basic_vectorbuf.html#id820152-bb">reserve</a>(<span class="bold"><strong>typename</strong></span> vector_type::size_type) ;
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="basic_vectorbuf.html#id820171-bb">clear</a>() ;
};</pre></div>
<div class="refsect1" title="Description">
<a name="id1052967"></a><h2>Description</h2>
<p>A streambuf class that controls the transmission of elements to and from a basic_ivectorstream, basic_ovectorstream or basic_vectorstream. It holds a character vector specified by CharVector template parameter as its formatting buffer. The vector must have contiguous storage, like std::vector, boost::interprocess::vector or boost::interprocess::basic_string </p>
<div class="refsect2" title="basic_vectorbuf public construct/copy/destruct">
<a name="id1052979"></a><h3>
<a name="boost.interprocess.basic_vectorbufconstruct-copy-destruct"></a><code class="computeroutput">basic_vectorbuf</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><a name="id820184-bb"></a>basic_vectorbuf(std::ios_base::openmode mode = std::ios_base::in|std::ios_base::out);</pre>
<p>Constructor. Throws if vector_type default constructor throws. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> VectorParameter>
<a name="id820198-bb"></a>basic_vectorbuf(<span class="bold"><strong>const</strong></span> VectorParameter & param,
std::ios_base::openmode mode = std::ios_base::in|std::ios_base::out);</pre>
<p>Constructor. Throws if vector_type(const VectorParameter &param) throws. </p>
</li>
<li class="listitem"><pre class="literallayout"><a name="id820225-bb"></a>~basic_vectorbuf();</pre></li>
</ol></div>
</div>
<div class="refsect2" title="basic_vectorbuf public member functions">
<a name="id1053070"></a><h3>
<a name="id820117-bb"></a><code class="computeroutput">basic_vectorbuf</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id820120-bb"></a>swap_vector(vector_type & vect) ;</pre>
<p>Swaps the underlying vector with the passed vector. This function resets the read/write position in the stream. Does not throw. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> vector_type &</span> <a name="id820139-bb"></a>vector() <span class="bold"><strong>const</strong></span>;</pre>
<p>Returns a const reference to the internal vector. Does not throw. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id820152-bb"></a>reserve(<span class="bold"><strong>typename</strong></span> vector_type::size_type size) ;</pre>
<p>Preallocates memory from the internal vector. Resets the stream to the first position. Throws if the internals vector's memory allocation throws. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id820171-bb"></a>clear() ;</pre>
<p>Calls clear() method of the internal vector. Resets the stream to the first position. </p>
</li>
</ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2005 - 2008 Ion Gaztanaga<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
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>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="basic_bufferstream.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_reference.html#header.boost.interprocess.streams.vectorstream_hpp"><img src="../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="basic_ivectorstream.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>
