status-im
/
nim-chronos
mirror of https://github.com/status-im/nim-chronos.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
nim-chronos/api/chronos/debugutils.html

275 lines
50 KiB
HTML
Raw Permalink Normal View History

deploy: 03f4328de6135a06830103fdfd1d0aeb9bc8a1c8
2024-11-28 08:22:47 +00:00
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- This file is generated by Nim. -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- Favicon -->
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
<link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
<!-- Google fonts -->
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
<!-- CSS -->
<title>chronos/debugutils</title>
<link rel="stylesheet" type="text/css" href="../nimdoc.out.css">
<script type="text/javascript" src="../dochack.js"></script>
<script type="text/javascript">
function main() {
var pragmaDots = document.getElementsByClassName("pragmadots");
for (var i = 0; i < pragmaDots.length; i++) {
pragmaDots[i].onclick = function(event) {
// Hide tease
event.target.parentNode.style.display = "none";
// Show actual
event.target.parentNode.nextElementSibling.style.display = "inline";
}
}
function switchTheme(e) {
if (e.target.checked) {
document.documentElement.setAttribute('data-theme', 'dark');
localStorage.setItem('theme', 'dark');
} else {
document.documentElement.setAttribute('data-theme', 'light');
localStorage.setItem('theme', 'light');
}
}
const toggleSwitch = document.querySelector('.theme-switch input[type="checkbox"]');
if (toggleSwitch !== null) {
toggleSwitch.addEventListener('change', switchTheme, false);
}
var currentTheme = localStorage.getItem('theme');
if (!currentTheme && window.matchMedia('(prefers-color-scheme: dark)').matches) {
currentTheme = 'dark';
}
if (currentTheme) {
document.documentElement.setAttribute('data-theme', currentTheme);
if (currentTheme === 'dark' && toggleSwitch !== null) {
toggleSwitch.checked = true;
}
}
}
window.addEventListener('DOMContentLoaded', main);
</script>
</head>
<body>
<div class="document" id="documentId">
<div class="container">
<h1 class="title">chronos/debugutils</h1>
<div class="row">
<div class="three columns">
<div class="theme-switch-wrapper">
<label class="theme-switch" for="checkbox">
<input type="checkbox" id="checkbox" />
<div class="slider round"></div>
</label>
&nbsp;&nbsp;&nbsp; <em>Dark Mode</em>
</div>
<div id="global-links">
<ul class="simple">
<li>
<a href="../theindex.html">Index</a>
</li>
</ul>
</div>
<div id="searchInputDiv">
Search: <input type="text" id="searchInput"
onkeyup="search()" />
</div>
<div>
Group by:
<select onchange="groupBy(this.value)">
<option value="section">Section</option>
<option value="type">Type</option>
</select>
</div>
<ul class="simple simple-toc" id="toc-list">
<li>
<a class="reference reference-toplevel" href="#6" id="56">Imports</a>
<ul class="simple simple-toc-section">
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#10" id="60">Consts</a>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#AllFutureStates"
title="AllFutureStates = {FutureState.Pending, FutureState.Cancelled,
FutureState.Completed, FutureState.Failed}">AllFutureStates</a></li>
<li><a class="reference" href="#OnlyCompleted"
title="OnlyCompleted = {FutureState.Completed}">OnlyCompleted</a></li>
<li><a class="reference" href="#OnlyPending"
title="OnlyPending = {FutureState.Pending}">OnlyPending</a></li>
<li><a class="reference" href="#WithoutCompleted"
title="WithoutCompleted = {FutureState.Pending, FutureState.Cancelled,
FutureState.Failed}">WithoutCompleted</a></li>
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#12" id="62">Procs</a>
<ul class="simple simple-toc-section">
<ul class="simple nested-toc-section">dumpPendingFutures
<li><a class="reference" href="#dumpPendingFutures"
title="dumpPendingFutures(filter = AllFutureStates): string">dumpPendingFutures(filter = AllFutureStates): string</a></li>
</ul>
<ul class="simple nested-toc-section">pendingFuturesCount
<li><a class="reference" href="#pendingFuturesCount%2Cset%5BFutureState%5D"
title="pendingFuturesCount(filter: set[FutureState]): uint">pendingFuturesCount(filter: set[FutureState]): uint</a></li>
</ul>
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#19" id="69">Exports</a>
<ul class="simple simple-toc-section">
</ul>
</li>
</ul>
</div>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/debugutils.nim#L1"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/debugutils.nim#L1" class="link-seesrc" target="_blank" >Edit</a>
<div class="nine columns" id="content">
<div id="tocRoot"></div>
<p class="module-desc"></p>
<div class="section" id="6">
<h1><a class="toc-backref" href="#6">Imports</a></h1>
<dl class="item">
<a class="reference external" href="asyncloop.html">asyncloop</a>, <a class="reference external" href="config.html">config</a>
</dl></div>
<div class="section" id="10">
<h1><a class="toc-backref" href="#10">Consts</a></h1>
<dl class="item">
<div id="AllFutureStates">
<dt><pre><a href="debugutils.html#AllFutureStates"><span class="Identifier">AllFutureStates</span></a> <span class="Other">=</span> <span class="Other">{</span><span class="DecNumber">FutureState.Pending</span><span class="Other">,</span> <span class="DecNumber">FutureState.Cancelled</span><span class="Other">,</span>
<span class="DecNumber">FutureState.Completed</span><span class="Other">,</span> <span class="DecNumber">FutureState.Failed</span><span class="Other">}</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/debugutils.nim#L19"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/debugutils.nim#L19" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="OnlyCompleted">
<dt><pre><a href="debugutils.html#OnlyCompleted"><span class="Identifier">OnlyCompleted</span></a> <span class="Other">=</span> <span class="Other">{</span><span class="DecNumber">FutureState.Completed</span><span class="Other">}</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/debugutils.nim#L24"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/debugutils.nim#L24" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="OnlyPending">
<dt><pre><a href="debugutils.html#OnlyPending"><span class="Identifier">OnlyPending</span></a> <span class="Other">=</span> <span class="Other">{</span><span class="DecNumber">FutureState.Pending</span><span class="Other">}</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/debugutils.nim#L23"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/debugutils.nim#L23" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="WithoutCompleted">
<dt><pre><a href="debugutils.html#WithoutCompleted"><span class="Identifier">WithoutCompleted</span></a> <span class="Other">=</span> <span class="Other">{</span><span class="DecNumber">FutureState.Pending</span><span class="Other">,</span> <span class="DecNumber">FutureState.Cancelled</span><span class="Other">,</span>
<span class="DecNumber">FutureState.Failed</span><span class="Other">}</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/debugutils.nim#L21"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/debugutils.nim#L21" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
</dl></div>
<div class="section" id="12">
<h1><a class="toc-backref" href="#12">Procs</a></h1>
<dl class="item">
<div id="dumpPendingFutures">
<dt><pre><span class="Keyword">proc</span> <a href="#dumpPendingFutures"><span class="Identifier">dumpPendingFutures</span></a><span class="Other">(</span><span class="Identifier">filter</span> <span class="Other">=</span> <span class="Identifier">AllFutureStates</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
<p>Dump all <tt class="docutils literal"><span class="pre"><span class="Identifier">pending</span></span></tt> Future[T] objects.</p>
<p>This list will contain:</p>
<ol class="simple"><li>Future[T] objects with <tt class="docutils literal"><span class="pre">FutureState.Pending</span></tt> state (this Futures are not yet finished).</li>
<li>Future[T] objects with <tt class="docutils literal"><span class="pre">FutureState.Finished/Cancelled/Failed</span></tt> state which callbacks are scheduled, but not yet fully processed.</li>
</ol>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/debugutils.nim#L26"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/debugutils.nim#L26" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="pendingFuturesCount,set[FutureState]">
<dt><pre><span class="Keyword">proc</span> <a href="#pendingFuturesCount%2Cset%5BFutureState%5D"><span class="Identifier">pendingFuturesCount</span></a><span class="Other">(</span><span class="Identifier">filter</span><span class="Other">:</span> <span class="Identifier">set</span><span class="Other">[</span><a href="futures.html#FutureState"><span class="Identifier">FutureState</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">uint</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
<p>Returns number of <tt class="docutils literal"><span class="pre"><span class="Identifier">pending</span></span></tt> Future[T] objects which satisfy the <tt class="docutils literal"><span class="pre">filter</span></tt> condition.</p>
<p>If <tt class="docutils literal"><span class="pre">filter</span></tt> is equal to <tt class="docutils literal"><span class="pre">AllFutureStates</span></tt> Operation's complexity is O(1), otherwise operation's complexity is O(n).</p>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/debugutils.nim#L56"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/debugutils.nim#L56" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
</dl></div>
<div class="section" id="19">
<h1><a class="toc-backref" href="#19">Exports</a></h1>
<dl class="item">
<a href="internal/asyncengine.html#setThreadDispatcher,PDispatcher"><span class="Identifier">setThreadDispatcher</span></a>, <a href="internal/asyncengine.html#closeSocket,AsyncFD,CallbackFunc"><span class="Identifier">closeSocket</span></a>, <a href="oserrno.html#ENOSR"><span class="Identifier">ENOSR</span></a>, <a href="oserrno.html#EHOSTUNREACH"><span class="Identifier">EHOSTUNREACH</span></a>, <a href="oserrno.html#EHOSTDOWN"><span class="Identifier">EHOSTDOWN</span></a>, <a href="oserrno.html#ECONNRESET"><span class="Identifier">ECONNRESET</span></a>, <a href="oserrno.html#EDQUOT"><span class="Identifier">EDQUOT</span></a>, <a href="internal/asyncfutures.html#fail.t,InternalRaisesFuture[T,E],ref.CatchableError,staticbool"><span class="Identifier">fail</span></a>, <a href="oserrno.html#ECANCELED"><span class="Identifier">ECANCELED</span></a>, <a href="oserrno.html#EMLINK"><span class="Identifier">EMLINK</span></a>, <a href="internal/asyncfutures.html#FuturePendingError"><span class="Identifier">FuturePendingError</span></a>, <a href="timer.html#milliseconds,SomeIntegerI64"><span class="Identifier">milliseconds</span></a>, <a href="timer.html#<=,Duration,Duration"><span class="Identifier">&lt;=</span></a>, <a href="timer.html#+=,Moment,Duration"><span class="Identifier">+=</span></a>, <a href="timer.html#$,Duration"><span class="Identifier">$</span></a>, <a href="timer.html#asyncTimer"><span class="Identifier">asyncTimer</span></a>, <a href="internal/asyncfutures.html#internalRaiseIfError.m,FutureBase,typed"><span class="Identifier">internalRaiseIfError</span></a>, <a href="srcloc.html#getSrcLocation.t,staticstring"><span class="Identifier">getSrcLocation</span></a>, <a href="futures.html#FutureError"><span class="Identifier">FutureError</span></a>, <a href="timer.html#fromNow,typedesc[Moment],Duration"><span class="Identifier">fromNow</span></a>, <a href="timer.html#weeks,Duration"><span class="Identifier">weeks</span></a>, <a href="oserrno.html#ESPIPE"><span class="Identifier">ESPIPE</span></a>, <a href="internal/asyncfutures.html#withTimeout,Future[T],Duration"><span class="Identifier">withTimeout</span></a>, <a href="futures.html#LocationKind"><span class="Identifier">LocationKind</span></a>, <a href="futures.html#id.t,FutureBase"><span class="Identifier">id</span></a>, <a href="timer.html#<=,Moment,Moment"><span class="Identifier">&lt;=</span></a>, <a href="internal/asyncfutures.html#FutureCompletedError"><span class="Identifier">FutureCompletedError</span></a>, <a href="oserrno.html#ENOEXEC"><span class="Identifier">ENOEXEC</span></a>, <a href="oserrno.html#ESHUTDOWN"><span class="Identifier">ESHUTDOWN</span></a>, <a href="internal/asyncfutures.html#fail.t,Future[T],ref.CatchableError,staticbool"><span class="Identifier">fail</span></a>, <a href="oserrno.html#EREMOTEIO"><span class="Identifier">EREMOTEIO</span></a>, <a href="timer.html#toString"><span class="Identifier">toString</span></a>, <a href="oserrno.html#EXFULL"><span class="Identifier">EXFULL</span></a>, <a href="internal/asyncfutures.html#waitFor,Future[void]"><span class="Identifier">waitFor</span></a>, <a href="internal/asyncfutures.html#complete.t,Future[T],T"><span class="Identifier">complete</span></a>, <a href="timer.html#==,Duration,Duration"><span class="Identifier">==</span></a>, <a href="internal/asyncfutures.html#oneValue,varargs[Future[T]]"><span class="Identifier">oneValue</span></a>, <a href="futures.html#internalInitFutureBase,FutureBase,ptr.SrcLoc,FutureState,FutureFlags"><span class="Identifier">internalInitFutureBase</span></a>, <a href="oserrno.html#EPROTONOSUPPORT"><span class="Identifier">EPROTONOSUPPORT</span></a>, <a href="timer.html#Nanosecond"><span class="Identifier">Nanosecond</span></a>, <a href="timer.html#epochNanoSeconds,Moment"><span class="Identifier">epochNanoSeconds</span></a>, <a href="internal/asyncfutures.html#cancelAndWait,FutureBase,ptr.SrcLoc"><span class="Identifier">cancelAndWait</span></a>, <a href="internal/asyncengine.html#addTimer,int64,CallbackFunc,pointer"><span class="Identifier">addTimer</span></a>, <
</dl></div>
</div>
</div>
<div class="row">
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
<small style="color: var(--hint);">Made with Nim. Generated: 2024-11-28 08:22:47 UTC</small>
</div>
</div>
</div>
</div>
</body>
</html>