nbw-bt/Umsetzung/Perl/Kieker/Writer/FileWriter.pm.htm
2014-09-26 15:45:57 +02:00

101 lines
3.6 KiB
HTML

<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Kieker::Writer::FileWriter - Provides a Kieker Writer for file output.</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>
<body style="background-color: white">
<!-- INDEX BEGIN -->
<div name="index">
<p><a name="__index__"></a></p>
<ul>
<li><a href="#name">NAME</a></li>
<li><a href="#synopsis">SYNOPSIS</a></li>
<li><a href="#description">DESCRIPTION</a></li>
<li><a href="#methods">METHODS</a></li>
<ul>
<li><a href="#_writer___kieker__writer__filewriter__instance___">$writer = Kieker::Writer::FileWriter-&gt;<code>instance()</code>;</a></li>
<li><a href="#_writer__write_string__">$writer-&gt;write(STRING);</a></li>
</ul>
<li><a href="#bugs">BUGS</a></li>
<li><a href="#copyright_and_licence">COPYRIGHT and LICENCE</a></li>
</ul>
<hr name="index" />
</div>
<!-- INDEX END -->
<p>
</p>
<h1><a name="name">NAME</a></h1>
<p>Kieker::Writer::FileWriter - Provides a Kieker Writer for file output.</p>
<p>
</p>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<pre>
use Kieker::Writer::FileWriter;
my $writer = Kieker::Writer::FileWriter-&gt;instance();
# Get writer instance</pre>
<pre>
$writer-&gt;write($string); # writes string to the current file</pre>
<p>
</p>
<hr />
<h1><a name="description">DESCRIPTION</a></h1>
<p>Writes Kieker records to a Logfile. Can also be used to write other strings to
log files.</p>
<p>
</p>
<hr />
<h1><a name="methods">METHODS</a></h1>
<p>
</p>
<h2><a name="_writer___kieker__writer__filewriter__instance___">$writer = Kieker::Writer::FileWriter-&gt;<code>instance()</code>;</a></h2>
<p>Returns the writer singleton instance. Thsi object holds the filehandle
currently wrinting to. If no instance exists, it is created and a new logfile
is created using the current time for the filename.</p>
<p>
</p>
<h2><a name="_writer__write_string__">$writer-&gt;write(STRING);</a></h2>
<p>Writes STRING to the filehandle.</p>
<p>
</p>
<hr />
<h1><a name="bugs">BUGS</a></h1>
<p>The package is probably full of bugs and is likely to break on every possible
occasion. If you find any please let me know via email.</p>
<p>
</p>
<hr />
<h1><a name="copyright_and_licence">COPYRIGHT and LICENCE</a></h1>
<p>Copyright 2013 Nis Börge Wechselberg, Kiel, Germany, <a href="mailto:nbw@informatik.uni-kiel.de">nbw@informatik.uni-kiel.de</a></p>
<p>The MIT License (MIT)</p>
<p>Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the &quot;Software&quot;),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:</p>
<p>The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.</p>
<p>THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.</p>
</body>
</html>