pghs975uc
/
infer_clone
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '56fd330760'
${ noResults }
infer_clone/website/static/odoc/next/infer/Backend/ProcLocker/index.html

2 lines
2.5 KiB
Raw Normal View History Unescape

[website] docs for current master Summary: Run `make doc-publish` and adjust links in website/docs/04-internal-API.md to point to odoc/next/infer/infer.html as the starting point of the docs has changed (was: odoc/index.html but now this also contains dead links to sledge and ppx_trace... also infer.mld is a me-written exposé of the various libraries and index.mld is an auto-generated list of all the modules now). Reviewed By: ngorogiannis Differential Revision: D21552864 fbshipit-source-id: c3977f645
5 years ago
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>ProcLocker (infer.Backend.ProcLocker)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">infer</a> &#x00BB; <a href="../index.html">Backend</a> &#x00BB; ProcLocker</nav><h1>Module <code>Backend.ProcLocker</code></h1></header><dl><dt class="spec exception" id="exception-UnlockNotLocked"><a href="#exception-UnlockNotLocked" class="anchor"></a><code><span class="keyword">exception</span> </code><code><span class="exception">UnlockNotLocked</span> <span class="keyword">of</span> <a href="../../IR/Procname/index.html#type-t">IR.Procname.t</a></code></dt></dl><dl><dt class="spec value" id="val-setup"><a href="#val-setup" class="anchor"></a><code><span class="keyword">val</span> setup : unit <span>&#45;&gt;</span> unit</code></dt><dd><p>This should be called once before trying to lock Anything.</p></dd></dl><dl><dt class="spec value" id="val-try_lock"><a href="#val-try_lock" class="anchor"></a><code><span class="keyword">val</span> try_lock : <a href="../../IR/Procname/index.html#type-t">IR.Procname.t</a> <span>&#45;&gt;</span> bool</code></dt><dd><p>true = the lock belongs to the calling process. false = the lock belongs to a different worker</p></dd></dl><dl><dt class="spec value" id="val-unlock"><a href="#val-unlock" class="anchor"></a><code><span class="keyword">val</span> unlock : <a href="../../IR/Procname/index.html#type-t">IR.Procname.t</a> <span>&#45;&gt;</span> unit</code></dt><dd><p>This will work as a cleanup function because after calling unlock all the workers that need an unlocked Proc should find it's summary already Cached. Throws if the lock had not been taken.</p></dd></dl><dl><dt class="spec value" id="val-clean"><a href="#val-clean" class="anchor"></a><code><span class="keyword">val</span> clean : unit <span>&#45;&gt;</span> unit</code></dt><dd><p>This should be called when locks will no longer be used to remove any files or state that's not necessary.</p></dd></dl><dl><dt class="spec value" id="val-is_locked"><a href="#val-is_locked" class="anchor"></a><code><span class="keyword">val</span> is_locked : <a href="../../IR/Procname/index.html#type-t">IR.Procname.t</a> <span>&#45;&gt;</span> bool</code></dt></dl></div></body></html>