<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="OUnitCore.html">
<link rel="next" href="OUnitConf.html">
<link rel="Up" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="OUnit" rel="Chapter" href="OUnit.html">
<link title="OUnit2" rel="Chapter" href="OUnit2.html">
<link title="OUnitThreads" rel="Chapter" href="OUnitThreads.html">
<link title="OUnitUtils" rel="Chapter" href="OUnitUtils.html">
<link title="OUnitPropList" rel="Chapter" href="OUnitPropList.html">
<link title="OUnitPlugin" rel="Chapter" href="OUnitPlugin.html">
<link title="OUnitChooser" rel="Chapter" href="OUnitChooser.html">
<link title="OUnitResultSummary" rel="Chapter" href="OUnitResultSummary.html">
<link title="OUnitLoggerStd" rel="Chapter" href="OUnitLoggerStd.html">
<link title="OUnitLoggerHTML" rel="Chapter" href="OUnitLoggerHTML.html">
<link title="OUnitLoggerHTMLData" rel="Chapter" href="OUnitLoggerHTMLData.html">
<link title="OUnitLoggerJUnit" rel="Chapter" href="OUnitLoggerJUnit.html">
<link title="OUnitAssert" rel="Chapter" href="OUnitAssert.html">
<link title="OUnitBracket" rel="Chapter" href="OUnitBracket.html">
<link title="OUnitTest" rel="Chapter" href="OUnitTest.html">
<link title="OUnitState" rel="Chapter" href="OUnitState.html">
<link title="OUnitRunner" rel="Chapter" href="OUnitRunner.html">
<link title="OUnitRunnerProcesses" rel="Chapter" href="OUnitRunnerProcesses.html">
<link title="OUnitCore" rel="Chapter" href="OUnitCore.html">
<link title="OUnitLogger" rel="Chapter" href="OUnitLogger.html">
<link title="OUnitConf" rel="Chapter" href="OUnitConf.html">
<link title="OUnitShared" rel="Chapter" href="OUnitShared.html">
<link title="OUnitCache" rel="Chapter" href="OUnitCache.html">
<link title="OUnitTestData" rel="Chapter" href="OUnitTestData.html">
<link title="OUnitCheckEnv" rel="Chapter" href="OUnitCheckEnv.html">
<link title="OUnitDiff" rel="Chapter" href="OUnitDiff.html"><title>OUnit user guide : OUnitLogger</title>
</head>
<body>
<div class="navbar"><a class="pre" href="OUnitCore.html" title="OUnitCore">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
<a class="post" href="OUnitConf.html" title="OUnitConf">Next</a>
</div>
<h1>Module <a href="type_OUnitLogger.html">OUnitLogger</a></h1>
<pre><span class="keyword">module</span> OUnitLogger: <code class="code"><span class="keyword">sig</span></code> <a href="OUnitLogger.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info module top">
See OUnit.mli.<br>
</div>
<hr width="100%">
<pre><code><span id="TYPEposition"><span class="keyword">type</span> <code class="type"></code>position</span> = {</code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTposition.filename">filename</span> : <code class="type">string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTposition.line">line</span> : <code class="type">int</code>;</code></td>
</tr></table>
}
<pre><span id="TYPElog_severity"><span class="keyword">type</span> <code class="type"></code>log_severity</span> = <code class="type">[ `Error | `Info | `Warning ]</code> </pre>
<div class="info ">
See OUnit.mli.<br>
</div>
<pre><code><span id="TYPEtest_event"><span class="keyword">type</span> <code class="type">'result</code> test_event</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTtest_event.EStart"><span class="constructor">EStart</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTtest_event.EEnd"><span class="constructor">EEnd</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTtest_event.EResult"><span class="constructor">EResult</span></span> <span class="keyword">of</span> <code class="type">'result</code></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTtest_event.ELog"><span class="constructor">ELog</span></span> <span class="keyword">of</span> <code class="type"><a href="OUnitLogger.html#TYPElog_severity">log_severity</a> * string</code></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTtest_event.ELogRaw"><span class="constructor">ELogRaw</span></span> <span class="keyword">of</span> <code class="type">string</code></code></td>
</tr></table>
<div class="info ">
See OUnit.mli.<br>
</div>
<pre><span id="TYPEresult_full"><span class="keyword">type</span> <code class="type">('path, 'result)</code> result_full</span> = <code class="type">'path * 'result * <a href="OUnitLogger.html#TYPEposition">position</a> option</code> </pre>
<pre><code><span id="TYPEglobal_event"><span class="keyword">type</span> <code class="type">('path, 'result)</code> global_event</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTglobal_event.GConf"><span class="constructor">GConf</span></span> <span class="keyword">of</span> <code class="type">string * string</code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Dump a configuration options.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTglobal_event.GLog"><span class="constructor">GLog</span></span> <span class="keyword">of</span> <code class="type"><a href="OUnitLogger.html#TYPElog_severity">log_severity</a> * string</code></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTglobal_event.GStart"><span class="constructor">GStart</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Start running the tests.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTglobal_event.GEnd"><span class="constructor">GEnd</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Finish running the tests.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTglobal_event.GResults"><span class="constructor">GResults</span></span> <span class="keyword">of</span> <code class="type">(float * ('path, 'result) <a href="OUnitLogger.html#TYPEresult_full">result_full</a> list * int)</code></code></td>
</tr></table>
<div class="info ">
Events which occur at the global level.<br>
</div>
<pre><code><span id="TYPElog_event_t"><span class="keyword">type</span> <code class="type">('path, 'result)</code> log_event_t</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTlog_event_t.GlobalEvent"><span class="constructor">GlobalEvent</span></span> <span class="keyword">of</span> <code class="type">('path, 'result) <a href="OUnitLogger.html#TYPEglobal_event">global_event</a></code></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTlog_event_t.TestEvent"><span class="constructor">TestEvent</span></span> <span class="keyword">of</span> <code class="type">'path * 'result <a href="OUnitLogger.html#TYPEtest_event">test_event</a></code></code></td>
</tr></table>
<pre><code><span id="TYPElog_event"><span class="keyword">type</span> <code class="type">('path, 'result)</code> log_event</span> = {</code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTlog_event.shard">shard</span> : <code class="type">string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTlog_event.timestamp">timestamp</span> : <code class="type">float</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTlog_event.event">event</span> : <code class="type">('path, 'result) <a href="OUnitLogger.html#TYPElog_event_t">log_event_t</a></code>;</code></td>
</tr></table>
}
<pre><code><span id="TYPElogger"><span class="keyword">type</span> <code class="type">('path, 'result)</code> logger</span> = {</code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTlogger.lshard">lshard</span> : <code class="type">string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTlogger.fwrite">fwrite</span> : <code class="type">('path, 'result) <a href="OUnitLogger.html#TYPElog_event">log_event</a> -> unit</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTlogger.fpos">fpos</span> : <code class="type">unit -> <a href="OUnitLogger.html#TYPEposition">position</a> option</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTlogger.fclose">fclose</span> : <code class="type">unit -> unit</code>;</code></td>
</tr></table>
}
<pre><span id="VALshard_default"><span class="keyword">val</span> shard_default</span> : <code class="type">string</code></pre>
<pre><span id="VALstring_of_event"><span class="keyword">val</span> string_of_event</span> : <code class="type">('a, 'b) <a href="OUnitLogger.html#TYPElog_event_t">log_event_t</a> -> string</code></pre>
<pre><span id="VALnull_logger"><span class="keyword">val</span> null_logger</span> : <code class="type">('a, 'b) <a href="OUnitLogger.html#TYPElogger">logger</a></code></pre>
<pre><span id="VALfun_logger"><span class="keyword">val</span> fun_logger</span> : <code class="type">(('a, 'b) <a href="OUnitLogger.html#TYPElog_event">log_event</a> -> unit) -><br> (unit -> unit) -> ('a, 'b) <a href="OUnitLogger.html#TYPElogger">logger</a></code></pre>
<pre><span id="VALpost_logger"><span class="keyword">val</span> post_logger</span> : <code class="type">(('a, 'b) <a href="OUnitLogger.html#TYPElog_event">log_event</a> list -> unit) -> ('a, 'b) <a href="OUnitLogger.html#TYPElogger">logger</a></code></pre>
<pre><span id="VALset_shard"><span class="keyword">val</span> set_shard</span> : <code class="type">string -> ('a, 'b) <a href="OUnitLogger.html#TYPElogger">logger</a> -> ('a, 'b) <a href="OUnitLogger.html#TYPElogger">logger</a></code></pre>
<pre><span id="VALreport"><span class="keyword">val</span> report</span> : <code class="type">('a, 'b) <a href="OUnitLogger.html#TYPElogger">logger</a> -> ('a, 'b) <a href="OUnitLogger.html#TYPElog_event_t">log_event_t</a> -> unit</code></pre>
<pre><span id="VALinfof"><span class="keyword">val</span> infof</span> : <code class="type">('a, 'b) <a href="OUnitLogger.html#TYPElogger">logger</a> -><br> ('c, unit, string, unit) Pervasives.format4 -> 'c</code></pre>
<pre><span id="VALwarningf"><span class="keyword">val</span> warningf</span> : <code class="type">('a, 'b) <a href="OUnitLogger.html#TYPElogger">logger</a> -><br> ('c, unit, string, unit) Pervasives.format4 -> 'c</code></pre>
<pre><span id="VALerrorf"><span class="keyword">val</span> errorf</span> : <code class="type">('a, 'b) <a href="OUnitLogger.html#TYPElogger">logger</a> -><br> ('c, unit, string, unit) Pervasives.format4 -> 'c</code></pre>
<pre><span id="VALposition"><span class="keyword">val</span> position</span> : <code class="type">('a, 'b) <a href="OUnitLogger.html#TYPElogger">logger</a> -> <a href="OUnitLogger.html#TYPEposition">position</a> option</code></pre>
<pre><span id="VALclose"><span class="keyword">val</span> close</span> : <code class="type">('a, 'b) <a href="OUnitLogger.html#TYPElogger">logger</a> -> unit</code></pre>
<pre><span id="VALcombine"><span class="keyword">val</span> combine</span> : <code class="type">('a, 'b) <a href="OUnitLogger.html#TYPElogger">logger</a> list -> ('a, 'b) <a href="OUnitLogger.html#TYPElogger">logger</a></code></pre>
<pre><span class="keyword">module</span> <a href="OUnitLogger.Test.html">Test</a>: <code class="code"><span class="keyword">sig</span></code> <a href="OUnitLogger.Test.html">..</a> <code class="code"><span class="keyword">end</span></code></pre></body></html>
