optimally_buffered.html 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
  2. <HTML>
  3. <HEAD>
  4. <TITLE>OptimallyBuffered</TITLE>
  5. <LINK REL="stylesheet" HREF="../../../../boost.css">
  6. <LINK REL="stylesheet" HREF="../theme/iostreams.css">
  7. </HEAD>
  8. <BODY>
  9. <!-- Begin Banner -->
  10. <H1 CLASS="title">OptimallyBuffered</H1>
  11. <HR CLASS="banner">
  12. <!-- End Banner -->
  13. <H2>Description</H2>
  14. <P>
  15. 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.
  16. </P>
  17. <H2>Refinement of</H2>
  18. <A NAME="types"></A>
  19. <H2>Associated Types</H2>
  20. <H2>Notation</H2>
  21. <TABLE CELLPADDING="2">
  22. <TR><TD><CODE>O</CODE></TD><TD>-</TD><TD>A type which is a model of OptimallyBuffered</TD></TR>
  23. <TR><TD><CODE>o</CODE></TD><TD>-</TD><TD>Object of type <CODE>O</CODE></TD></TR>
  24. <TR><TD><CODE>io</CODE></TD><TD>-</TD><TD>Alias for namespace <CODE>boost::iostreams</CODE></TD></TR>
  25. </TABLE>
  26. <H2>Valid Expressions / Semantics</H2>
  27. <TABLE CELLPADDING="5" BORDER="1">
  28. <TR><TH>Expression</TH><TH>Expression Type</TH><TH>Semantics</TH></TR>
  29. <TR>
  30. <TD>
  31. <PRE CLASS="plain_code"><CODE><A HREF="../functions/optimal_buffer_size.html">io::optimal_buffer_size</A>(o)</CODE></PRE>
  32. </TD>
  33. <TD><CODE>std::streamsize</CODE></TD>
  34. <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>
  35. </TR>
  36. </TABLE>
  37. <H2>Models</H2>
  38. <UL>
  39. <LI><A HREF="../classes/counter.html"><CODE>basic_counter</CODE></A>
  40. </UL>
  41. <!-- Begin Footer -->
  42. <HR>
  43. <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>
  44. <P CLASS="copyright">
  45. 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>)
  46. </P>
  47. <!-- End Footer -->
  48. </BODY>