<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>Class Poco::BasicBufferedStreamBuf</title> <meta http-equiv="content-type" content="text/html; charset=utf-8"/> <meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/> <meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/> <meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/> <meta name="language" content="en"/> <meta name="date" content="2009-11-24"/> <meta name="generator" content="PocoDoc"/> <link rel="stylesheet" href="css/styles.css" type="text/css"/> </head> <body bgcolor="#ffffff" leftmargin="0" topmargin="0"> <div class="header"> <h1 class="namespace"><a href="Poco.html" class="namespace">Poco</a></h1> <h1 class="template">template < typename ch, typename tr, typename ba = BufferAllocator < ch > ></h1> <h1 class="symbol">class BasicBufferedStreamBuf</h1> </div> <div class="body"> <p> <b>Library:</b> Foundation<br /> <b>Package:</b> Streams<br /> <b>Header:</b> Poco/BufferedStreamBuf.h</p> <h2>Description</h2> <div class="description"> <p>This is an implementation of a buffered streambuf that greatly simplifies the implementation of custom streambufs of various kinds. Derived classes only have to override the methods <a href="Poco.BasicBufferedStreamBuf.html#4014" title="Poco::BasicBufferedStreamBuf::readFromDevice()">readFromDevice</a>() or <a href="Poco.BasicBufferedStreamBuf.html#4017" title="Poco::BasicBufferedStreamBuf::writeToDevice()">writeToDevice</a>(). </p> <p>This streambuf only supports unidirectional streams. In other words, the <a href="Poco.BasicBufferedStreamBuf.html" title="class Poco::BasicBufferedStreamBuf">BasicBufferedStreamBuf</a> can be used for the implementation of an istream or an ostream, but not for an iostream. </p> </div> <h2>Inheritance</h2> <p><b>Direct Base Classes: </b>std::basic_streambuf < ch, tr ></p> <p><b>All Base Classes: </b>std::basic_streambuf < ch, tr ></p> <h2>Member Summary</h2> <p><b>Member Functions: </b><a href="Poco.BasicBufferedStreamBuf.html#4013" title="Poco::BasicBufferedStreamBuf::getMode()">getMode</a>, <a href="Poco.BasicBufferedStreamBuf.html#4007" title="Poco::BasicBufferedStreamBuf::overflow()">overflow</a>, <a href="Poco.BasicBufferedStreamBuf.html#4011" title="Poco::BasicBufferedStreamBuf::setMode()">setMode</a>, <a href="Poco.BasicBufferedStreamBuf.html#4010" title="Poco::BasicBufferedStreamBuf::sync()">sync</a>, <a href="Poco.BasicBufferedStreamBuf.html#4009" title="Poco::BasicBufferedStreamBuf::underflow()">underflow</a></p> <h2>Types</h2> <h3><a name="3998">Allocator</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">typedef ba <a href="Poco.BasicBufferedStreamBuf.html#3998" title="Poco::BasicBufferedStreamBuf::Allocator">Allocator</a>;</p> <div class="description"> <p></p> </div> <h3><a name="3994">Base</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">typedef std::basic_streambuf < ch, tr > <a href="Poco.BasicBufferedStreamBuf.html#3994" title="Poco::BasicBufferedStreamBuf::Base">Base</a>;</p> <div class="description"> <p></p> </div> <h3><a name="3995">IOS</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">typedef std::basic_ios < ch, tr > <a href="Poco.BasicBufferedStreamBuf.html#3995" title="Poco::BasicBufferedStreamBuf::IOS">IOS</a>;</p> <div class="description"> <p></p> </div> <h3><a name="3997">char_traits</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">typedef tr char_traits;</p> <div class="description"> <p></p> </div> <h3><a name="3996">char_type</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">typedef ch char_type;</p> <div class="description"> <p></p> </div> <h3><a name="3999">int_type</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">typedef typename Base::int_type int_type;</p> <div class="description"> <p></p> </div> <h3><a name="4001">off_type</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">typedef typename Base::off_type off_type;</p> <div class="description"> <p></p> </div> <h3><a name="4002">openmode</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">typedef typename IOS::openmode openmode;</p> <div class="description"> <p></p> </div> <h3><a name="4000">pos_type</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">typedef typename Base::pos_type pos_type;</p> <div class="description"> <p></p> </div> <h2>Constructors</h2> <h3><a name="4003">BasicBufferedStreamBuf</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl"><a href="Poco.BasicBufferedStreamBuf.html" title="class Poco::BasicBufferedStreamBuf">BasicBufferedStreamBuf</a>(<br /> std::streamsize bufferSize,<br /> openmode mode<br />);</p> <div class="description"> <p></p> </div> <h2>Destructor</h2> <h3><a name="4006">~BasicBufferedStreamBuf</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">~<a href="Poco.BasicBufferedStreamBuf.html" title="class Poco::BasicBufferedStreamBuf">BasicBufferedStreamBuf</a>();</p> <div class="description"> <p></p> </div> <h2>Member Functions</h2> <h3><a name="4007">overflow</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">virtual int_type overflow(<br /> int_type c<br />);</p> <div class="description"> <p></p> </div> <h3><a name="4010">sync</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">virtual int sync();</p> <div class="description"> <p></p> </div> <h3><a name="4009">underflow</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">virtual int_type underflow();</p> <div class="description"> <p></p> </div> <h3><a name="4013">getMode</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">openmode getMode() const;</p> <div class="description"> <p></p> </div> <h3><a name="4011">setMode</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void setMode(<br /> openmode mode<br />);</p> <div class="description"> <p></p> </div> <p class="footer">POCO C++ Libraries 1.3.6-all<br /> Copyright © 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p> </div> </body> </html>
