File: C:/Ruby27-x64/share/doc/ruby/html/WEBrick/BasicLog.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class WEBrick::BasicLog - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../Object.html">Object</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-3C-3C">#<<</a>
<li ><a href="#method-i-close">#close</a>
<li ><a href="#method-i-debug">#debug</a>
<li ><a href="#method-i-debug-3F">#debug?</a>
<li ><a href="#method-i-error">#error</a>
<li ><a href="#method-i-error-3F">#error?</a>
<li ><a href="#method-i-fatal">#fatal</a>
<li ><a href="#method-i-fatal-3F">#fatal?</a>
<li ><a href="#method-i-format">#format</a>
<li ><a href="#method-i-info">#info</a>
<li ><a href="#method-i-info-3F">#info?</a>
<li ><a href="#method-i-log">#log</a>
<li ><a href="#method-i-warn">#warn</a>
<li ><a href="#method-i-warn-3F">#warn?</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-WEBrick::BasicLog">
<h1 id="class-WEBrick::BasicLog" class="class">
class WEBrick::BasicLog
</h1>
<section class="description">
<p>A generic logging class</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="DEBUG">DEBUG
<dd><p>Debugging error level for messages used in server development or debugging</p>
<dt id="ERROR">ERROR
<dd><p><a href="../Error.html"><code>Error</code></a> log level which indicates a recoverable error</p>
<dt id="FATAL">FATAL
<dd><p>Fatal log level which indicates a server crash</p>
<dt id="INFO">INFO
<dd><p>Information log level which indicates possibly useful information</p>
<dt id="WARN">WARN
<dd><p><a href="../Warning.html"><code>Warning</code></a> log level which indicates a possible problem</p>
</dl>
</section>
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-level" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">level</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>log-level, messages above this level will be logged</p>
</div>
</div>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(log_file=nil, level=nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Initializes a new logger for <code>log_file</code> that outputs messages at <code>level</code> or higher. <code>log_file</code> can be a filename, an IO-like object that responds to <a href="BasicLog.html#method-i-3C-3C"><code><<</code></a> or nil which outputs to $stderr.</p>
<p>If no level is given <a href="BasicLog.html#INFO"><code>INFO</code></a> is chosen by default</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/webrick/log.rb, line 50</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">log_file</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">level</span>=<span class="ruby-keyword">nil</span>)
<span class="ruby-ivar">@level</span> = <span class="ruby-identifier">level</span> <span class="ruby-operator">||</span> <span class="ruby-constant">INFO</span>
<span class="ruby-keyword">case</span> <span class="ruby-identifier">log_file</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">String</span>
<span class="ruby-ivar">@log</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">log_file</span>, <span class="ruby-string">"a+"</span>)
<span class="ruby-ivar">@log</span>.<span class="ruby-identifier">sync</span> = <span class="ruby-keyword">true</span>
<span class="ruby-ivar">@opened</span> = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">NilClass</span>
<span class="ruby-ivar">@log</span> = <span class="ruby-identifier">$stderr</span>
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@log</span> = <span class="ruby-identifier">log_file</span> <span class="ruby-comment"># requires "<<". (see BasicLog#log)</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-3C-3C" class="method-detail ">
<div class="method-heading">
<span class="method-name"><<</span><span
class="method-args">(obj)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Synonym for log(<a href="BasicLog.html#INFO"><code>INFO</code></a>, obj.to_s)</p>
<div class="method-source-code" id="3C-3C-source">
<pre><span class="ruby-comment"># File lib/webrick/log.rb, line 84</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title"><<</span>(<span class="ruby-identifier">obj</span>)
<span class="ruby-identifier">log</span>(<span class="ruby-constant">INFO</span>, <span class="ruby-identifier">obj</span>.<span class="ruby-identifier">to_s</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-close" class="method-detail ">
<div class="method-heading">
<span class="method-name">close</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Closes the logger (also closes the log device associated to the logger)</p>
<div class="method-source-code" id="close-source">
<pre><span class="ruby-comment"># File lib/webrick/log.rb, line 66</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">close</span>
<span class="ruby-ivar">@log</span>.<span class="ruby-identifier">close</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@opened</span>
<span class="ruby-ivar">@log</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-debug" class="method-detail ">
<div class="method-heading">
<span class="method-name">debug</span><span
class="method-args">(msg)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Shortcut for logging a <a href="BasicLog.html#DEBUG"><code>DEBUG</code></a> message</p>
<div class="method-source-code" id="debug-source">
<pre><span class="ruby-comment"># File lib/webrick/log.rb, line 97</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">debug</span>(<span class="ruby-identifier">msg</span>) <span class="ruby-identifier">log</span>(<span class="ruby-constant">DEBUG</span>, <span class="ruby-string">"DEBUG "</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">format</span>(<span class="ruby-identifier">msg</span>)); <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-debug-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">debug?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Will the logger output <a href="BasicLog.html#DEBUG"><code>DEBUG</code></a> messages?</p>
<div class="method-source-code" id="debug-3F-source">
<pre><span class="ruby-comment"># File lib/webrick/log.rb, line 108</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">debug?</span>; <span class="ruby-ivar">@level</span> <span class="ruby-operator">>=</span> <span class="ruby-constant">DEBUG</span>; <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-error" class="method-detail ">
<div class="method-heading">
<span class="method-name">error</span><span
class="method-args">(msg)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Shortcut for logging an <a href="BasicLog.html#ERROR"><code>ERROR</code></a> message</p>
<div class="method-source-code" id="error-source">
<pre><span class="ruby-comment"># File lib/webrick/log.rb, line 91</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">error</span>(<span class="ruby-identifier">msg</span>) <span class="ruby-identifier">log</span>(<span class="ruby-constant">ERROR</span>, <span class="ruby-string">"ERROR "</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">format</span>(<span class="ruby-identifier">msg</span>)); <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-error-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">error?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Will the logger output <a href="BasicLog.html#ERROR"><code>ERROR</code></a> messages?</p>
<div class="method-source-code" id="error-3F-source">
<pre><span class="ruby-comment"># File lib/webrick/log.rb, line 102</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">error?</span>; <span class="ruby-ivar">@level</span> <span class="ruby-operator">>=</span> <span class="ruby-constant">ERROR</span>; <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-fatal" class="method-detail ">
<div class="method-heading">
<span class="method-name">fatal</span><span
class="method-args">(msg)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Shortcut for logging a <a href="BasicLog.html#FATAL"><code>FATAL</code></a> message</p>
<div class="method-source-code" id="fatal-source">
<pre><span class="ruby-comment"># File lib/webrick/log.rb, line 89</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">fatal</span>(<span class="ruby-identifier">msg</span>) <span class="ruby-identifier">log</span>(<span class="ruby-constant">FATAL</span>, <span class="ruby-string">"FATAL "</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">format</span>(<span class="ruby-identifier">msg</span>)); <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-fatal-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">fatal?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Will the logger output <a href="BasicLog.html#FATAL"><code>FATAL</code></a> messages?</p>
<div class="method-source-code" id="fatal-3F-source">
<pre><span class="ruby-comment"># File lib/webrick/log.rb, line 100</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">fatal?</span>; <span class="ruby-ivar">@level</span> <span class="ruby-operator">>=</span> <span class="ruby-constant">FATAL</span>; <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-info" class="method-detail ">
<div class="method-heading">
<span class="method-name">info</span><span
class="method-args">(msg)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Shortcut for logging an <a href="BasicLog.html#INFO"><code>INFO</code></a> message</p>
<div class="method-source-code" id="info-source">
<pre><span class="ruby-comment"># File lib/webrick/log.rb, line 95</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">info</span>(<span class="ruby-identifier">msg</span>) <span class="ruby-identifier">log</span>(<span class="ruby-constant">INFO</span>, <span class="ruby-string">"INFO "</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">format</span>(<span class="ruby-identifier">msg</span>)); <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-info-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">info?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Will the logger output <a href="BasicLog.html#INFO"><code>INFO</code></a> messages?</p>
<div class="method-source-code" id="info-3F-source">
<pre><span class="ruby-comment"># File lib/webrick/log.rb, line 106</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">info?</span>; <span class="ruby-ivar">@level</span> <span class="ruby-operator">>=</span> <span class="ruby-constant">INFO</span>; <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-log" class="method-detail ">
<div class="method-heading">
<span class="method-name">log</span><span
class="method-args">(level, data)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Logs <code>data</code> at <code>level</code> if the given level is above the current log level.</p>
<div class="method-source-code" id="log-source">
<pre><span class="ruby-comment"># File lib/webrick/log.rb, line 75</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">data</span>)
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@log</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">level</span> <span class="ruby-operator"><=</span> <span class="ruby-ivar">@level</span>
<span class="ruby-identifier">data</span> <span class="ruby-operator">+=</span> <span class="ruby-string">"\n"</span> <span class="ruby-keyword">if</span> <span class="ruby-regexp">/\n\Z/</span> <span class="ruby-operator">!~</span> <span class="ruby-identifier">data</span>
<span class="ruby-ivar">@log</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">data</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-warn" class="method-detail ">
<div class="method-heading">
<span class="method-name">warn</span><span
class="method-args">(msg)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Shortcut for logging a <a href="BasicLog.html#WARN"><code>WARN</code></a> message</p>
<div class="method-source-code" id="warn-source">
<pre><span class="ruby-comment"># File lib/webrick/log.rb, line 93</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">warn</span>(<span class="ruby-identifier">msg</span>) <span class="ruby-identifier">log</span>(<span class="ruby-constant">WARN</span>, <span class="ruby-string">"WARN "</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">format</span>(<span class="ruby-identifier">msg</span>)); <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-warn-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">warn?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Will the logger output <a href="BasicLog.html#WARN"><code>WARN</code></a> messages?</p>
<div class="method-source-code" id="warn-3F-source">
<pre><span class="ruby-comment"># File lib/webrick/log.rb, line 104</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">warn?</span>; <span class="ruby-ivar">@level</span> <span class="ruby-operator">>=</span> <span class="ruby-constant">WARN</span>; <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-format" class="method-detail ">
<div class="method-heading">
<span class="method-name">format</span><span
class="method-args">(arg)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Formats <code>arg</code> for the logger</p>
<ul><li>
<p>If <code>arg</code> is an <a href="../Exception.html"><code>Exception</code></a>, it will format the error message and the back trace.</p>
</li><li>
<p>If <code>arg</code> responds to to_str, it will return it.</p>
</li><li>
<p>Otherwise it will return <code>arg</code>.inspect.</p>
</li></ul>
<div class="method-source-code" id="format-source">
<pre><span class="ruby-comment"># File lib/webrick/log.rb, line 119</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">format</span>(<span class="ruby-identifier">arg</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Exception</span>)
<span class="ruby-node">"#{arg.class}: #{AccessLog.escape(arg.message)}\n\t"</span> <span class="ruby-operator"><<</span>
<span class="ruby-identifier">arg</span>.<span class="ruby-identifier">backtrace</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"\n\t"</span>) <span class="ruby-operator"><<</span> <span class="ruby-string">"\n"</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:to_str</span>)
<span class="ruby-constant">AccessLog</span>.<span class="ruby-identifier">escape</span>(<span class="ruby-identifier">arg</span>.<span class="ruby-identifier">to_str</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">arg</span>.<span class="ruby-identifier">inspect</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>