<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>Class LogChannelStream - Class LogChannelStream</title> <link href="faldoc.css" rel="stylesheet" type="text/css"/> <link href="tabs.css" rel="stylesheet" type="text/css"/> </head> <body class="faldoc_body"> <div class="navitop"> <div class="tabs"> <ul> <li><a href="./index.html"><span>Main</span></a></li> <li><a href="./modules.html"><span>Modules</span></a></li> <li><a href="./pages.html"><span>Related pages</span></a></li> <li><a href="./groups.html"><span>Groups</span></a></li> <li><a href="./classes.html"><span>Classes</span></a></li> <li><a href="./objects.html"><span>Objects</span></a></li> <li><a href="./functions.html"><span>All functions</span></a></li> <li><a href="./enum.html"><span>Enumerations</span></a></li> </ul> </div> </div> <hr/> <h1 class="faldoc_title">Class LogChannelStream<span class="faldoc_belong"><a href="./module_feather_logging.html">[in Logging support]</a></p></h1> <p class="faldoc_brief">Logs on an open stream. </p> <p class="faldoc_funcdecl"> <b>class</b> LogChannelStream( stream, level, [format] ) </p> <p class="faldoc_brief"><a href="#more">more...</a></p> <h2 class="faldoc_title">Summary</h2> <table class="faldoc_list"> <tr><td><a href="#flushAll">flushAll()</a></td><td>Reads or set the flush all mode. </td></tr> </table> <a name="more"><h2 class="faldoc_title">Detailed description</h2></a> <p class="faldoc_funcdecl"> <b>class</b> LogChannelStream( stream, level, [format] ) </p> <table class="faldoc_function"> <tr><td class="faldoc_param">stream</td><td class="faldoc_paramdesc">the stream where to log. </td></tr><tr><td class="faldoc_param">level</td><td class="faldoc_paramdesc">the log level. </td></tr> <tr><td class="faldoc_optparam">format</td><td class="faldoc_optparamdesc">a format for the log. </td></tr> </table> <br/> <p class="item_brief">Logs on an open stream. </p> <p class="faldoc_text"> If given, the <b>format</b> parameter is used to configure how each log entry will look once rendered on the final stream. Seel <a href="./class_LogChannel.html#format">LogChannel.format</a> for a detailed description. </p> <h2 class="faldoc_title">Methods</h2> <h3 class="faldoc_funcname"><a name="flushAll">flushAll()</a></h3> <p class="item_brief">Reads or set the flush all mode. </p> <p class="faldoc_funcdecl">LogChannelStream.flushAll( [setting] )</p> <table class="faldoc_function"> <tr><td class="faldoc_optparam">setting</td><td class="faldoc_optparamdesc">True to have the stream flushed at each write. </td></tr> <tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">The current status setting. </td></tr> </table> <p class="faldoc_text"><p class="faldoc_text">Stream based channels are usually writing data on buffered streams. The default behavior is that of flushing the buffer as soon as a log line is written. For some tasks where a large amount of log is written, this may be an overkill. </p> </p> <hr/> <div class="navibottom"> <center> <a href="./index.html">Main</a> - <a href="./modules.html">Modules</a> - <a href="./pages.html">Related pages</a> - <a href="./groups.html">Groups</a> - <a href="./classes.html">Classes</a> - <a href="./objects.html">Objects</a> - <a href="./functions.html">All functions</a> - <a href="./enum.html">Enumerations</a> </center> </div> </div> <div class="faldoc_signature">Made with <a href="http://www.falconpl.org">faldoc 2.2.0</div> </body> </html>