iostreams/doc/concepts/optimally_buffered.html

65 lines
2.1 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML>
<HEAD>
<TITLE>OptimallyBuffered</TITLE>
<LINK REL="stylesheet" HREF="../../../../boost.css">
<LINK REL="stylesheet" HREF="../theme/iostreams.css">
</HEAD>
<BODY>
<!-- Begin Banner -->
<H1 CLASS="title">OptimallyBuffered</H1>
<HR CLASS="banner">
<!-- End Banner -->
<H2>Description</H2>
<P>
A OptimallyBuffered Filter or Device provides a way for the Iostreams library to determine the best size of buffer to allocate for it if the user doesn't explicitly specify a buffer size.
</P>
<H2>Refinement of</H2>
<A NAME="types"></A>
<H2>Associated Types</H2>
<H2>Notation</H2>
<TABLE CELLPADDING="2">
<TR><TD><CODE>O</CODE></TD><TD>-</TD><TD>A type which is a model of OptimallyBuffered</TD></TR>
<TR><TD><CODE>o</CODE></TD><TD>-</TD><TD>Object of type <CODE>O</CODE></TD></TR>
<TR><TD><CODE>io</CODE></TD><TD>-</TD><TD>Alias for namespace <CODE>boost::iostreams</CODE></TD></TR>
</TABLE>
<H2>Valid Expressions / Semantics</H2>
<TABLE CELLPADDING="5" BORDER="1">
<TR><TH>Expression</TH><TH>Expression Type</TH><TH>Semantics</TH></TR>
<TR>
<TD>
<PRE CLASS="plain_code"><CODE><A HREF="../functions/optimal_buffer_size.html">io::optimal_buffer_size</A>(o)</CODE></PRE>
</TD>
<TD><CODE>std::streamsize</CODE></TD>
<TD>Returns the size of buffer that should be allocated for <CODE>o</CODE> if the user has not explicitly specified a buffer size.</TD>
</TR>
</TABLE>
<H2>Models</H2>
<UL>
<LI><A HREF="../classes/counter.html"><CODE>basic_counter</CODE></A>
</UL>
<!-- Begin Footer -->
<HR>
<P CLASS="copyright">&copy; Copyright 2008 <a href="http://www.coderage.com/" target="_top">CodeRage, LLC</a><br/>&copy; Copyright 2004-2007 <a href="https://www.boost.org/users/people/jonathan_turkanis.html" target="_top">Jonathan Turkanis</a></P>
<P CLASS="copyright">
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">http://www.boost.org/LICENSE_1_0.txt</A>)
</P>
<!-- End Footer -->
</BODY>