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/selectors2.html

725 lines
67 KiB
HTML
Raw 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/selectors2</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/selectors2</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="#7" id="57">Types</a>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#Event"
title="Event {.pure.} = enum
Read, ## Descriptor is available for read
Write, ## Descriptor is available for write
Timer, ## Timer descriptor is completed
Signal, ## Signal is raised
Process, ## Process is finished
Vnode, ## BSD specific file change
User, ## User event is raised
Error, ## Error occurred while waiting for descriptor
VnodeWrite, ## NOTE_WRITE (BSD specific, write to file occurred)
VnodeDelete, ## NOTE_DELETE (BSD specific, unlink of file occurred)
VnodeExtend, ## NOTE_EXTEND (BSD specific, file extended)
VnodeAttrib, ## NOTE_ATTRIB (BSD specific, file attributes changed)
VnodeLink, ## NOTE_LINK (BSD specific, file link count changed)
VnodeRename, ## NOTE_RENAME (BSD specific, file renamed)
VnodeRevoke ## NOTE_REVOKE (BSD specific, file revoke occurred)">Event</a></li>
<li><a class="reference" href="#IOSelectorsException"
title="IOSelectorsException = object of CatchableError">IOSelectorsException</a></li>
<li><a class="reference" href="#ReadyKey"
title="ReadyKey = object
fd*: int ## file/socket descriptor
events*: set[Event] ## set of events
errorCode*: OSErrorCode ## additional error code information for
## Error events">ReadyKey</a></li>
<li><a class="reference" href="#SelectEvent"
title="SelectEvent = object">SelectEvent</a></li>
<li><a class="reference" href="#Selector"
title="Selector[T] = ref object">Selector</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">close
<li><a class="reference" href="#close%2CSelectEvent"
title="close(ev: SelectEvent)">close(ev: SelectEvent)</a></li>
<li><a class="reference" href="#close%2CSelector%5BT%5D"
title="close[T](s: Selector[T])">close[T](s: Selector[T])</a></li>
</ul>
<ul class="simple nested-toc-section">contains
<li><a class="reference" href="#contains%2CSelector%5BT%5D%2C"
title="contains[T](s: Selector[T]; fd: SocketHandle | int): bool">contains[T](s: Selector[T]; fd: SocketHandle | int): bool</a></li>
</ul>
<ul class="simple nested-toc-section">getData
<li><a class="reference" href="#getData%2CSelector%5BT%5D%2C"
title="getData[T](s: Selector[T]; fd: SocketHandle | int): var T">getData[T](s: Selector[T]; fd: SocketHandle | int): var T</a></li>
</ul>
<ul class="simple nested-toc-section">getFd
<li><a class="reference" href="#getFd%2CSelector%5BT%5D"
title="getFd[T](s: Selector[T]): int">getFd[T](s: Selector[T]): int</a></li>
</ul>
<ul class="simple nested-toc-section">newSelectEvent
<li><a class="reference" href="#newSelectEvent"
title="newSelectEvent(): SelectEvent">newSelectEvent(): SelectEvent</a></li>
</ul>
<ul class="simple nested-toc-section">newSelector
<li><a class="reference" href="#newSelector"
title="newSelector[T](): Selector[T]">newSelector[T](): Selector[T]</a></li>
</ul>
<ul class="simple nested-toc-section">registerEvent
<li><a class="reference" href="#registerEvent%2CSelector%5BT%5D%2CSelectEvent%2CT"
title="registerEvent[T](s: Selector[T]; ev: SelectEvent; data: T)">registerEvent[T](s: Selector[T]; ev: SelectEvent; data: T)</a></li>
</ul>
<ul class="simple nested-toc-section">registerHandle
<li><a class="reference" href="#registerHandle%2CSelector%5BT%5D%2C%2Cset%5BEvent%5D%2CT"
title="registerHandle[T](s: Selector[T]; fd: int | SocketHandle; events: set[Event];
data: T)">registerHandle[T](s: Selector[T]; fd: int | SocketHandle; events: set[Event];
data: T)</a></li>
</ul>
<ul class="simple nested-toc-section">registerProcess
<li><a class="reference" href="#registerProcess%2CSelector%5BT%5D%2Cint%2CT"
title="registerProcess[T](s: Selector[T]; pid: int; data: T): int">registerProcess[T](s: Selector[T]; pid: int; data: T): int</a></li>
</ul>
<ul class="simple nested-toc-section">registerSignal
<li><a class="reference" href="#registerSignal%2CSelector%5BT%5D%2Cint%2CT"
title="registerSignal[T](s: Selector[T]; signal: int; data: T): int">registerSignal[T](s: Selector[T]; signal: int; data: T): int</a></li>
</ul>
<ul class="simple nested-toc-section">registerTimer
<li><a class="reference" href="#registerTimer%2CSelector%5BT%5D%2Cint%2Cbool%2CT"
title="registerTimer[T](s: Selector[T]; timeout: int; oneshot: bool; data: T): int">registerTimer[T](s: Selector[T]; timeout: int; oneshot: bool; data: T): int</a></li>
</ul>
<ul class="simple nested-toc-section">registerVnode
<li><a class="reference" href="#registerVnode%2CSelector%5BT%5D%2Ccint%2Cset%5BEvent%5D%2CT"
title="registerVnode[T](s: Selector[T]; fd: cint; events: set[Event]; data: T)">registerVnode[T](s: Selector[T]; fd: cint; events: set[Event]; data: T)</a></li>
</ul>
<ul class="simple nested-toc-section">select
<li><a class="reference" href="#select%2CSelector%5BT%5D%2Cint"
title="select[T](s: Selector[T]; timeout: int): seq[ReadyKey]">select[T](s: Selector[T]; timeout: int): seq[ReadyKey]</a></li>
</ul>
<ul class="simple nested-toc-section">selectInto
<li><a class="reference" href="#selectInto%2CSelector%5BT%5D%2Cint%2CopenArray%5BReadyKey%5D"
title="selectInto[T](s: Selector[T]; timeout: int; results: var openArray[ReadyKey]): int">selectInto[T](s: Selector[T]; timeout: int; results: var openArray[ReadyKey]): int</a></li>
</ul>
<ul class="simple nested-toc-section">setData
<li><a class="reference" href="#setData%2CSelector%5BT%5D%2C%2CT"
title="setData[T](s: Selector[T]; fd: SocketHandle | int; data: var T): bool">setData[T](s: Selector[T]; fd: SocketHandle | int; data: var T): bool</a></li>
</ul>
<ul class="simple nested-toc-section">trigger
<li><a class="reference" href="#trigger%2CSelectEvent"
title="trigger(ev: SelectEvent)">trigger(ev: SelectEvent)</a></li>
</ul>
<ul class="simple nested-toc-section">unregister
<li><a class="reference" href="#unregister%2CSelector%5BT%5D%2CSelectEvent"
title="unregister[T](s: Selector[T]; ev: SelectEvent)">unregister[T](s: Selector[T]; ev: SelectEvent)</a></li>
<li><a class="reference" href="#unregister%2CSelector%5BT%5D%2C"
title="unregister[T](s: Selector[T]; fd: int | SocketHandle | cint)">unregister[T](s: Selector[T]; fd: int | SocketHandle | cint)</a></li>
</ul>
<ul class="simple nested-toc-section">updateHandle
<li><a class="reference" href="#updateHandle%2CSelector%5BT%5D%2C%2Cset%5BEvent%5D"
title="updateHandle[T](s: Selector[T]; fd: int | SocketHandle; events: set[Event])">updateHandle[T](s: Selector[T]; fd: int | SocketHandle; events: set[Event])</a></li>
</ul>
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#18" id="68">Templates</a>
<ul class="simple simple-toc-section">
<ul class="simple nested-toc-section">isEmpty
<li><a class="reference" href="#isEmpty.t%2CSelector%5BT%5D"
title="isEmpty[T](s: Selector[T]): bool">isEmpty[T](s: Selector[T]): bool</a></li>
</ul>
<ul class="simple nested-toc-section">withData
<li><a class="reference" href="#withData.t%2CSelector%5BT%5D%2C%2Cuntyped%2Cuntyped%2Cuntyped"
title="withData[T](s: Selector[T]; fd: SocketHandle | int; value, body1, body2: untyped)">withData[T](s: Selector[T]; fd: SocketHandle | int; value, body1, body2: untyped)</a></li>
<li><a class="reference" href="#withData.t%2CSelector%5BT%5D%2C%2Cuntyped%2Cuntyped"
title="withData[T](s: Selector[T]; fd: SocketHandle | int; value, body: untyped)">withData[T](s: Selector[T]; fd: SocketHandle | int; value, body: untyped)</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/selectors2.nim#L1"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/selectors2.nim#L1" class="link-seesrc" target="_blank" >Edit</a>
<div class="nine columns" id="content">
<div id="tocRoot"></div>
<p class="module-desc"><p>This module allows high-level and efficient I/O multiplexing.</p>
<p>Supported OS primitives: <tt class="docutils literal"><span class="pre">epoll</span></tt>, <tt class="docutils literal"><span class="pre">kqueue</span></tt>, <tt class="docutils literal"><span class="pre">poll</span></tt> and Windows <tt class="docutils literal"><span class="pre">select</span></tt>.</p>
<p>To use threadsafe version of this module, it needs to be compiled with both <tt class="docutils literal"><span class="pre">-d:threadsafe</span></tt> and <tt class="docutils literal"><span class="pre">--threads:on</span></tt> options.</p>
<p>Supported features: files, sockets, pipes, timers, processes, signals and user events.</p>
<p>Fully supported OS: MacOSX, FreeBSD, OpenBSD, NetBSD, Linux (except for Android).</p>
<p>Partially supported OS: Windows (only sockets and user events), Solaris (files, sockets, handles and user events). Android (files, sockets, handles and user events).</p>
<p>TODO: <tt class="docutils literal"><span class="pre">/dev/poll</span></tt>, <tt class="docutils literal"><span class="pre">event ports</span></tt> and filesystem events.</p>
</p>
<div class="section" id="6">
<h1><a class="toc-backref" href="#6">Imports</a></h1>
<dl class="item">
<a class="reference external" href="config.html">config</a>, <a class="reference external" href="osdefs.html">osdefs</a>, <a class="reference external" href="osutils.html">osutils</a>, <a class="reference external" href="oserrno.html">oserrno</a>
</dl></div>
<div class="section" id="7">
<h1><a class="toc-backref" href="#7">Types</a></h1>
<dl class="item">
<div id="Event">
<dt><pre><a href="selectors2.html#Event"><span class="Identifier">Event</span></a> {.<span class="Identifier">pure</span>.} <span class="Other">=</span> <span class="Keyword">enum</span>
<span class="Identifier">Read</span><span class="Other">,</span> <span class="Comment">## Descriptor is available for read</span>
<span class="Identifier">Write</span><span class="Other">,</span> <span class="Comment">## Descriptor is available for write</span>
<span class="Identifier">Timer</span><span class="Other">,</span> <span class="Comment">## Timer descriptor is completed</span>
<span class="Identifier">Signal</span><span class="Other">,</span> <span class="Comment">## Signal is raised</span>
<span class="Identifier">Process</span><span class="Other">,</span> <span class="Comment">## Process is finished</span>
<span class="Identifier">Vnode</span><span class="Other">,</span> <span class="Comment">## BSD specific file change</span>
<span class="Identifier">User</span><span class="Other">,</span> <span class="Comment">## User event is raised</span>
<span class="Identifier">Error</span><span class="Other">,</span> <span class="Comment">## Error occurred while waiting for descriptor</span>
<span class="Identifier">VnodeWrite</span><span class="Other">,</span> <span class="Comment">## NOTE_WRITE (BSD specific, write to file occurred)</span>
<span class="Identifier">VnodeDelete</span><span class="Other">,</span> <span class="Comment">## NOTE_DELETE (BSD specific, unlink of file occurred)</span>
<span class="Identifier">VnodeExtend</span><span class="Other">,</span> <span class="Comment">## NOTE_EXTEND (BSD specific, file extended)</span>
<span class="Identifier">VnodeAttrib</span><span class="Other">,</span> <span class="Comment">## NOTE_ATTRIB (BSD specific, file attributes changed)</span>
<span class="Identifier">VnodeLink</span><span class="Other">,</span> <span class="Comment">## NOTE_LINK (BSD specific, file link count changed)</span>
<span class="Identifier">VnodeRename</span><span class="Other">,</span> <span class="Comment">## NOTE_RENAME (BSD specific, file renamed)</span>
<span class="Identifier">VnodeRevoke</span> <span class="Comment">## NOTE_REVOKE (BSD specific, file revoke occurred)</span></pre></dt>
<dd>
An enum which hold event types
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/selectors2.nim#L43"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/selectors2.nim#L43" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="IOSelectorsException">
<dt><pre><a href="selectors2.html#IOSelectorsException"><span class="Identifier">IOSelectorsException</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <span class="Identifier">CatchableError</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/selectors2.nim#L61"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/selectors2.nim#L61" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="ReadyKey">
<dt><pre><a href="selectors2.html#ReadyKey"><span class="Identifier">ReadyKey</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
<span class="Identifier">fd</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">int</span> <span class="Comment">## file/socket descriptor</span>
<span class="Identifier">events</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">set</span><span class="Other">[</span><a href="selectors2.html#Event"><span class="Identifier">Event</span></a><span class="Other">]</span> <span class="Comment">## set of events</span>
<span class="Identifier">errorCode</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">OSErrorCode</span> <span class="Comment">## additional error code information for</span>
<span class="Comment">## Error events</span>
</pre></dt>
<dd>
An object which holds result for descriptor
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/selectors2.nim#L63"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/selectors2.nim#L63" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="SelectEvent">
<dt><pre><a href="selectors2.html#SelectEvent"><span class="Identifier">SelectEvent</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
</pre></dt>
<dd>
An object which holds user defined event
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/selectors2.nim#L70"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/selectors2.nim#L70" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="Selector">
<dt><pre><a href="selectors2.html#Selector"><span class="Identifier">Selector</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span>
</pre></dt>
<dd>
An object which holds descriptors to be checked for read/write status
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/selectors2.nim#L40"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/selectors2.nim#L40" 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="close,SelectEvent">
<dt><pre><span class="Keyword">proc</span> <a href="#close%2CSelectEvent"><span class="Identifier">close</span></a><span class="Other">(</span><span class="Identifier">ev</span><span class="Other">:</span> <a href="selectors2.html#SelectEvent"><span class="Identifier">SelectEvent</span></a><span class="Other">)</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>
Closes user-defined event <tt class="docutils literal"><span class="pre">ev</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/selectors2.nim#L147"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/selectors2.nim#L147" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="close,Selector[T]">
<dt><pre><span class="Keyword">proc</span> <a href="#close%2CSelector%5BT%5D"><span class="Identifier">close</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="selectors2.html#Selector"><span class="Identifier">Selector</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span></pre></dt>
<dd>
Closes the selector.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/selectors2.nim#L76"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/selectors2.nim#L76" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="contains,Selector[T],">
<dt><pre><span class="Keyword">proc</span> <a href="#contains%2CSelector%5BT%5D%2C"><span class="Identifier">contains</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="selectors2.html#Selector"><span class="Identifier">Selector</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">fd</span><span class="Other">:</span> <span class="Identifier">SocketHandle</span> <span class="Operator">|</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> {.<span class="Identifier">inline</span>.}</pre></dt>
<dd>
Determines whether selector contains a file descriptor.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/selectors2.nim#L219"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/selectors2.nim#L219" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="getData,Selector[T],">
<dt><pre><span class="Keyword">proc</span> <a href="#getData%2CSelector%5BT%5D%2C"><span class="Identifier">getData</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="selectors2.html#Selector"><span class="Identifier">Selector</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">fd</span><span class="Other">:</span> <span class="Identifier">SocketHandle</span> <span class="Operator">|</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span></pre></dt>
<dd>
Retrieves application-defined <tt class="docutils literal"><span class="pre">data</span></tt> associated with descriptor <tt class="docutils literal"><span class="pre">fd</span></tt>. If specified descriptor <tt class="docutils literal"><span class="pre">fd</span></tt> is not registered, empty/default value will be returned.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/selectors2.nim#L176"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/selectors2.nim#L176" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="getFd,Selector[T]">
<dt><pre><span class="Keyword">proc</span> <a href="#getFd%2CSelector%5BT%5D"><span class="Identifier">getFd</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="selectors2.html#Selector"><span class="Identifier">Selector</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span></pre></dt>
<dd>
<p>Retrieves the underlying selector's file descriptor.</p>
<p>For <em>poll</em> and <em>select</em> selectors <tt class="docutils literal"><span class="pre">-1</span></tt> is returned.</p>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/selectors2.nim#L222"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/selectors2.nim#L222" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="newSelectEvent">
<dt><pre><span class="Keyword">proc</span> <a href="#newSelectEvent"><span class="Identifier">newSelectEvent</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="selectors2.html#SelectEvent"><span class="Identifier">SelectEvent</span></a> {.<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>
Creates a new user-defined event.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/selectors2.nim#L141"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/selectors2.nim#L141" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="newSelector">
<dt><pre><span class="Keyword">proc</span> <a href="#newSelector"><span class="Identifier">newSelector</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="selectors2.html#Selector"><span class="Identifier">Selector</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
<dd>
Creates a new selector
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/selectors2.nim#L73"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/selectors2.nim#L73" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="registerEvent,Selector[T],SelectEvent,T">
<dt><pre><span class="Keyword">proc</span> <a href="#registerEvent%2CSelector%5BT%5D%2CSelectEvent%2CT"><span class="Identifier">registerEvent</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="selectors2.html#Selector"><span class="Identifier">Selector</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">ev</span><span class="Other">:</span> <a href="selectors2.html#SelectEvent"><span class="Identifier">SelectEvent</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span></pre></dt>
<dd>
<p>Registers selector event <tt class="docutils literal"><span class="pre">ev</span></tt> in selector <tt class="docutils literal"><span class="pre">s</span></tt>.</p>
<p>The <tt class="docutils literal"><span class="pre">data</span></tt> is application-defined data, which will be passed when <tt class="docutils literal"><span class="pre">ev</span></tt> happens.</p>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/selectors2.nim#L126"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/selectors2.nim#L126" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="registerHandle,Selector[T],,set[Event],T">
<dt><pre><span class="Keyword">proc</span> <a href="#registerHandle%2CSelector%5BT%5D%2C%2Cset%5BEvent%5D%2CT"><span class="Identifier">registerHandle</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="selectors2.html#Selector"><span class="Identifier">Selector</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">fd</span><span class="Other">:</span> <span class="Identifier">int</span> <span class="Operator">|</span> <span class="Identifier">SocketHandle</span><span class="Other">;</span>
<span class="Identifier">events</span><span class="Other">:</span> <span class="Identifier">set</span><span class="Other">[</span><a href="selectors2.html#Event"><span class="Identifier">Event</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span></pre></dt>
<dd>
Registers file/socket descriptor <tt class="docutils literal"><span class="pre">fd</span></tt> to selector <tt class="docutils literal"><span class="pre">s</span></tt> with events set in <tt class="docutils literal"><span class="pre">events</span></tt>. The <tt class="docutils literal"><span class="pre">data</span></tt> is application-defined data, which will be passed when an event is triggered.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/selectors2.nim#L79"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/selectors2.nim#L79" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="registerProcess,Selector[T],int,T">
<dt><pre><span class="Keyword">proc</span> <a href="#registerProcess%2CSelector%5BT%5D%2Cint%2CT"><span class="Identifier">registerProcess</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="selectors2.html#Selector"><span class="Identifier">Selector</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">pid</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.<span class="Identifier">discardable</span>.}</pre></dt>
<dd>
<p>Registers a process id (pid) notification (when process has exited) in selector <tt class="docutils literal"><span class="pre">s</span></tt>.</p>
<p>The <tt class="docutils literal"><span class="pre">data</span></tt> is application-defined data, which will be passed when process with <tt class="docutils literal"><span class="pre">pid</span></tt> has exited.</p>
<p>Returns the file descriptor for the registered signal.</p>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/selectors2.nim#L116"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/selectors2.nim#L116" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="registerSignal,Selector[T],int,T">
<dt><pre><span class="Keyword">proc</span> <a href="#registerSignal%2CSelector%5BT%5D%2Cint%2CT"><span class="Identifier">registerSignal</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="selectors2.html#Selector"><span class="Identifier">Selector</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">signal</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.<span class="Identifier">discardable</span>.}</pre></dt>
<dd>
<p>Registers Unix signal notification with <tt class="docutils literal"><span class="pre">signal</span></tt> to selector <tt class="docutils literal"><span class="pre">s</span></tt>.</p>
<p>The <tt class="docutils literal"><span class="pre">data</span></tt> is application-defined data, which will be passed when signal raises.</p>
<p>Returns the file descriptor for the registered signal.</p>
<p><strong>Note:</strong> This function is not supported on <tt class="docutils literal"><span class="pre">Windows</span></tt>.</p>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/selectors2.nim#L104"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/selectors2.nim#L104" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="registerTimer,Selector[T],int,bool,T">
<dt><pre><span class="Keyword">proc</span> <a href="#registerTimer%2CSelector%5BT%5D%2Cint%2Cbool%2CT"><span class="Identifier">registerTimer</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="selectors2.html#Selector"><span class="Identifier">Selector</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">timeout</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">;</span> <span class="Identifier">oneshot</span><span class="Other">:</span> <span class="Identifier">bool</span><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.
<span class="Identifier">discardable</span>.}</pre></dt>
<dd>
<p>Registers timer notification with <tt class="docutils literal"><span class="pre">timeout</span></tt> (in milliseconds) to selector <tt class="docutils literal"><span class="pre">s</span></tt>.</p>
<p>If <tt class="docutils literal"><span class="pre">oneshot</span></tt> is <tt class="docutils literal"><span class="pre">true</span></tt>, timer will be notified only once.</p>
<p>Set <tt class="docutils literal"><span class="pre">oneshot</span></tt> to <tt class="docutils literal"><span class="pre">false</span></tt> if you want periodic notifications.</p>
<p>The <tt class="docutils literal"><span class="pre">data</span></tt> is application-defined data, which will be passed, when the timer is triggered.</p>
<p>Returns the file descriptor for the registered timer.</p>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/selectors2.nim#L90"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/selectors2.nim#L90" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="registerVnode,Selector[T],cint,set[Event],T">
<dt><pre><span class="Keyword">proc</span> <a href="#registerVnode%2CSelector%5BT%5D%2Ccint%2Cset%5BEvent%5D%2CT"><span class="Identifier">registerVnode</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="selectors2.html#Selector"><span class="Identifier">Selector</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">fd</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">;</span> <span class="Identifier">events</span><span class="Other">:</span> <span class="Identifier">set</span><span class="Other">[</span><a href="selectors2.html#Event"><span class="Identifier">Event</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span></pre></dt>
<dd>
<p>Registers selector BSD/MacOSX specific vnode events for file descriptor <tt class="docutils literal"><span class="pre">fd</span></tt> and events <tt class="docutils literal"><span class="pre">events</span></tt>. <tt class="docutils literal"><span class="pre">data</span></tt> application-defined data, which to be passed, when vnode event happens.</p>
<p><strong>Note:</strong> This function is supported only by BSD and MacOSX.</p>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/selectors2.nim#L132"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/selectors2.nim#L132" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="select,Selector[T],int">
<dt><pre><span class="Keyword">proc</span> <a href="#select%2CSelector%5BT%5D%2Cint"><span class="Identifier">select</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="selectors2.html#Selector"><span class="Identifier">Selector</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">timeout</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="selectors2.html#ReadyKey"><span class="Identifier">ReadyKey</span></a><span class="Other">]</span></pre></dt>
<dd>
<p>Waits for events registered in selector <tt class="docutils literal"><span class="pre">s</span></tt>.</p>
<p>The <tt class="docutils literal"><span class="pre">timeout</span></tt> argument specifies the maximum number of milliseconds the function will be blocked for if no events are ready. Specifying a timeout of <tt class="docutils literal"><span class="pre">-1</span></tt> causes the function to block indefinitely.</p>
<p>Returns a list of triggered events.</p>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/selectors2.nim#L167"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/selectors2.nim#L167" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="selectInto,Selector[T],int,openArray[ReadyKey]">
<dt><pre><span class="Keyword">proc</span> <a href="#selectInto%2CSelector%5BT%5D%2Cint%2CopenArray%5BReadyKey%5D"><span class="Identifier">selectInto</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="selectors2.html#Selector"><span class="Identifier">Selector</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">timeout</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">;</span>
<span class="Identifier">results</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">openArray</span><span class="Other">[</span><a href="selectors2.html#ReadyKey"><span class="Identifier">ReadyKey</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span></pre></dt>
<dd>
<p>Waits for events registered in selector <tt class="docutils literal"><span class="pre">s</span></tt>.</p>
<p>The <tt class="docutils literal"><span class="pre">timeout</span></tt> argument specifies the maximum number of milliseconds the function will be blocked for if no events are ready. Specifying a timeout of <tt class="docutils literal"><span class="pre">-1</span></tt> causes the function to block indefinitely. All available events will be stored in <tt class="docutils literal"><span class="pre">results</span></tt> array.</p>
<p>Returns number of triggered events.</p>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/selectors2.nim#L156"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/selectors2.nim#L156" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="setData,Selector[T],,T">
<dt><pre><span class="Keyword">proc</span> <a href="#setData%2CSelector%5BT%5D%2C%2CT"><span class="Identifier">setData</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="selectors2.html#Selector"><span class="Identifier">Selector</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">fd</span><span class="Other">:</span> <span class="Identifier">SocketHandle</span> <span class="Operator">|</span> <span class="Identifier">int</span><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span></pre></dt>
<dd>
<p>Associate application-defined <tt class="docutils literal"><span class="pre">data</span></tt> with descriptor <tt class="docutils literal"><span class="pre">fd</span></tt>.</p>
<p>Returns <tt class="docutils literal"><span class="pre">true</span></tt>, if data was successfully updated, <tt class="docutils literal"><span class="pre">false</span></tt> otherwise.</p>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/selectors2.nim#L181"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/selectors2.nim#L181" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="trigger,SelectEvent">
<dt><pre><span class="Keyword">proc</span> <a href="#trigger%2CSelectEvent"><span class="Identifier">trigger</span></a><span class="Other">(</span><span class="Identifier">ev</span><span class="Other">:</span> <a href="selectors2.html#SelectEvent"><span class="Identifier">SelectEvent</span></a><span class="Other">)</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>
Trigger event <tt class="docutils literal"><span class="pre">ev</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/selectors2.nim#L144"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/selectors2.nim#L144" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="unregister,Selector[T],SelectEvent">
<dt><pre><span class="Keyword">proc</span> <a href="#unregister%2CSelector%5BT%5D%2CSelectEvent"><span class="Identifier">unregister</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="selectors2.html#Selector"><span class="Identifier">Selector</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">ev</span><span class="Other">:</span> <a href="selectors2.html#SelectEvent"><span class="Identifier">SelectEvent</span></a><span class="Other">)</span></pre></dt>
<dd>
Unregisters user-defined event <tt class="docutils literal"><span class="pre">ev</span></tt> from selector <tt class="docutils literal"><span class="pre">s</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/selectors2.nim#L150"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/selectors2.nim#L150" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="unregister,Selector[T],">
<dt><pre><span class="Keyword">proc</span> <a href="#unregister%2CSelector%5BT%5D%2C"><span class="Identifier">unregister</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="selectors2.html#Selector"><span class="Identifier">Selector</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">fd</span><span class="Other">:</span> <span class="Identifier">int</span> <span class="Operator">|</span> <span class="Identifier">SocketHandle</span> <span class="Operator">|</span> <span class="Identifier">cint</span><span class="Other">)</span></pre></dt>
<dd>
Unregisters file/socket descriptor <tt class="docutils literal"><span class="pre">fd</span></tt> from selector <tt class="docutils literal"><span class="pre">s</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/selectors2.nim#L153"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/selectors2.nim#L153" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="updateHandle,Selector[T],,set[Event]">
<dt><pre><span class="Keyword">proc</span> <a href="#updateHandle%2CSelector%5BT%5D%2C%2Cset%5BEvent%5D"><span class="Identifier">updateHandle</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="selectors2.html#Selector"><span class="Identifier">Selector</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">fd</span><span class="Other">:</span> <span class="Identifier">int</span> <span class="Operator">|</span> <span class="Identifier">SocketHandle</span><span class="Other">;</span> <span class="Identifier">events</span><span class="Other">:</span> <span class="Identifier">set</span><span class="Other">[</span><a href="selectors2.html#Event"><span class="Identifier">Event</span></a><span class="Other">]</span><span class="Other">)</span></pre></dt>
<dd>
Update file/socket descriptor <tt class="docutils literal"><span class="pre">fd</span></tt>, registered in selector <tt class="docutils literal"><span class="pre">s</span></tt> with new events set <tt class="docutils literal"><span class="pre">event</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/selectors2.nim#L85"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/selectors2.nim#L85" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
</dl></div>
<div class="section" id="18">
<h1><a class="toc-backref" href="#18">Templates</a></h1>
<dl class="item">
<div id="isEmpty.t,Selector[T]">
<dt><pre><span class="Keyword">template</span> <a href="#isEmpty.t%2CSelector%5BT%5D"><span class="Identifier">isEmpty</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="selectors2.html#Selector"><span class="Identifier">Selector</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span></pre></dt>
<dd>
Returns <tt class="docutils literal"><span class="pre">true</span></tt>, if there are no registered events or descriptors in selector.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/selectors2.nim#L186"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/selectors2.nim#L186" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="withData.t,Selector[T],,untyped,untyped,untyped">
<dt><pre><span class="Keyword">template</span> <a href="#withData.t%2CSelector%5BT%5D%2C%2Cuntyped%2Cuntyped%2Cuntyped"><span class="Identifier">withData</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="selectors2.html#Selector"><span class="Identifier">Selector</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">fd</span><span class="Other">:</span> <span class="Identifier">SocketHandle</span> <span class="Operator">|</span> <span class="Identifier">int</span><span class="Other">;</span>
<span class="Identifier">value</span><span class="Other">,</span> <span class="Identifier">body1</span><span class="Other">,</span> <span class="Identifier">body2</span><span class="Other">:</span> <span class="Identifier">untyped</span><span class="Other">)</span></pre></dt>
<dd>
Retrieves the application-data assigned with descriptor <tt class="docutils literal"><span class="pre">fd</span></tt> to <tt class="docutils literal"><span class="pre">value</span></tt>. This <tt class="docutils literal"><span class="pre">value</span></tt> can be modified in the scope of the <tt class="docutils literal"><span class="pre">withData</span></tt> call.<pre class="listing"><span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">withData</span><span class="Punctuation">(</span><span class="Identifier">fd</span><span class="Punctuation">,</span> <span class="Identifier">value</span><span class="Punctuation">)</span> <span class="Keyword">do</span><span class="Punctuation">:</span>
<span class="Comment"># block is executed only if ``fd`` registered in selector ``s``.</span>
<span class="Identifier">value</span><span class="Operator">.</span><span class="Identifier">uid</span> <span class="Operator">=</span> <span class="DecNumber">1000</span>
<span class="Keyword">do</span><span class="Punctuation">:</span>
<span class="Comment"># block is executed if ``fd`` not registered in selector ``s``.</span>
<span class="Keyword">raise</span></pre>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/selectors2.nim#L203"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/selectors2.nim#L203" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="withData.t,Selector[T],,untyped,untyped">
<dt><pre><span class="Keyword">template</span> <a href="#withData.t%2CSelector%5BT%5D%2C%2Cuntyped%2Cuntyped"><span class="Identifier">withData</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="selectors2.html#Selector"><span class="Identifier">Selector</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">fd</span><span class="Other">:</span> <span class="Identifier">SocketHandle</span> <span class="Operator">|</span> <span class="Identifier">int</span><span class="Other">;</span>
<span class="Identifier">value</span><span class="Other">,</span> <span class="Identifier">body</span><span class="Other">:</span> <span class="Identifier">untyped</span><span class="Other">)</span></pre></dt>
<dd>
Retrieves the application-data assigned with descriptor <tt class="docutils literal"><span class="pre">fd</span></tt> to <tt class="docutils literal"><span class="pre">value</span></tt>. This <tt class="docutils literal"><span class="pre">value</span></tt> can be modified in the scope of the <tt class="docutils literal"><span class="pre">withData</span></tt> call.<pre class="listing"><span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">withData</span><span class="Punctuation">(</span><span class="Identifier">fd</span><span class="Punctuation">,</span> <span class="Identifier">value</span><span class="Punctuation">)</span> <span class="Keyword">do</span><span class="Punctuation">:</span>
<span class="Comment"># block is executed only if ``fd`` registered in selector ``s``</span>
<span class="Identifier">value</span><span class="Operator">.</span><span class="Identifier">uid</span> <span class="Operator">=</span> <span class="DecNumber">1000</span></pre>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-chronos/tree/master/chronos/selectors2.nim#L190"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/selectors2.nim#L190" 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="oserrno.html#EPERM"><span class="Identifier">EPERM</span></a>, <a href="oserrno.html#ENOBUFS"><span class="Identifier">ENOBUFS</span></a>, <a href="oserrno.html#EFAULT"><span class="Identifier">EFAULT</span></a>, <a href="oserrno.html#EKEYREJECTED"><span class="Identifier">EKEYREJECTED</span></a>, <a href="oserrno.html#EHWPOISON"><span class="Identifier">EHWPOISON</span></a>, <a href="oserrno.html#EHOSTDOWN"><span class="Identifier">EHOSTDOWN</span></a>, <a href="oserrno.html#EDQUOT"><span class="Identifier">EDQUOT</span></a>, <a href="oserrno.html#EREMCHG"><span class="Identifier">EREMCHG</span></a>, <a href="oserrno.html#EISDIR"><span class="Identifier">EISDIR</span></a>, <a href="oserrno.html#ESTRPIPE"><span class="Identifier">ESTRPIPE</span></a>, <a href="oserrno.html#EMLINK"><span class="Identifier">EMLINK</span></a>, <a href="oserrno.html#ENXIO"><span class="Identifier">ENXIO</span></a>, <a href="oserrno.html#ETOOMANYREFS"><span class="Identifier">ETOOMANYREFS</span></a>, <a href="oserrno.html#ENOMEDIUM"><span class="Identifier">ENOMEDIUM</span></a>, <a href="oserrno.html#EOVERFLOW"><span class="Identifier">EOVERFLOW</span></a>, <a href="oserrno.html#EAFNOSUPPORT"><span class="Identifier">EAFNOSUPPORT</span></a>, <a href="oserrno.html#ENOTCONN"><span class="Identifier">ENOTCONN</span></a>, <a href="oserrno.html#ECHILD"><span class="Identifier">ECHILD</span></a>, <a href="oserrno.html#ESOCKTNOSUPPORT"><span class="Identifier">ESOCKTNOSUPPORT</span></a>, <a href="oserrno.html#EBFONT"><span class="Identifier">EBFONT</span></a>, <a href="oserrno.html#ESRMNT"><span class="Identifier">ESRMNT</span></a>, <a href="oserrno.html#ENOTEMPTY"><span class="Identifier">ENOTEMPTY</span></a>, <a href="oserrno.html#ESTALE"><span class="Identifier">ESTALE</span></a>, <a href="oserrno.html#EPROTO"><span class="Identifier">EPROTO</span></a>, <a href="oserrno.html#EADDRNOTAVAIL"><span class="Identifier">EADDRNOTAVAIL</span></a>, <a href="oserrno.html#EXDEV"><span class="Identifier">EXDEV</span></a>, <a href="oserrno.html#EBADF"><span class="Identifier">EBADF</span></a>, <a href="oserrno.html#EKEYREVOKED"><span class="Identifier">EKEYREVOKED</span></a>, <a href="oserrno.html#ENOTDIR"><span class="Identifier">ENOTDIR</span></a>, <a href="oserrno.html#EDEADLK"><span class="Identifier">EDEADLK</span></a>, <a href="oserrno.html#EALREADY"><span class="Identifier">EALREADY</span></a>, <a href="oserrno.html#ESPIPE"><span class="Identifier">ESPIPE</span></a>, <a href="oserrno.html#ENOEXEC"><span class="Identifier">ENOEXEC</span></a>, <a href="oserrno.html#ENETDOWN"><span class="Identifier">ENETDOWN</span></a>, <a href="oserrno.html#EACCES"><span class="Identifier">EACCES</span></a>, <a href="oserrno.html#ELNRNG"><span class="Identifier">ELNRNG</span></a>, <a href="oserrno.html#ELOOP"><span class="Identifier">ELOOP</span></a>, <a href="oserrno.html#ENODEV"><span class="Identifier">ENODEV</span></a>, <a href="oserrno.html#ENFILE"><span class="Identifier">ENFILE</span></a>, <a href="oserrno.html#ENOPKG"><span class="Identifier">ENOPKG</span></a>, <a href="oserrno.html#ENOCSI"><span class="Identifier">ENOCSI</span></a>, <a href="oserrno.html#ECHRNG"><span class="Identifier">ECHRNG</span></a>, <a href="oserrno.html#EL3HLT"><span class="Identifier">EL3HLT</span></a>, <a href="oserrno.html#EINVAL"><span class="Identifier">EINVAL</span></a>, <a href="oserrno.html#EADDRINUSE"><span class="Identifier">EADDRINUSE</span></a>, <a href="oserrno.html#EUNATCH"><span class="Identifier">EUNATCH</span></a>, <a href="oserrno.html#EBADFD"><span class="Identifier">EBADFD</span></a>, <a href="oserrno.html#EMEDIUMTYPE"><span class="Identifier">EMEDIUMTYPE</span></a>, <a href="oserrno.html#ERESTART"><span class="Identifier">ERESTART</span></a>, <a href="oserrno.html#ESRCH"><span class="Identifier">ESRCH</span></a>, <a href="oserrno.html#ETXTBSY"><span class="Identifier">ETXTBSY</span></a>, <a href="oserrno.html#ENETUNREACH"><span class="Identifier">ENETUNREACH</span></a>, <a href="oserrno.html#EPROTONOSUPPORT"><span class="Identifier">EPROTONOSUPPORT</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:46 UTC</small>
</div>
</div>
</div>
</div>
</body>
</html>