UNPKG

14.2 kBHTMLView Raw
1<!DOCTYPE html> <html> <head> <title>LogUtil.coffee</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <div id="jump_to"> Jump To &hellip; <div id="jump_wrapper"> <div id="jump_page"> <a class="source" href="ByteIterable.html"> ByteIterable.coffee </a> <a class="source" href="ByteIterator.html"> ByteIterator.coffee </a> <a class="source" href="ArrayByteIterable.html"> ArrayByteIterable.coffee </a> <a class="source" href="ByteIterableBase.html"> ByteIterableBase.coffee </a> <a class="source" href="ByteIterableUtil.html"> ByteIterableUtil.coffee </a> <a class="source" href="LightOutputStream.html"> LightOutputStream.coffee </a> <a class="source" href="StoreConfiguration.html"> StoreConfiguration.coffee </a> <a class="source" href="Reader.html"> Reader.coffee </a> <a class="source" href="Writer.html"> Writer.coffee </a> <a class="source" href="List.html"> List.coffee </a> <a class="source" href="ListNode.html"> ListNode.coffee </a> <a class="source" href="Cursor.html"> Cursor.coffee </a> <a class="source" href="DatabaseRoot.html"> DatabaseRoot.coffee </a> <a class="source" href="Environment.html"> Environment.coffee </a> <a class="source" href="EnvironmentConfig.html"> EnvironmentConfig.coffee </a> <a class="source" href="Store.html"> Store.coffee </a> <a class="source" href="Transaction.html"> Transaction.coffee </a> <a class="source" href="Addr64.html"> Addr64.coffee </a> <a class="source" href="DataIterator.html"> DataIterator.coffee </a> <a class="source" href="Log.html"> Log.coffee </a> <a class="source" href="LogCache.html"> LogCache.coffee </a> <a class="source" href="LogConfig.html"> LogConfig.coffee </a> <a class="source" href="LogUtil.html"> LogUtil.coffee </a> <a class="source" href="Loggable.html"> Loggable.coffee </a> <a class="source" href="LoggableFactory.html"> LoggableFactory.coffee </a> <a class="source" href="LoggableIterator.html"> LoggableIterator.coffee </a> <a class="source" href="LoggableToWrite.html"> LoggableToWrite.coffee </a> <a class="source" href="NullLoggable.html"> NullLoggable.coffee </a> <a class="source" href="RandomAccessByteIterable.html"> RandomAccessByteIterable.coffee </a> <a class="source" href="RandomAccessLoggable.html"> RandomAccessLoggable.coffee </a> <a class="source" href="RandomAccessLoggableIterator.html"> RandomAccessLoggableIterator.coffee </a> <a class="source" href="StackList.html"> StackList.coffee </a> <a class="source" href="CompoundByteIterable.html"> CompoundByteIterable.coffee </a> <a class="source" href="CompoundByteIteratorBase.html"> CompoundByteIteratorBase.coffee </a> <a class="source" href="CompressedUnsignedLongByteIterable.html"> CompressedUnsignedLongByteIterable.coffee </a> <a class="source" href="FixedLengthByteIterable.html"> FixedLengthByteIterable.coffee </a> </div> </div> </div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> LogUtil.coffee </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">&#182;</a> </div> </td> <td class="code"> <div class="highlight"><pre><span class="nv">fs = </span><span class="nx">require</span> <span class="s1">&#39;fs&#39;</span>
2<span class="nv">Addr64 = </span><span class="p">(</span><span class="nx">require</span> <span class="s1">&#39;./Addr64.coffee&#39;</span><span class="p">).</span><span class="nx">Addr64</span></pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">&#182;</a> </div> <p>This class contains simple util functions, e.g. converting address to filename
3and vice versa.</p> </td> <td class="code"> <div class="highlight"><pre><span class="k">class</span> <span class="nx">LogUtil</span>
4 <span class="vi">@LOG_BLOCK_ALIGNMENT: </span><span class="mi">1024</span> <span class="c1"># log files are aligned by kilobytes</span>
5 <span class="vi">@LOG_FILE_NAME_WITH_EXT_LENGTH: </span><span class="mi">14</span>
6 <span class="vi">@LOG_FILE_NAME_LENGTH: </span><span class="mi">11</span>
7 <span class="vi">@LOG_FILE_EXTENSION: </span><span class="s2">&quot;.xd&quot;</span>
8 <span class="vi">@LOG_NAME_BASE: </span><span class="mi">32</span></pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">&#182;</a> </div> <p>Generates file name (without directory) from address.</p>
9
10<p>@param address Addr64 object
11@return filename</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">@getLogFilename</span><span class="nv">$Addr64: </span><span class="nf">(address) -&gt;</span>
12 <span class="nv">fn = </span><span class="nx">Addr64</span><span class="p">.</span><span class="nx">addr64ToString$Addr64$int</span> <span class="nx">address</span><span class="p">,</span> <span class="nx">@LOG_NAME_BASE</span>
13 <span class="nv">fn = </span><span class="nx">fn</span><span class="p">.</span><span class="nx">substr</span> <span class="mi">0</span><span class="p">,</span> <span class="nx">@LOG_FILE_NAME_LENGTH</span>
14 <span class="nv">fn = </span><span class="nx">fn</span> <span class="o">+</span> <span class="nx">@LOG_FILE_EXTENSION</span>
15 <span class="k">return</span> <span class="nx">fn</span></pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">&#182;</a> </div> <p>Gets address from log filename.</p>
16
17<p>@param logFileName name of log file (without directory).
18@return address of beginning of this file.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">@getAddress</span><span class="nv">$String: </span><span class="nf">(logFilename) -&gt;</span>
19 <span class="nv">logFilename = </span><span class="nx">logFilename</span><span class="p">.</span><span class="nx">substr</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="nx">@LOG_FILE_NAME_LENGTH</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot;00&quot;</span> <span class="o">+</span>
20 <span class="nx">@LOG_FILE_EXTENSION</span>
21 <span class="nv">addr = </span><span class="p">(</span><span class="nx">Addr64</span><span class="p">.</span><span class="nx">stringToAddr64$String$int</span> <span class="nx">logFilename</span><span class="p">,</span> <span class="nx">@LOG_NAME_BASE</span><span class="p">)</span>
22 <span class="k">return</span> <span class="nx">addr</span></pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">&#182;</a> </div> <p>Gets list of files in directory.</p>
23
24<p>@param directory the place where log is proposed to be.
25@return list of only log files in this directory.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">@listFiles</span><span class="nv">$String: </span><span class="nf">(directory) -&gt;</span>
26 <span class="k">try</span>
27 <span class="nx">fs</span><span class="p">.</span><span class="nx">mkdirSync</span> <span class="nx">directory</span><span class="p">,</span> <span class="s1">&#39;0777&#39;</span>
28 <span class="k">catch</span> <span class="nx">e</span>
29 <span class="nv">rawFiles = </span><span class="nx">fs</span><span class="p">.</span><span class="nx">readdirSync</span> <span class="nx">directory</span>
30 <span class="nv">files = </span><span class="nx">rawFiles</span><span class="p">.</span><span class="nx">filter</span> <span class="p">(</span><span class="nx">element</span><span class="p">,</span> <span class="nx">index</span><span class="p">,</span> <span class="nx">array</span><span class="p">)</span> <span class="o">=&gt;</span>
31 <span class="k">return</span> <span class="nx">element</span><span class="p">.</span><span class="nx">indexOf</span><span class="p">(</span><span class="nx">@LOG_FILE_EXTENSION</span><span class="p">)</span> <span class="o">!=</span> <span class="o">-</span><span class="mi">1</span>
32 <span class="k">return</span> <span class="nx">files</span></pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">&#182;</a> </div> <p>Gets high address in the current directory (i.e. the address of the end
33of the log).</p>
34
35<p>@param directory the place where log is proposed to be.
36@return address.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">@getHighAddress</span><span class="nv">$String: </span><span class="nf">(directory) -&gt;</span>
37 <span class="nv">files = </span><span class="nx">@listFiles$String</span> <span class="nx">directory</span>
38 <span class="k">if</span> <span class="nx">files</span><span class="p">.</span><span class="nx">length</span> <span class="o">!=</span> <span class="mi">0</span>
39 <span class="nx">files</span><span class="p">.</span><span class="nx">sort</span><span class="p">()</span>
40 <span class="nv">lastFile = </span><span class="nx">files</span><span class="p">[</span><span class="nx">files</span><span class="p">.</span><span class="nx">length</span> <span class="o">-</span> <span class="mi">1</span><span class="p">]</span>
41 <span class="nv">stats = </span><span class="nx">fs</span><span class="p">.</span><span class="nx">statSync</span> <span class="nx">directory</span> <span class="o">+</span> <span class="nx">lastFile</span>
42 <span class="nv">addr = </span><span class="p">(</span><span class="nx">LogUtil</span><span class="p">.</span><span class="nx">getAddress$String</span> <span class="nx">lastFile</span><span class="p">).</span><span class="nx">plus$int</span><span class="p">(</span><span class="nx">stats</span><span class="p">.</span><span class="nx">size</span><span class="p">)</span>
43 <span class="k">else</span>
44 <span class="nv">addr = </span><span class="nx">Addr64</span><span class="p">.</span><span class="nx">create$int$int</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span>
45 <span class="k">return</span> <span class="nx">addr</span>
46
47<span class="nv">exports.LogUtil = </span><span class="nx">LogUtil</span>
48
49</pre></div> </td> </tr> </tbody> </table> </div> </body> </html>
\No newline at end of file