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.

2 lines
2.5 KiB

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Backend__ProcLocker (infer.Backend__ProcLocker)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.1"/><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; Backend__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 : <span>proc_filename:string</span> <span>&#45;&gt;</span> bool</code></dt></dl></div></body></html>