UNPKG

22.6 kBHTMLView Raw
1<!DOCTYPE html> <html> <head> <title>LogConfig.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> LogConfig.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">Reader = </span><span class="nx">require</span><span class="p">(</span><span class="s1">&#39;../io/Reader.coffee&#39;</span><span class="p">).</span><span class="nx">Reader</span>
3<span class="nv">Writer = </span><span class="nx">require</span><span class="p">(</span><span class="s1">&#39;../io/Writer.coffee&#39;</span><span class="p">).</span><span class="nx">Writer</span>
4<span class="nv">LogCache = </span><span class="nx">require</span><span class="p">(</span><span class="s1">&#39;./LogCache.coffee&#39;</span><span class="p">).</span><span class="nx">LogCache</span>
5<span class="nv">IOUtil = </span><span class="nx">require</span><span class="p">(</span><span class="s1">&#39;../util/IOUtil.coffee&#39;</span><span class="p">).</span><span class="nx">IOUtil</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 all the information about log.</p> </td> <td class="code"> <div class="highlight"><pre><span class="k">class</span> <span class="nx">LogConfig</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>@private</p> </td> <td class="code"> <div class="highlight"><pre> <span class="vi">@DEFAULT_FILE_SIZE: </span><span class="mi">1024</span> <span class="c1"># in kilobytes</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>@private</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">dir: </span><span class="kc">undefined</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>@private</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">fileSize: </span><span class="kc">undefined</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>@private</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">lockTimeout: </span><span class="kc">undefined</span></pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-7">&#182;</a> </div> <p>@private</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">memoryUsage: </span><span class="kc">undefined</span></pre></div> </td> </tr> <tr id="section-8"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-8">&#182;</a> </div> <p>@private</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">memoryUsagePercentage: </span><span class="kc">undefined</span></pre></div> </td> </tr> <tr id="section-9"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-9">&#182;</a> </div> <p>@private</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">reader: </span><span class="kc">undefined</span></pre></div> </td> </tr> <tr id="section-10"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-10">&#182;</a> </div> <p>@private</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">writer: </span><span class="kc">undefined</span></pre></div> </td> </tr> <tr id="section-11"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-11">&#182;</a> </div> <p>@private</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">isDurableWrite: </span><span class="kc">undefined</span></pre></div> </td> </tr> <tr id="section-12"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-12">&#182;</a> </div> <p>@private</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">sharedCache: </span><span class="kc">undefined</span></pre></div> </td> </tr> <tr id="section-13"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-13">&#182;</a> </div> <p>@private</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">nonBlockingCache: </span><span class="kc">undefined</span></pre></div> </td> </tr> <tr id="section-14"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-14">&#182;</a> </div> <p>@private</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">cachePageSize: </span><span class="kc">undefined</span></pre></div> </td> </tr> <tr id="section-15"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-15">&#182;</a> </div> <p>@private</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">cacheOpenFilesCount: </span><span class="kc">undefined</span></pre></div> </td> </tr> <tr id="section-16"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-16">&#182;</a> </div> <p>@private</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">writeBufferSize: </span><span class="kc">undefined</span></pre></div> </td> </tr> <tr id="section-17"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-17">&#182;</a> </div> <p>@private</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">cleanDirectoryExpected: </span><span class="kc">undefined</span>
6
7 <span class="vi">@create: </span><span class="nf">() -&gt;</span>
8 <span class="nv">o = </span><span class="k">new</span> <span class="nx">LogConfig</span>
9 <span class="k">return</span> <span class="nx">o</span>
10
11 <span class="nv">getDir: </span><span class="nf">() -&gt;</span>
12 <span class="k">return</span> <span class="nx">@dir</span>
13
14 <span class="nv">setDir: </span><span class="nf">(dir) -&gt;</span>
15 <span class="vi">@dir = </span><span class="nx">dir</span>
16
17 <span class="nv">getFileSize: </span><span class="nf">() -&gt;</span>
18 <span class="k">if</span> <span class="nx">@fileSize</span> <span class="o">==</span> <span class="mi">0</span>
19 <span class="vi">@fileSize = </span><span class="nx">@DEFAULT_FILE_SIZE</span>
20 <span class="k">return</span> <span class="nx">@fileSize</span>
21
22 <span class="nv">setFileSize: </span><span class="nf">(fileSize) -&gt;</span>
23 <span class="vi">@fileSize = </span><span class="nx">fileSize</span>
24
25 <span class="nv">getLockTimeout: </span><span class="p">()</span> <span class="o">=&gt;</span>
26 <span class="k">return</span> <span class="nx">@lockTimeout</span>
27
28 <span class="nv">setLockTimeout: </span><span class="nf">(lockTimeout) -&gt;</span>
29 <span class="vi">@lockTimeout = </span><span class="nx">lockTimeout</span>
30
31 <span class="nv">getMemoryUsage: </span><span class="nf">() -&gt;</span>
32 <span class="k">return</span> <span class="nx">@memoryUsage</span>
33
34 <span class="nv">setMemoryUsage: </span><span class="nf">(memUsage) -&gt;</span>
35 <span class="vi">@memoryUsage = </span><span class="nx">memUsage</span>
36
37 <span class="nv">getMemoryUsagePercentage: </span><span class="nf">() -&gt;</span>
38 <span class="k">if</span> <span class="o">!</span><span class="nx">@memoryUsagePercentage</span><span class="o">?</span>
39 <span class="vi">@memoryUsagePercentage = </span><span class="mi">50</span>
40 <span class="k">return</span> <span class="nx">@memoryUsagePercentage</span>
41
42 <span class="nv">setMemoryUsagePercentage: </span><span class="nf">(memoryUsagePercentage) -&gt;</span>
43 <span class="vi">@memoryUsagePercentage = </span><span class="nx">memoryUsagePercentage</span>
44
45 <span class="nv">getReader: </span><span class="nf">() -&gt;</span>
46 <span class="k">if</span> <span class="o">!</span><span class="nx">@reader</span><span class="o">?</span>
47 <span class="vi">@reader = </span><span class="nx">Reader</span><span class="p">.</span><span class="nx">create$String$int$int$int</span> <span class="nx">@checkDirectory$String</span><span class="p">(</span><span class="nx">@dir</span><span class="p">),</span>
48 <span class="nx">@getFileSize</span><span class="p">(),</span> <span class="nx">@getCachePageSize</span><span class="p">(),</span> <span class="nx">@getCacheOpenFilesCount</span><span class="p">()</span>
49 <span class="k">return</span> <span class="nx">@reader</span>
50
51 <span class="nv">setReader: </span><span class="nf">(reader) -&gt;</span>
52 <span class="vi">@reader = </span><span class="nx">reader</span>
53
54 <span class="nv">getWriter: </span><span class="nf">() -&gt;</span>
55 <span class="k">if</span> <span class="o">!</span><span class="nx">@writer</span><span class="o">?</span>
56 <span class="vi">@writer = </span><span class="nx">Writer</span><span class="p">.</span><span class="nx">create$String$int</span> <span class="nx">@checkDirectory$String</span><span class="p">(</span><span class="nx">@dir</span><span class="p">),</span> <span class="nx">@getFileSize</span><span class="p">()</span>
57 <span class="k">return</span> <span class="nx">@writer</span>
58
59 <span class="nv">setWriter: </span><span class="nf">(writer) -&gt;</span>
60 <span class="vi">@writer = </span><span class="nx">writer</span>
61
62 <span class="nv">isDurableWrite: </span><span class="nf">() -&gt;</span>
63 <span class="k">return</span> <span class="nx">@isDurableWrite</span>
64
65 <span class="nv">setDurableWrite: </span><span class="nf">(durableWrite) -&gt;</span>
66 <span class="vi">@isDurableWrite = </span><span class="nx">durableWrite</span>
67
68 <span class="nv">isSharedCache: </span><span class="nf">() -&gt;</span>
69 <span class="k">return</span> <span class="nx">@sharedCache</span>
70
71 <span class="nv">setSharedCache: </span><span class="nf">(sharedCache) -&gt;</span>
72 <span class="vi">@sharedCache = </span><span class="nx">sharedCache</span>
73
74 <span class="nv">isNonBlockingCache: </span><span class="nf">() -&gt;</span>
75 <span class="nx">@nonBlockingCache</span>
76
77 <span class="nv">setNonBlockingCache: </span><span class="nf">(nonBlockingCache) -&gt;</span>
78 <span class="vi">@nonBlockingCache = </span><span class="nx">nonBlockingCache</span>
79
80 <span class="nv">getCachePageSize: </span><span class="nf">() -&gt;</span>
81 <span class="k">if</span> <span class="o">!</span><span class="nx">@cachePageSize</span><span class="o">?</span>
82 <span class="vi">@cachePageSize = </span><span class="nx">LogCache</span><span class="p">.</span><span class="nx">MINIMUM_PAGE_SIZE</span>
83 <span class="k">return</span> <span class="nx">@cachePageSize</span>
84
85 <span class="nv">setCachePageSize: </span><span class="nf">(cachePageSize) -&gt;</span>
86 <span class="vi">@cachePageSize = </span><span class="nx">cachePageSize</span>
87
88 <span class="nv">getCacheOpenFilesCount: </span><span class="nf">() -&gt;</span>
89 <span class="k">if</span> <span class="o">!</span><span class="nx">@cacheOpenFilesCount</span><span class="o">?</span>
90 <span class="vi">@cacheOpenFilesCount = </span><span class="nx">LogCache</span><span class="p">.</span><span class="nx">DEFAULT_OPEN_FILES_COUNT</span>
91 <span class="k">return</span> <span class="nx">@cacheOpenFilesCount</span>
92
93 <span class="nv">setCacheOpenFilesCount: </span><span class="nf">(cacheOpenFilesCount) -&gt;</span>
94 <span class="vi">@cacheOpenFilesCount = </span><span class="nx">cacheOpenFilesCount</span>
95
96 <span class="nv">getWriteBufferSize: </span><span class="nf">() -&gt;</span>
97 <span class="k">if</span> <span class="p">(</span><span class="nx">@writeBufferSize</span> <span class="o">==</span> <span class="mi">0</span><span class="p">)</span>
98 <span class="vi">@writeBufferSize = </span><span class="mi">1</span>
99 <span class="k">return</span> <span class="nx">@writeBufferSize</span>
100
101 <span class="nv">setWriteBufferSize: </span><span class="nf">(pagesCount) -&gt;</span>
102 <span class="vi">@writeBufferSize = </span><span class="nx">pagesCount</span>
103
104 <span class="nv">isCleanDirectoryExpected: </span><span class="nf">() -&gt;</span>
105 <span class="k">return</span> <span class="nx">@cleanDirectoryExpected</span>
106
107 <span class="nv">setCleanDirectoryExpected: </span><span class="nf">(cleanDirectoryExpected) -&gt;</span>
108 <span class="vi">@cleanDirectoryExpected = </span><span class="nx">cleanDirectoryExpected</span></pre></div> </td> </tr> <tr id="section-18"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-18">&#182;</a> </div> <p>@private
109Checks whether the directory is valid.</p>
110
111<p>@param directory the full path to the directory
112@return updated path</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">checkDirectory</span><span class="nv">$String: </span><span class="nf">(directory) -&gt;</span>
113 <span class="k">if</span> <span class="nx">directory</span><span class="p">[</span><span class="nx">directory</span><span class="p">.</span><span class="nx">length</span> <span class="o">-</span> <span class="mi">1</span><span class="p">]</span> <span class="o">!=</span> <span class="s1">&#39;/&#39;</span>
114 <span class="nx">directory</span> <span class="o">+=</span> <span class="s1">&#39;/&#39;</span>
115 <span class="nx">IOUtil</span><span class="p">.</span><span class="nx">makeDirectory$String</span> <span class="nx">directory</span>
116 <span class="k">return</span> <span class="nx">directory</span>
117
118<span class="nv">exports.LogConfig = </span><span class="nx">LogConfig</span>
119
120</pre></div> </td> </tr> </tbody> </table> </div> </body> </html>
\No newline at end of file