Почетна Преглед Помоћ
Пријавите се
levovix
/
Nim
огледало од https://github.com/nim-lang/Nim
Прати 1
Волим 0
Креирај огранак 1
Датотеке Дискусије 0 Вики
Грана: gh-pages
Гране Ознаке
Nim
/
asyncdispatch.html

asyncdispatch.html 128 KB
Пермалинк Историја Датотека

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088 
  1. <?xml version="1.0" encoding="utf-8" ?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. <!--  This file is generated by Nim. -->
    4. 

  4. <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
    5. 

  5. <head>
    6. 

  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    7. 

  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
    8. 

  8. <title>std/asyncdispatch</title>
    9. 

  9. 

  10. <!-- Google fonts -->
    11. 

  11. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
    12. 

  12. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
    13. 

  13. 

  14. <!-- Favicon -->
    15. 

  15. <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=="/>
    16. 

  16. <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=">
    17. 

  17. 

  18. <!-- CSS -->
    19. 

  19. <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
    20. 

  20. 

  21. <!-- JS -->
    22. 

  22. <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
    23. 

  23. </head>
    24. 

  24. <body>
    25. 

  25.   <div class="document" id="documentId">
    26. 

  26.     <div class="container">
    27. 

  27.       <h1 class="title">std/asyncdispatch</h1>
    28. 

  28.       <div class="row">
    29. 

  29.   <div class="three columns">
    30. 

  30.     <div class="theme-select-wrapper">
    31. 

  31.       <label for="theme-select">Theme:&nbsp;</label>
    32. 

  32.       <select id="theme-select" onchange="setTheme(this.value)">
    33. 

  33.         <option value="auto">🌗 Match OS</option>
    34. 

  34.         <option value="dark">🌑 Dark</option>
    35. 

  35.         <option value="light">🌕 Light</option>
    36. 

  36.       </select>
    37. 

  37.     </div>
    38. 

  38.     <div id="global-links">
    39. 

  39.       <ul class="simple-boot">
    40. 

  40.         <li><a href="manual.html">Manual</a></li>
    41. 

  41.         <li><a href="lib.html">Standard library</a></li>
    42. 

  42.         <li> <a id="indexLink" href="theindex.html">Index</a></li>
    43. 

  43.         <li><a href="compiler/theindex.html">Compiler docs</a></li>
    44. 

  44.         <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
    45. 

  45.         <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
    46. 

  46.       </ul>
    47. 

  47.     </div>
    48. 

  48.     <div id="searchInputDiv">
    49. 

  49.       Search: <input type="search" id="searchInput"
    50. 

  50.         oninput="search()" />
    51. 

  51.     </div>
    52. 

  52.     
    53. 

  53.     <ul class="simple simple-toc" id="toc-list">
    54. 

  54.   <li><a class="reference" id="asynchronous-procedures_toc" href="#asynchronous-procedures">Asynchronous procedures</a></li>
    55. 

  55. <ul class="simple"><li><a class="reference" id="asynchronous-procedures-handling-exceptions_toc" href="#asynchronous-procedures-handling-exceptions">Handling Exceptions</a></li>
    56. 

  56. </ul><li><a class="reference" id="discarding-futures_toc" href="#discarding-futures">Discarding futures</a></li>
    57. 

  57. <li><a class="reference" id="handling-futures_toc" href="#handling-futures">Handling futures</a></li>
    58. 

  58. <li><a class="reference" id="examples_toc" href="#examples">Examples</a></li>
    59. 

  59. <li><a class="reference" id="investigating-pending-futures_toc" href="#investigating-pending-futures">Investigating pending futures</a></li>
    60. 

  60. <li><a class="reference" id="limitationsslashbugs_toc" href="#limitationsslashbugs">Limitations/Bugs</a></li>
    61. 

  61. <li><a class="reference" id="multiple-async-backend-support_toc" href="#multiple-async-backend-support">Multiple async backend support</a></li>
    62. 

  62. <li>
    63. 

  63.   <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
    64. 

  64. </li>
    65. 

  65. <li>
    66. 

  66.   <details open>
    67. 

  67.     <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
    68. 

  68.     <ul class="simple simple-toc-section">
    69. 

  69.       <li><a class="reference" href="#AsyncEvent" title="AsyncEvent = ptr AsyncEventImpl">AsyncEvent</a></li>
    70. 

  70. <li><a class="reference" href="#AsyncFD" title="AsyncFD = distinct int">AsyncFD</a></li>
    71. 

  71. <li><a class="reference" href="#Callback" title="Callback = proc (fd: AsyncFD): bool {.closure, gcsafe.}">Callback</a></li>
    72. 

  72. <li><a class="reference" href="#CompletionData" title="CompletionData = object
    73. 

  73.   fd*: AsyncFD
    74. 

  74.   cb*: owned(proc (fd: AsyncFD; bytesTransferred: DWORD; errcode: OSErrorCode) {.
    75. 

  75.       closure, gcsafe.})
    76. 

  76.   cell*: ForeignCell">CompletionData</a></li>
    77. 

  77. <li><a class="reference" href="#CustomRef" title="CustomRef = ref CustomObj">CustomRef</a></li>
    78. 

  78. <li><a class="reference" href="#PDispatcher" title="PDispatcher = ref object of PDispatcherBase
    79. 

  79.   handles*: HashSet[AsyncFD]">PDispatcher</a></li>
    80. 

  80. 

  81.     </ul>
    82. 

  82.   </details>
    83. 

  83. </li>
    84. 

  84. <li>
    85. 

  85.   <details open>
    86. 

  86.     <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
    87. 

  87.     <ul class="simple simple-toc-section">
    88. 

  88.       <ul class="simple nested-toc-section">==
    89. 

  89.   <li><a class="reference" href="#%3D%3D%2CAsyncFD%2CAsyncFD" title="`==`(x: AsyncFD; y: AsyncFD): bool">`==`(x: AsyncFD; y: AsyncFD): bool</a></li>
    90. 

  90. 

  91. </ul>
    92. 

  92. <ul class="simple nested-toc-section">accept
    93. 

  93.   <li><a class="reference" href="#accept%2CAsyncFD" title="accept(socket: AsyncFD; flags = {SafeDisconn};
    94. 

  94.        inheritable = defined(nimInheritHandles)): owned(Future[AsyncFD])">accept(socket: AsyncFD; flags = {SafeDisconn};
    95. 

  95.        inheritable = defined(nimInheritHandles)): owned(Future[AsyncFD])</a></li>
    96. 

  96. 

  97. </ul>
    98. 

  98. <ul class="simple nested-toc-section">acceptAddr
    99. 

  99.   <li><a class="reference" href="#acceptAddr%2CAsyncFD" title="acceptAddr(socket: AsyncFD; flags = {SafeDisconn};
    100. 

  100.            inheritable = defined(nimInheritHandles)): owned(
    101. 

  101.     Future[tuple[address: string, client: AsyncFD]])">acceptAddr(socket: AsyncFD; flags = {SafeDisconn};
    102. 

  102.            inheritable = defined(nimInheritHandles)): owned(
    103. 

  103.     Future[tuple[address: string, client: AsyncFD]])</a></li>
    104. 

  104. 

  105. </ul>
    106. 

  106. <ul class="simple nested-toc-section">activeDescriptors
    107. 

  107.   <li><a class="reference" href="#activeDescriptors" title="activeDescriptors(): int">activeDescriptors(): int</a></li>
    108. 

  108. 

  109. </ul>
    110. 

  110. <ul class="simple nested-toc-section">addEvent
    111. 

  111.   <li><a class="reference" href="#addEvent%2CAsyncEvent%2CCallback" title="addEvent(ev: AsyncEvent; cb: Callback)">addEvent(ev: AsyncEvent; cb: Callback)</a></li>
    112. 

  112. 

  113. </ul>
    114. 

  114. <ul class="simple nested-toc-section">addProcess
    115. 

  115.   <li><a class="reference" href="#addProcess%2Cint%2CCallback" title="addProcess(pid: int; cb: Callback)">addProcess(pid: int; cb: Callback)</a></li>
    116. 

  116. 

  117. </ul>
    118. 

  118. <ul class="simple nested-toc-section">addRead
    119. 

  119.   <li><a class="reference" href="#addRead%2CAsyncFD%2CCallback" title="addRead(fd: AsyncFD; cb: Callback)">addRead(fd: AsyncFD; cb: Callback)</a></li>
    120. 

  120. 

  121. </ul>
    122. 

  122. <ul class="simple nested-toc-section">addTimer
    123. 

  123.   <li><a class="reference" href="#addTimer%2Cint%2Cbool%2CCallback" title="addTimer(timeout: int; oneshot: bool; cb: Callback)">addTimer(timeout: int; oneshot: bool; cb: Callback)</a></li>
    124. 

  124. 

  125. </ul>
    126. 

  126. <ul class="simple nested-toc-section">addWrite
    127. 

  127.   <li><a class="reference" href="#addWrite%2CAsyncFD%2CCallback" title="addWrite(fd: AsyncFD; cb: Callback)">addWrite(fd: AsyncFD; cb: Callback)</a></li>
    128. 

  128. 

  129. </ul>
    130. 

  130. <ul class="simple nested-toc-section">callSoon
    131. 

  131.   <li><a class="reference" href="#callSoon%2Cproc%29" title="callSoon(cbproc: proc () {.gcsafe.})">callSoon(cbproc: proc () {.gcsafe.})</a></li>
    132. 

  132. 

  133. </ul>
    134. 

  134. <ul class="simple nested-toc-section">close
    135. 

  135.   <li><a class="reference" href="#close%2CAsyncEvent" title="close(ev: AsyncEvent)">close(ev: AsyncEvent)</a></li>
    136. 

  136. 

  137. </ul>
    138. 

  138. <ul class="simple nested-toc-section">closeSocket
    139. 

  139.   <li><a class="reference" href="#closeSocket%2CAsyncFD" title="closeSocket(socket: AsyncFD)">closeSocket(socket: AsyncFD)</a></li>
    140. 

  140. 

  141. </ul>
    142. 

  142. <ul class="simple nested-toc-section">connect
    143. 

  143.   <li><a class="reference" href="#connect%2CAsyncFD%2Cstring%2CPort" title="connect(socket: AsyncFD; address: string; port: Port; domain = Domain.AF_INET): owned(
    144. 

  144.     Future[void])">connect(socket: AsyncFD; address: string; port: Port; domain = Domain.AF_INET): owned(
    145. 

  145.     Future[void])</a></li>
    146. 

  146. 

  147. </ul>
    148. 

  148. <ul class="simple nested-toc-section">contains
    149. 

  149.   <li><a class="reference" href="#contains%2CPDispatcher%2CAsyncFD" title="contains(disp: PDispatcher; fd: AsyncFD): bool">contains(disp: PDispatcher; fd: AsyncFD): bool</a></li>
    150. 

  150. 

  151. </ul>
    152. 

  152. <ul class="simple nested-toc-section">createAsyncNativeSocket
    153. 

  153.   <li><a class="reference" href="#createAsyncNativeSocket%2Ccint%2Ccint%2Ccint" title="createAsyncNativeSocket(domain: cint; sockType: cint; protocol: cint;
    154. 

  154.                         inheritable = defined(nimInheritHandles)): AsyncFD">createAsyncNativeSocket(domain: cint; sockType: cint; protocol: cint;
    155. 

  155.                         inheritable = defined(nimInheritHandles)): AsyncFD</a></li>
    156. 

  156. <li><a class="reference" href="#createAsyncNativeSocket%2CDomain%2CSockType%2CProtocol" title="createAsyncNativeSocket(domain: Domain = Domain.AF_INET;
    157. 

  157.                         sockType: SockType = SOCK_STREAM;
    158. 

  158.                         protocol: Protocol = IPPROTO_TCP;
    159. 

  159.                         inheritable = defined(nimInheritHandles)): AsyncFD">createAsyncNativeSocket(domain: Domain = Domain.AF_INET;
    160. 

  160.                         sockType: SockType = SOCK_STREAM;
    161. 

  161.                         protocol: Protocol = IPPROTO_TCP;
    162. 

  162.                         inheritable = defined(nimInheritHandles)): AsyncFD</a></li>
    163. 

  163. 

  164. </ul>
    165. 

  165. <ul class="simple nested-toc-section">dial
    166. 

  166.   <li><a class="reference" href="#dial%2Cstring%2CPort%2CProtocol" title="dial(address: string; port: Port; protocol: Protocol = IPPROTO_TCP): owned(
    167. 

  167.     Future[AsyncFD])">dial(address: string; port: Port; protocol: Protocol = IPPROTO_TCP): owned(
    168. 

  168.     Future[AsyncFD])</a></li>
    169. 

  169. 

  170. </ul>
    171. 

  171. <ul class="simple nested-toc-section">drain
    172. 

  172.   <li><a class="reference" href="#drain%2Cint" title="drain(timeout = 500)">drain(timeout = 500)</a></li>
    173. 

  173. 

  174. </ul>
    175. 

  175. <ul class="simple nested-toc-section">getGlobalDispatcher
    176. 

  176.   <li><a class="reference" href="#getGlobalDispatcher" title="getGlobalDispatcher(): PDispatcher">getGlobalDispatcher(): PDispatcher</a></li>
    177. 

  177. 

  178. </ul>
    179. 

  179. <ul class="simple nested-toc-section">getIoHandler
    180. 

  180.   <li><a class="reference" href="#getIoHandler%2CPDispatcher" title="getIoHandler(disp: PDispatcher): Handle">getIoHandler(disp: PDispatcher): Handle</a></li>
    181. 

  181. 

  182. </ul>
    183. 

  183. <ul class="simple nested-toc-section">hasPendingOperations
    184. 

  184.   <li><a class="reference" href="#hasPendingOperations" title="hasPendingOperations(): bool">hasPendingOperations(): bool</a></li>
    185. 

  185. 

  186. </ul>
    187. 

  187. <ul class="simple nested-toc-section">maxDescriptors
    188. 

  188.   <li><a class="reference" href="#maxDescriptors" title="maxDescriptors(): int">maxDescriptors(): int</a></li>
    189. 

  189. 

  190. </ul>
    191. 

  191. <ul class="simple nested-toc-section">newAsyncEvent
    192. 

  192.   <li><a class="reference" href="#newAsyncEvent" title="newAsyncEvent(): AsyncEvent">newAsyncEvent(): AsyncEvent</a></li>
    193. 

  193. 

  194. </ul>
    195. 

  195. <ul class="simple nested-toc-section">newCustom
    196. 

  196.   <li><a class="reference" href="#newCustom" title="newCustom(): CustomRef">newCustom(): CustomRef</a></li>
    197. 

  197. 

  198. </ul>
    199. 

  199. <ul class="simple nested-toc-section">newDispatcher
    200. 

  200.   <li><a class="reference" href="#newDispatcher" title="newDispatcher(): owned PDispatcher">newDispatcher(): owned PDispatcher</a></li>
    201. 

  201. 

  202. </ul>
    203. 

  203. <ul class="simple nested-toc-section">poll
    204. 

  204.   <li><a class="reference" href="#poll%2Cint" title="poll(timeout = 500)">poll(timeout = 500)</a></li>
    205. 

  205. 

  206. </ul>
    207. 

  207. <ul class="simple nested-toc-section">readAll
    208. 

  208.   <li><a class="reference" href="#readAll%2CFutureStream%5Bstring%5D" title="readAll(future: FutureStream[string]): owned(Future[string])">readAll(future: FutureStream[string]): owned(Future[string])</a></li>
    209. 

  209. 

  210. </ul>
    211. 

  211. <ul class="simple nested-toc-section">recv
    212. 

  212.   <li><a class="reference" href="#recv%2CAsyncFD%2Cint" title="recv(socket: AsyncFD; size: int; flags = {SafeDisconn}): owned(Future[string])">recv(socket: AsyncFD; size: int; flags = {SafeDisconn}): owned(Future[string])</a></li>
    213. 

  213. 

  214. </ul>
    215. 

  215. <ul class="simple nested-toc-section">recvFromInto
    216. 

  216.   <li><a class="reference" href="#recvFromInto%2CAsyncFD%2Cpointer%2Cint%2Cptr.SockAddr%2Cptr.SockLen" title="recvFromInto(socket: AsyncFD; data: pointer; size: int; saddr: ptr SockAddr;
    217. 

  217.              saddrLen: ptr SockLen; flags = {SafeDisconn}): owned(Future[int])">recvFromInto(socket: AsyncFD; data: pointer; size: int; saddr: ptr SockAddr;
    218. 

  218.              saddrLen: ptr SockLen; flags = {SafeDisconn}): owned(Future[int])</a></li>
    219. 

  219. 

  220. </ul>
    221. 

  221. <ul class="simple nested-toc-section">recvInto
    222. 

  222.   <li><a class="reference" href="#recvInto%2CAsyncFD%2Cpointer%2Cint" title="recvInto(socket: AsyncFD; buf: pointer; size: int; flags = {SafeDisconn}): owned(
    223. 

  223.     Future[int])">recvInto(socket: AsyncFD; buf: pointer; size: int; flags = {SafeDisconn}): owned(
    224. 

  224.     Future[int])</a></li>
    225. 

  225. 

  226. </ul>
    227. 

  227. <ul class="simple nested-toc-section">register
    228. 

  228.   <li><a class="reference" href="#register%2CAsyncFD" title="register(fd: AsyncFD)">register(fd: AsyncFD)</a></li>
    229. 

  229. 

  230. </ul>
    231. 

  231. <ul class="simple nested-toc-section">runForever
    232. 

  232.   <li><a class="reference" href="#runForever" title="runForever()">runForever()</a></li>
    233. 

  233. 

  234. </ul>
    235. 

  235. <ul class="simple nested-toc-section">send
    236. 

  236.   <li><a class="reference" href="#send%2CAsyncFD%2Cpointer%2Cint" title="send(socket: AsyncFD; buf: pointer; size: int; flags = {SafeDisconn}): owned(
    237. 

  237.     Future[void])">send(socket: AsyncFD; buf: pointer; size: int; flags = {SafeDisconn}): owned(
    238. 

  238.     Future[void])</a></li>
    239. 

  239. <li><a class="reference" href="#send%2CAsyncFD%2Cstring" title="send(socket: AsyncFD; data: string; flags = {SafeDisconn}): owned(Future[void])">send(socket: AsyncFD; data: string; flags = {SafeDisconn}): owned(Future[void])</a></li>
    240. 

  240. 

  241. </ul>
    242. 

  242. <ul class="simple nested-toc-section">sendTo
    243. 

  243.   <li><a class="reference" href="#sendTo%2CAsyncFD%2Cpointer%2Cint%2Cptr.SockAddr%2CSockLen" title="sendTo(socket: AsyncFD; data: pointer; size: int; saddr: ptr SockAddr;
    244. 

  244.        saddrLen: SockLen; flags = {SafeDisconn}): owned(Future[void])">sendTo(socket: AsyncFD; data: pointer; size: int; saddr: ptr SockAddr;
    245. 

  245.        saddrLen: SockLen; flags = {SafeDisconn}): owned(Future[void])</a></li>
    246. 

  246. 

  247. </ul>
    248. 

  248. <ul class="simple nested-toc-section">setGlobalDispatcher
    249. 

  249.   <li><a class="reference" href="#setGlobalDispatcher%2CsinkPDispatcher" title="setGlobalDispatcher(disp: sink PDispatcher)">setGlobalDispatcher(disp: sink PDispatcher)</a></li>
    250. 

  250. 

  251. </ul>
    252. 

  252. <ul class="simple nested-toc-section">setInheritable
    253. 

  253.   <li><a class="reference" href="#setInheritable%2CAsyncFD%2Cbool" title="setInheritable(fd: AsyncFD; inheritable: bool): bool">setInheritable(fd: AsyncFD; inheritable: bool): bool</a></li>
    254. 

  254. 

  255. </ul>
    256. 

  256. <ul class="simple nested-toc-section">sleepAsync
    257. 

  257.   <li><a class="reference" href="#sleepAsync" title="sleepAsync(ms: int | float): owned(Future[void])">sleepAsync(ms: int | float): owned(Future[void])</a></li>
    258. 

  258. 

  259. </ul>
    260. 

  260. <ul class="simple nested-toc-section">trigger
    261. 

  261.   <li><a class="reference" href="#trigger%2CAsyncEvent" title="trigger(ev: AsyncEvent)">trigger(ev: AsyncEvent)</a></li>
    262. 

  262. 

  263. </ul>
    264. 

  264. <ul class="simple nested-toc-section">unregister
    265. 

  265.   <li><a class="reference" href="#unregister%2CAsyncEvent" title="unregister(ev: AsyncEvent)">unregister(ev: AsyncEvent)</a></li>
    266. 

  266. <li><a class="reference" href="#unregister%2CAsyncFD" title="unregister(fd: AsyncFD)">unregister(fd: AsyncFD)</a></li>
    267. 

  267. 

  268. </ul>
    269. 

  269. <ul class="simple nested-toc-section">waitFor
    270. 

  270.   <li><a class="reference" href="#waitFor%2CFuture%5BT%5D" title="waitFor[T](fut: Future[T]): T">waitFor[T](fut: Future[T]): T</a></li>
    271. 

  271. 

  272. </ul>
    273. 

  273. <ul class="simple nested-toc-section">withTimeout
    274. 

  274.   <li><a class="reference" href="#withTimeout%2CFuture%5BT%5D%2Cint" title="withTimeout[T](fut: Future[T]; timeout: int): owned(Future[bool])">withTimeout[T](fut: Future[T]; timeout: int): owned(Future[bool])</a></li>
    275. 

  275. 

  276. </ul>
    277. 

  277. 

  278.     </ul>
    279. 

  279.   </details>
    280. 

  280. </li>
    281. 

  281. 

  282. </ul>
    283. 

  283. 

  284.   </div>
    285. 

  285.   <div class="nine columns" id="content">
    286. 

  286.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    287. 

  287. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    288. 

  288. 

  289.     <div id="tocRoot"></div>
    290. 

  290.     
    291. 

  291.     <p class="module-desc"><p>This module implements asynchronous IO. This includes a dispatcher, a <tt class="docutils literal"><span class="pre"><span class="Identifier">Future</span></span></tt> type implementation, and an <tt class="docutils literal"><span class="pre"><span class="Identifier">async</span></span></tt> macro which allows asynchronous code to be written in a synchronous style with the <tt class="docutils literal"><span class="pre"><span class="Identifier">await</span></span></tt> keyword.</p>
    292. 

  292. <p>The dispatcher acts as a kind of event loop. You must call <tt class="docutils literal"><span class="pre"><span class="Identifier">poll</span></span></tt> on it (or a function which does so for you such as <tt class="docutils literal"><span class="pre"><span class="Identifier">waitFor</span></span></tt> or <tt class="docutils literal"><span class="pre"><span class="Identifier">runForever</span></span></tt>) in order to poll for any outstanding events. The underlying implementation is based on epoll on Linux, IO Completion Ports on Windows and select on other operating systems.</p>
    293. 

  293. <p>The <tt class="docutils literal"><span class="pre"><span class="Identifier">poll</span></span></tt> function will not, on its own, return any events. Instead an appropriate <tt class="docutils literal"><span class="pre"><span class="Identifier">Future</span></span></tt> object will be completed. A <tt class="docutils literal"><span class="pre"><span class="Identifier">Future</span></span></tt> is a type which holds a value which is not yet available, but which <em>may</em> be available in the future. You can check whether a future is finished by using the <tt class="docutils literal"><span class="pre"><span class="Identifier">finished</span></span></tt> function. When a future is finished it means that either the value that it holds is now available or it holds an error instead. The latter situation occurs when the operation to complete a future fails with an exception. You can distinguish between the two situations with the <tt class="docutils literal"><span class="pre"><span class="Identifier">failed</span></span></tt> function.</p>
    294. 

  294. <p>Future objects can also store a callback procedure which will be called automatically once the future completes.</p>
    295. 

  295. <p>Futures therefore can be thought of as an implementation of the proactor pattern. In this pattern you make a request for an action, and once that action is fulfilled a future is completed with the result of that action. Requests can be made by calling the appropriate functions. For example: calling the <tt class="docutils literal"><span class="pre"><span class="Identifier">recv</span></span></tt> function will create a request for some data to be read from a socket. The future which the <tt class="docutils literal"><span class="pre"><span class="Identifier">recv</span></span></tt> function returns will then complete once the requested amount of data is read <strong>or</strong> an exception occurs.</p>
    296. 

  296. <p>Code to read some data from a socket may look something like this:</p>
    297. 

  297. <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">future</span> <span class="Operator">=</span> <span class="Identifier">socket</span><span class="Operator">.</span><span class="Identifier">recv</span><span class="Punctuation">(</span><span class="DecNumber">100</span><span class="Punctuation">)</span>
    298. 

  298. <span class="Identifier">future</span><span class="Operator">.</span><span class="Identifier">addCallback</span><span class="Punctuation">(</span>
    299. 

  299.   <span class="Keyword">proc</span> <span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">=</span>
    300. 

  300.     <span class="Identifier">echo</span><span class="Punctuation">(</span><span class="Identifier">future</span><span class="Operator">.</span><span class="Identifier">read</span><span class="Punctuation">)</span>
    301. 

  301. <span class="Punctuation">)</span></pre></p>
    302. 

  302. <p>All asynchronous functions returning a <tt class="docutils literal"><span class="pre"><span class="Identifier">Future</span></span></tt> will not block. They will not however return immediately. An asynchronous function will have code which will be executed before an asynchronous request is made, in most cases this code sets up the request.</p>
    303. 

  303. <p>In the above example, the <tt class="docutils literal"><span class="pre"><span class="Identifier">recv</span></span></tt> function will return a brand new <tt class="docutils literal"><span class="pre"><span class="Identifier">Future</span></span></tt> instance once the request for data to be read from the socket is made. This <tt class="docutils literal"><span class="pre"><span class="Identifier">Future</span></span></tt> instance will complete once the requested amount of data is read, in this case it is 100 bytes. The second line sets a callback on this future which will be called once the future completes. All the callback does is write the data stored in the future to <tt class="docutils literal"><span class="pre"><span class="Identifier">stdout</span></span></tt>. The <tt class="docutils literal"><span class="pre"><span class="Identifier">read</span></span></tt> function is used for this and it checks whether the future completes with an error for you (if it did, it will simply raise the error), if there is no error, however, it returns the value of the future.</p>
    304. 

  304. 

  305. <h1><a class="toc-backref" id="asynchronous-procedures" href="#asynchronous-procedures">Asynchronous procedures</a></h1><p>Asynchronous procedures remove the pain of working with callbacks. They do this by allowing you to write asynchronous code the same way as you would write synchronous code.</p>
    306. 

  306. <p>An asynchronous procedure is marked using the <tt class="docutils literal"><span class="pre"><span class="Punctuation">{</span><span class="Operator">.</span><span class="Identifier">async</span><span class="Operator">.</span><span class="Punctuation">}</span></span></tt> pragma. When marking a procedure with the <tt class="docutils literal"><span class="pre"><span class="Punctuation">{</span><span class="Operator">.</span><span class="Identifier">async</span><span class="Operator">.</span><span class="Punctuation">}</span></span></tt> pragma it must have a <tt class="docutils literal"><span class="pre"><span class="Identifier">Future</span><span class="Punctuation">[</span><span class="Identifier">T</span><span class="Punctuation">]</span></span></tt> return type or no return type at all. If you do not specify a return type then <tt class="docutils literal"><span class="pre"><span class="Identifier">Future</span><span class="Punctuation">[</span><span class="Identifier">void</span><span class="Punctuation">]</span></span></tt> is assumed.</p>
    307. 

  307. <p>Inside asynchronous procedures <tt class="docutils literal"><span class="pre"><span class="Identifier">await</span></span></tt> can be used to call any procedures which return a <tt class="docutils literal"><span class="pre"><span class="Identifier">Future</span></span></tt>; this includes asynchronous procedures. When a procedure is &quot;awaited&quot;, the asynchronous procedure it is awaited in will suspend its execution until the awaited procedure's Future completes. At which point the asynchronous procedure will resume its execution. During the period when an asynchronous procedure is suspended other asynchronous procedures will be run by the dispatcher.</p>
    308. 

  308. <p>The <tt class="docutils literal"><span class="pre"><span class="Identifier">await</span></span></tt> call may be used in many contexts. It can be used on the right hand side of a variable declaration: <tt class="docutils literal"><span class="pre"><span class="Keyword">var</span> <span class="Identifier">data</span> <span class="Operator">=</span> <span class="Identifier">await</span> <span class="Identifier">socket</span><span class="Operator">.</span><span class="Identifier">recv</span><span class="Punctuation">(</span><span class="DecNumber">100</span><span class="Punctuation">)</span></span></tt>, in which case the variable will be set to the value of the future automatically. It can be used to await a <tt class="docutils literal"><span class="pre"><span class="Identifier">Future</span></span></tt> object, and it can be used to await a procedure returning a <tt class="docutils literal"><span class="pre"><span class="Identifier">Future</span><span class="Punctuation">[</span><span class="Identifier">void</span><span class="Punctuation">]</span></span></tt>: <tt class="docutils literal"><span class="pre"><span class="Identifier">await</span> <span class="Identifier">socket</span><span class="Operator">.</span><span class="Identifier">send</span><span class="Punctuation">(</span><span class="StringLit">&quot;foobar&quot;</span><span class="Punctuation">)</span></span></tt>.</p>
    309. 

  309. <p>If an awaited future completes with an error, then <tt class="docutils literal"><span class="pre"><span class="Identifier">await</span></span></tt> will re-raise this error. To avoid this, you can use the <tt class="docutils literal"><span class="pre"><span class="Keyword">yield</span></span></tt> keyword instead of <tt class="docutils literal"><span class="pre"><span class="Identifier">await</span></span></tt>. The following section shows different ways that you can handle exceptions in async procs.</p>
    310. 

  310. <div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Caution:</b></span>
    311. 

  311. Procedures marked {.async.} do not support mutable parameters such as <tt class="docutils literal"><span class="pre"><span class="Keyword">var</span> <span class="Identifier">int</span></span></tt>. References such as <tt class="docutils literal"><span class="pre"><span class="Keyword">ref</span> <span class="Identifier">int</span></span></tt> should be used instead.</div>
    312. 

  312. 

  313. <h2><a class="toc-backref" id="asynchronous-procedures-handling-exceptions" href="#asynchronous-procedures-handling-exceptions">Handling Exceptions</a></h2><p>You can handle exceptions in the same way as in ordinary Nim code; by using the try statement:</p>
    314. 

  314. <p><pre class="listing"><span class="Keyword">try</span><span class="Punctuation">:</span>
    315. 

  315.   <span class="Keyword">let</span> <span class="Identifier">data</span> <span class="Operator">=</span> <span class="Identifier">await</span> <span class="Identifier">sock</span><span class="Operator">.</span><span class="Identifier">recv</span><span class="Punctuation">(</span><span class="DecNumber">100</span><span class="Punctuation">)</span>
    316. 

  316.   <span class="Identifier">echo</span><span class="Punctuation">(</span><span class="StringLit">&quot;Received &quot;</span><span class="Punctuation">,</span> <span class="Identifier">data</span><span class="Punctuation">)</span>
    317. 

  317. <span class="Keyword">except</span><span class="Punctuation">:</span>
    318. 

  318.   <span class="Comment"># Handle exception</span></pre></p>
    319. 

  319. <p>An alternative approach to handling exceptions is to use <tt class="docutils literal"><span class="pre"><span class="Keyword">yield</span></span></tt> on a future then check the future's <tt class="docutils literal"><span class="pre"><span class="Identifier">failed</span></span></tt> property. For example:</p>
    320. 

  320. <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">future</span> <span class="Operator">=</span> <span class="Identifier">sock</span><span class="Operator">.</span><span class="Identifier">recv</span><span class="Punctuation">(</span><span class="DecNumber">100</span><span class="Punctuation">)</span>
    321. 

  321. <span class="Keyword">yield</span> <span class="Identifier">future</span>
    322. 

  322. <span class="Keyword">if</span> <span class="Identifier">future</span><span class="Operator">.</span><span class="Identifier">failed</span><span class="Punctuation">:</span>
    323. 

  323.   <span class="Comment"># Handle exception</span></pre></p>
    324. 

  324. 

  325. <h1><a class="toc-backref" id="discarding-futures" href="#discarding-futures">Discarding futures</a></h1><p>Futures should <strong>never</strong> be discarded directly because they may contain errors. If you do not care for the result of a Future then you should use the <tt class="docutils literal"><span class="pre"><span class="Identifier">asyncCheck</span></span></tt> procedure instead of the <tt class="docutils literal"><span class="pre"><span class="Keyword">discard</span></span></tt> keyword. Note that this does not wait for completion, and you should use <tt class="docutils literal"><span class="pre"><span class="Identifier">waitFor</span></span></tt> or <tt class="docutils literal"><span class="pre"><span class="Identifier">await</span></span></tt> for that purpose.</p>
    326. 

  326. <div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
    327. 

  327. <tt class="docutils literal"><span class="pre"><span class="Identifier">await</span></span></tt> also checks if the future fails, so you can safely discard its result.</div>
    328. 

  328. 

  329. <h1><a class="toc-backref" id="handling-futures" href="#handling-futures">Handling futures</a></h1><p>There are many different operations that apply to a future. The three primary high-level operations are <tt class="docutils literal"><span class="pre"><span class="Identifier">asyncCheck</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">waitFor</span></span></tt>, and <tt class="docutils literal"><span class="pre"><span class="Identifier">await</span></span></tt>.</p>
    330. 

  330. <ul class="simple"><li><tt class="docutils literal"><span class="pre"><span class="Identifier">asyncCheck</span></span></tt>: Raises an exception if the future fails. It neither waits for the future to finish nor returns the result of the future.</li>
    331. 

  331. <li><tt class="docutils literal"><span class="pre"><span class="Identifier">waitFor</span></span></tt>: Polls the event loop and blocks the current thread until the future finishes. This is often used to call an async procedure from a synchronous context and should never be used in an <tt class="docutils literal"><span class="pre"><span class="Identifier">async</span></span></tt> proc.</li>
    332. 

  332. <li><tt class="docutils literal"><span class="pre"><span class="Identifier">await</span></span></tt>: Pauses execution in the current async procedure until the future finishes. While the current procedure is paused, other async procedures will continue running. Should be used instead of <tt class="docutils literal"><span class="pre"><span class="Identifier">waitFor</span></span></tt> in an async procedure.</li>
    333. 

  333. </ul>
    334. 

  334. <p>Here is a handy quick reference chart showing their high-level differences:</p>
    335. 

  335. <table border="1" class="docutils"><tr><th>Procedure</th><th>Context</th><th>Blocking</th></tr>
    336. 

  336. <tr><td><tt class="docutils literal"><span class="pre"><span class="Identifier">asyncCheck</span></span></tt></td><td>non-async and async</td><td>non-blocking</td></tr>
    337. 

  337. <tr><td><tt class="docutils literal"><span class="pre"><span class="Identifier">waitFor</span></span></tt></td><td>non-async</td><td>blocks current thread</td></tr>
    338. 

  338. <tr><td><tt class="docutils literal"><span class="pre"><span class="Identifier">await</span></span></tt></td><td>async</td><td>suspends current proc</td></tr>
    339. 

  339. </table>
    340. 

  340. <h1><a class="toc-backref" id="examples" href="#examples">Examples</a></h1><p>For examples take a look at the documentation for the modules implementing asynchronous IO. A good place to start is the <a class="reference external" href="asyncnet.html">asyncnet module</a>.</p>
    341. 

  341. 

  342. <h1><a class="toc-backref" id="investigating-pending-futures" href="#investigating-pending-futures">Investigating pending futures</a></h1><p>It's possible to get into a situation where an async proc, or more accurately a <tt class="docutils literal"><span class="pre"><span class="Identifier">Future</span><span class="Punctuation">[</span><span class="Identifier">T</span><span class="Punctuation">]</span></span></tt> gets stuck and never completes. This can happen for various reasons and can cause serious memory leaks. When this occurs it's hard to identify the procedure that is stuck.</p>
    343. 

  343. <p>Thankfully there is a mechanism which tracks the count of each pending future. All you need to do to enable it is compile with <tt class="docutils literal"><span class="pre"><span class="Operator">-</span><span class="Identifier">d</span><span class="Punctuation">:</span><span class="Identifier">futureLogging</span></span></tt> and use the <tt class="docutils literal"><span class="pre"><span class="Identifier">getFuturesInProgress</span></span></tt> procedure to get the list of pending futures together with the stack traces to the moment of their creation.</p>
    344. 

  344. <p>You may also find it useful to use this <a class="reference external" href="https://github.com/dom96/prometheus">prometheus package</a> which will log the pending futures into prometheus, allowing you to analyse them via a nice graph.</p>
    345. 

  345. 

  346. <h1><a class="toc-backref" id="limitationsslashbugs" href="#limitationsslashbugs">Limitations/Bugs</a></h1><ul class="simple"><li>The effect system (<tt class="docutils literal"><span class="pre"><span class="Identifier">raises</span><span class="Punctuation">:</span> <span class="Punctuation">[</span><span class="Punctuation">]</span></span></tt>) does not work with async procedures.</li>
    347. 

  347. <li>Mutable parameters are not supported by async procedures.</li>
    348. 

  348. </ul>
    349. 

  349. 

  350. <h1><a class="toc-backref" id="multiple-async-backend-support" href="#multiple-async-backend-support">Multiple async backend support</a></h1><p>Thanks to its powerful macro support, Nim allows <tt class="docutils literal"><span class="pre">async</span></tt>/<tt class="docutils literal"><span class="pre">await</span></tt> to be implemented in libraries with only minimal support from the language - as such, multiple <tt class="docutils literal"><span class="pre">async</span></tt> libraries exist, including <tt class="docutils literal"><span class="pre">asyncdispatch</span></tt> and <tt class="docutils literal"><span class="pre">chronos</span></tt>, and more may come to be developed in the future.</p>
    351. 

  351. <p>Libraries built on top of async/await may wish to support multiple async backends - the best way to do so is to create separate modules for each backend that may be imported side-by-side.</p>
    352. 

  352. <p>An alternative way is to select backend using a global compile flag - this method makes it difficult to compose applications that use both backends as may happen with transitive dependencies, but may be appropriate in some cases - libraries choosing this path should call the flag <tt class="docutils literal"><span class="pre"><span class="Identifier">asyncBackend</span></span></tt>, allowing applications to choose the backend with <tt class="docutils literal"><span class="pre"><span class="Operator">-</span><span class="Identifier">d</span><span class="Punctuation">:</span><span class="Identifier">asyncBackend</span><span class="Operator">=&lt;</span><span class="Identifier">backend_name</span><span class="Operator">&gt;</span></span></tt>.</p>
    353. 

  353. <p>Known <tt class="docutils literal"><span class="pre"><span class="Identifier">async</span></span></tt> backends include:</p>
    354. 

  354. <ul class="simple"><li><tt class="docutils literal"><span class="pre"><span class="Operator">-</span><span class="Identifier">d</span><span class="Punctuation">:</span><span class="Identifier">asyncBackend</span><span class="Operator">=</span><span class="Identifier">none</span></span></tt>: disable <tt class="docutils literal"><span class="pre"><span class="Identifier">async</span></span></tt> support completely</li>
    355. 

  355. <li><tt class="docutils literal"><span class="pre"><span class="Operator">-</span><span class="Identifier">d</span><span class="Punctuation">:</span><span class="Identifier">asyncBackend</span><span class="Operator">=</span><span class="Identifier">asyncdispatch</span></span></tt>: <a class="reference external" href="https://nim-lang.org/docs/asyncdispatch.html">https://nim-lang.org/docs/asyncdispatch.html</a></li>
    356. 

  356. <li><tt class="docutils literal"><span class="pre"><span class="Operator">-</span><span class="Identifier">d</span><span class="Punctuation">:</span><span class="Identifier">asyncBackend</span><span class="Operator">=</span><span class="Identifier">chronos</span></span></tt>: <a class="reference external" href="https://github.com/status-im/nim-chronos/">https://github.com/status-im/nim-chronos/</a></li>
    357. 

  357. </ul>
    358. 

  358. <p><tt class="docutils literal"><span class="pre">none</span></tt> can be used when a library supports both a synchronous and asynchronous API, to disable the latter.</p>
    359. 

  359. </p>
    360. 

  360.     <div class="section" id="6">
    361. 

  361.   <h1><a class="toc-backref" href="#6">Imports</a></h1>
    362. 

  362.   <dl class="item">
    363. 

  363.     <a class="reference external" href="os.html">os</a>, <a class="reference external" href="tables.html">tables</a>, <a class="reference external" href="strutils.html">strutils</a>, <a class="reference external" href="times.html">times</a>, <a class="reference external" href="heapqueue.html">heapqueue</a>, <a class="reference external" href="options.html">options</a>, <a class="reference external" href="asyncstreams.html">asyncstreams</a>, <a class="reference external" href="math.html">math</a>, <a class="reference external" href="monotimes.html">monotimes</a>, <a class="reference external" href="asyncfutures.html">asyncfutures</a>, <a class="reference external" href="nativesockets.html">nativesockets</a>, <a class="reference external" href="net.html">net</a>, <a class="reference external" href="deques.html">deques</a>, <a class="reference external" href="assertions.html">assertions</a>, <a class="reference external" href="syncio.html">syncio</a>, <a class="reference external" href="winlean.html">winlean</a>, <a class="reference external" href="sets.html">sets</a>, <a class="reference external" href="hashes.html">hashes</a>, <a class="reference external" href="asyncmacro.html">asyncmacro</a>, <a class="reference external" href="posix.html">posix</a>
    364. 

  364.   </dl>
    365. 

  365. </div>
    366. 

  366. <div class="section" id="7">
    367. 

  367.   <h1><a class="toc-backref" href="#7">Types</a></h1>
    368. 

  368.   <dl class="item">
    369. 

  369.     <div id="AsyncEvent">
    370. 

  370.   <dt><pre><a href="asyncdispatch.html#AsyncEvent"><span class="Identifier">AsyncEvent</span></a> <span class="Other">=</span> <span class="Keyword">ptr</span> <span class="Identifier">AsyncEventImpl</span></pre></dt>
    371. 

  371.   <dd>
    372. 

  372.     
    373. 

  373.     
    374. 

  374.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L339" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    375. 

  375. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L339" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    376. 

  376. 

  377.   </dd>
    378. 

  378. </div>
    379. 

  379. <div id="AsyncFD">
    380. 

  380.   <dt><pre><a href="asyncdispatch.html#AsyncFD"><span class="Identifier">AsyncFD</span></a> <span class="Other">=</span> <span class="Keyword">distinct</span> <a href="system.html#int"><span class="Identifier">int</span></a></pre></dt>
    381. 

  381.   <dd>
    382. 

  382.     
    383. 

  383.     
    384. 

  384.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L326" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    385. 

  385. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L326" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    386. 

  386. 

  387.   </dd>
    388. 

  388. </div>
    389. 

  389. <div id="Callback">
    390. 

  390.   <dt><pre><a href="asyncdispatch.html#Callback"><span class="Identifier">Callback</span></a> <span class="Other">=</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">fd</span><span class="Other">:</span> <a href="asyncdispatch.html#AsyncFD"><span class="Identifier">AsyncFD</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">closure</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span></span>.}</pre></dt>
    391. 

  391.   <dd>
    392. 

  392.     
    393. 

  393.     
    394. 

  394.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L341" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    395. 

  395. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L341" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    396. 

  396. 

  397.   </dd>
    398. 

  398. </div>
    399. 

  399. <div id="CompletionData">
    400. 

  400.   <dt><pre><a href="asyncdispatch.html#CompletionData"><span class="Identifier">CompletionData</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
    401. 

  401.   <span class="Identifier">fd</span><span class="Operator">*</span><span class="Other">:</span> <a href="asyncdispatch.html#AsyncFD"><span class="Identifier">AsyncFD</span></a>
    402. 

  402.   <span class="Identifier">cb</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span><span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">fd</span><span class="Other">:</span> <a href="asyncdispatch.html#AsyncFD"><span class="Identifier">AsyncFD</span></a><span class="Other">;</span> <span class="Identifier">bytesTransferred</span><span class="Other">:</span> <a href="winlean.html#DWORD"><span class="Identifier">DWORD</span></a><span class="Other">;</span> <span class="Identifier">errcode</span><span class="Other">:</span> <a href="oserrors.html#OSErrorCode"><span class="Identifier">OSErrorCode</span></a><span class="Other">)</span> {.
    403. 

  403.       <span class="Identifier">closure</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span></span>.}<span class="Other">)</span>
    404. 

  404.   <span class="Identifier">cell</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#ForeignCell"><span class="Identifier">ForeignCell</span></a></pre></dt>
    405. 

  405.   <dd>
    406. 

  406.     
    407. 

  407.     
    408. 

  408.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L309" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    409. 

  409. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L309" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    410. 

  410. 

  411.   </dd>
    412. 

  412. </div>
    413. 

  413. <div id="CustomRef">
    414. 

  414.   <dt><pre><a href="asyncdispatch.html#CustomRef"><span class="Identifier">CustomRef</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Identifier">CustomObj</span></pre></dt>
    415. 

  415.   <dd>
    416. 

  416.     
    417. 

  417.     
    418. 

  418.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L324" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    419. 

  419. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L324" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    420. 

  420. 

  421.   </dd>
    422. 

  422. </div>
    423. 

  423. <div id="PDispatcher">
    424. 

  424.   <dt><pre><a href="asyncdispatch.html#PDispatcher"><span class="Identifier">PDispatcher</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <span class="Identifier">PDispatcherBase</span>
    425. 

  425.   <span class="Identifier">handles</span><span class="Operator">*</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><a href="asyncdispatch.html#AsyncFD"><span class="Identifier">AsyncFD</span></a><span class="Other">]</span></pre></dt>
    426. 

  426.   <dd>
    427. 

  427.     
    428. 

  428.     
    429. 

  429.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L317" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    430. 

  430. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L317" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    431. 

  431. 

  432.   </dd>
    433. 

  433. </div>
    434. 

  434. 

  435.   </dl>
    436. 

  436. </div>
    437. 

  437. <div class="section" id="12">
    438. 

  438.   <h1><a class="toc-backref" href="#12">Procs</a></h1>
    439. 

  439.   <dl class="item">
    440. 

  440.     <div id="==-procs-all">
    441. 

  441.   <div id="==,AsyncFD,AsyncFD">
    442. 

  442.   <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2CAsyncFD%2CAsyncFD"><span class="Identifier">`==`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="asyncdispatch.html#AsyncFD"><span class="Identifier">AsyncFD</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="asyncdispatch.html#AsyncFD"><span class="Identifier">AsyncFD</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">borrow</span><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 class="Other">,</span>
    443. 

  443.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    444. 

  444.   <dd>
    445. 

  445.     
    446. 

  446.     
    447. 

  447.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L344" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    448. 

  448. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L344" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    449. 

  449. 

  450.   </dd>
    451. 

  451. </div>
    452. 

  452. 

  453. </div>
    454. 

  454. <div id="accept-procs-all">
    455. 

  455.   <div id="accept,AsyncFD">
    456. 

  456.   <dt><pre><span class="Keyword">proc</span> <a href="#accept%2CAsyncFD"><span class="Identifier">accept</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="asyncdispatch.html#AsyncFD"><span class="Identifier">AsyncFD</span></a><span class="Other">;</span> <span class="Identifier">flags</span> <span class="Other">=</span> <span class="Other">{</span><span class="Identifier">SafeDisconn</span><span class="Other">}</span><span class="Other">;</span>
    457. 

  457.             <span class="Identifier">inheritable</span> <span class="Other">=</span> <span class="Identifier">defined</span><span class="Other">(</span><span class="Identifier">nimInheritHandles</span><span class="Other">)</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span><a href="asyncfutures.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span><a href="asyncdispatch.html#AsyncFD"><span class="Identifier">AsyncFD</span></a><span class="Other">]</span><span class="Other">)</span> {.
    458. 

  458.     <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="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    459. 

  459.   <dd>
    460. 

  460.     
    461. 

  461.     <p>Accepts a new connection. Returns a future containing the client socket corresponding to that connection.</p>
    462. 

  462. <p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">inheritable</span></span></tt> is false (the default), the resulting client socket will not be inheritable by child processes.</p>
    463. 

  463. <p>The future will complete when the connection is successfully accepted.</p>
    464. 

  464. 

  465.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L1954" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    466. 

  466. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L1954" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    467. 

  467. 

  468.   </dd>
    469. 

  469. </div>
    470. 

  470. 

  471. </div>
    472. 

  472. <div id="acceptAddr-procs-all">
    473. 

  473.   <div id="acceptAddr,AsyncFD">
    474. 

  474.   <dt><pre><span class="Keyword">proc</span> <a href="#acceptAddr%2CAsyncFD"><span class="Identifier">acceptAddr</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="asyncdispatch.html#AsyncFD"><span class="Identifier">AsyncFD</span></a><span class="Other">;</span> <span class="Identifier">flags</span> <span class="Other">=</span> <span class="Other">{</span><span class="Identifier">SafeDisconn</span><span class="Other">}</span><span class="Other">;</span>
    475. 

  475.                 <span class="Identifier">inheritable</span> <span class="Other">=</span> <span class="Identifier">defined</span><span class="Other">(</span><span class="Identifier">nimInheritHandles</span><span class="Other">)</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span>
    476. 

  476.     <a href="asyncfutures.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span><span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">address</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span> <span class="Identifier">client</span><span class="Other">:</span> <a href="asyncdispatch.html#AsyncFD"><span class="Identifier">AsyncFD</span></a><span class="Other">]</span><span class="Other">]</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
    477. 

  477.     <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span>
    478. 

  478.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    479. 

  479.   <dd>
    480. 

  480.     
    481. 

  481.     <p>Accepts a new connection. Returns a future containing the client socket corresponding to that connection and the remote address of the client. The future will complete when the connection is successfully accepted.</p>
    482. 

  482. <p>The resulting client socket is automatically registered to the dispatcher.</p>
    483. 

  483. <p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">inheritable</span></span></tt> is false (the default), the resulting client socket will not be inheritable by child processes.</p>
    484. 

  484. <p>The <tt class="docutils literal"><span class="pre"><span class="Identifier">accept</span></span></tt> call may result in an error if the connecting socket disconnects during the duration of the <tt class="docutils literal"><span class="pre"><span class="Identifier">accept</span></span></tt>. If the <tt class="docutils literal"><span class="pre"><span class="Identifier">SafeDisconn</span></span></tt> flag is specified then this error will not be raised and instead accept will be called again.</p>
    485. 

  485. 

  486.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L771" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    487. 

  487. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L771" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    488. 

  488. 

  489.   </dd>
    490. 

  490. </div>
    491. 

  491. 

  492. </div>
    493. 

  493. <div id="activeDescriptors-procs-all">
    494. 

  494.   <div id="activeDescriptors">
    495. 

  495.   <dt><pre><span class="Keyword">proc</span> <a href="#activeDescriptors"><span class="Identifier">activeDescriptors</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">inline</span><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 class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    496. 

  496.   <dd>
    497. 

  497.     
    498. 

  498.     Returns the current number of active file descriptors for the current event loop. This is a cheap operation that does not involve a system call.
    499. 

  499.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L2027" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    500. 

  500. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L2027" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    501. 

  501. 

  502.   </dd>
    503. 

  503. </div>
    504. 

  504. 

  505. </div>
    506. 

  506. <div id="addEvent-procs-all">
    507. 

  507.   <div id="addEvent,AsyncEvent,Callback">
    508. 

  508.   <dt><pre><span class="Keyword">proc</span> <a href="#addEvent%2CAsyncEvent%2CCallback"><span class="Identifier">addEvent</span></a><span class="Other">(</span><span class="Identifier">ev</span><span class="Other">:</span> <a href="asyncdispatch.html#AsyncEvent"><span class="Identifier">AsyncEvent</span></a><span class="Other">;</span> <span class="Identifier">cb</span><span class="Other">:</span> <a href="asyncdispatch.html#Callback"><span class="Identifier">Callback</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="Identifier">OSError</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 class="Other">,</span>
    509. 

  509.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    510. 

  510.   <dd>
    511. 

  511.     
    512. 

  512.     Registers callback <tt class="docutils literal"><span class="pre"><span class="Identifier">cb</span></span></tt> to be called when <tt class="docutils literal"><span class="pre"><span class="Identifier">ev</span></span></tt> will be signaled
    513. 

  513.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L1136" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    514. 

  514. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L1136" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    515. 

  515. 

  516.   </dd>
    517. 

  517. </div>
    518. 

  518. 

  519. </div>
    520. 

  520. <div id="addProcess-procs-all">
    521. 

  521.   <div id="addProcess,int,Callback">
    522. 

  522.   <dt><pre><span class="Keyword">proc</span> <a href="#addProcess%2Cint%2CCallback"><span class="Identifier">addProcess</span></a><span class="Other">(</span><span class="Identifier">pid</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">cb</span><span class="Other">:</span> <a href="asyncdispatch.html#Callback"><span class="Identifier">Callback</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="Identifier">OSError</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 class="Other">,</span>
    523. 

  523.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    524. 

  524.   <dd>
    525. 

  525.     
    526. 

  526.     Registers callback <tt class="docutils literal"><span class="pre"><span class="Identifier">cb</span></span></tt> to be called when process with process ID <tt class="docutils literal"><span class="pre"><span class="Identifier">pid</span></span></tt> exited.
    527. 

  527.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L1079" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    528. 

  528. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L1079" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    529. 

  529. 

  530.   </dd>
    531. 

  531. </div>
    532. 

  532. 

  533. </div>
    534. 

  534. <div id="addRead-procs-all">
    535. 

  535.   <div id="addRead,AsyncFD,Callback">
    536. 

  536.   <dt><pre><span class="Keyword">proc</span> <a href="#addRead%2CAsyncFD%2CCallback"><span class="Identifier">addRead</span></a><span class="Other">(</span><span class="Identifier">fd</span><span class="Other">:</span> <a href="asyncdispatch.html#AsyncFD"><span class="Identifier">AsyncFD</span></a><span class="Other">;</span> <span class="Identifier">cb</span><span class="Other">:</span> <a href="asyncdispatch.html#Callback"><span class="Identifier">Callback</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="Identifier">OSError</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 class="Other">,</span>
    537. 

  537.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    538. 

  538.   <dd>
    539. 

  539.     
    540. 

  540.     <p>Start watching the file descriptor for read availability and then call the callback <tt class="docutils literal"><span class="pre"><span class="Identifier">cb</span></span></tt>.</p>
    541. 

  541. <p>This is not <tt class="docutils literal"><span class="pre"><span class="Identifier">pure</span></span></tt> mechanism for Windows Completion Ports (IOCP), so if you can avoid it, please do it. Use <tt class="docutils literal"><span class="pre"><span class="Identifier">addRead</span></span></tt> only if really need it (main usecase is adaptation of unix-like libraries to be asynchronous on Windows).</p>
    542. 

  542. <p>If you use this function, you don't need to use asyncdispatch.recv() or asyncdispatch.accept(), because they are using IOCP, please use nativesockets.recv() and nativesockets.accept() instead.</p>
    543. 

  543. <p>Be sure your callback <tt class="docutils literal"><span class="pre"><span class="Identifier">cb</span></span></tt> returns <tt class="docutils literal"><span class="pre"><span class="Identifier">true</span></span></tt>, if you want to remove watch of <tt class="docutils literal"><span class="pre"><span class="Identifier">read</span></span></tt> notifications, and <tt class="docutils literal"><span class="pre"><span class="Identifier">false</span></span></tt>, if you want to continue receiving notifications.</p>
    544. 

  544. 

  545.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L974" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    546. 

  546. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L974" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    547. 

  547. 

  548.   </dd>
    549. 

  549. </div>
    550. 

  550. 

  551. </div>
    552. 

  552. <div id="addTimer-procs-all">
    553. 

  553.   <div id="addTimer,int,bool,Callback">
    554. 

  554.   <dt><pre><span class="Keyword">proc</span> <a href="#addTimer%2Cint%2Cbool%2CCallback"><span class="Identifier">addTimer</span></a><span class="Other">(</span><span class="Identifier">timeout</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">oneshot</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">;</span> <span class="Identifier">cb</span><span class="Other">:</span> <a href="asyncdispatch.html#Callback"><span class="Identifier">Callback</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="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    555. 

  555.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    556. 

  556.   <dd>
    557. 

  557.     
    558. 

  558.     <p>Registers callback <tt class="docutils literal"><span class="pre"><span class="Identifier">cb</span></span></tt> to be called when timer expired.</p>
    559. 

  559. <p>Parameters:</p>
    560. 

  560. <ul class="simple"><li><tt class="docutils literal"><span class="pre"><span class="Identifier">timeout</span></span></tt> - timeout value in milliseconds.</li>
    561. 

  561. <li><tt class="docutils literal"><span class="pre"><span class="Identifier">oneshot</span></span></tt><ul class="simple"><li><tt class="docutils literal"><span class="pre"><span class="Identifier">true</span></span></tt> - generate only one timeout event</li>
    562. 

  562. <li><tt class="docutils literal"><span class="pre"><span class="Identifier">false</span></span></tt> - generate timeout events periodically</li>
    563. 

  563. </ul>
    564. 

  564. </li>
    565. 

  565. </ul>
    566. 

  566. 

  567.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L1045" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    568. 

  568. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L1045" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    569. 

  569. 

  570.   </dd>
    571. 

  571. </div>
    572. 

  572. 

  573. </div>
    574. 

  574. <div id="addWrite-procs-all">
    575. 

  575.   <div id="addWrite,AsyncFD,Callback">
    576. 

  576.   <dt><pre><span class="Keyword">proc</span> <a href="#addWrite%2CAsyncFD%2CCallback"><span class="Identifier">addWrite</span></a><span class="Other">(</span><span class="Identifier">fd</span><span class="Other">:</span> <a href="asyncdispatch.html#AsyncFD"><span class="Identifier">AsyncFD</span></a><span class="Other">;</span> <span class="Identifier">cb</span><span class="Other">:</span> <a href="asyncdispatch.html#Callback"><span class="Identifier">Callback</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="Identifier">OSError</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 class="Other">,</span>
    577. 

  577.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    578. 

  578.   <dd>
    579. 

  579.     
    580. 

  580.     <p>Start watching the file descriptor for write availability and then call the callback <tt class="docutils literal"><span class="pre"><span class="Identifier">cb</span></span></tt>.</p>
    581. 

  581. <p>This is not <tt class="docutils literal"><span class="pre"><span class="Identifier">pure</span></span></tt> mechanism for Windows Completion Ports (IOCP), so if you can avoid it, please do it. Use <tt class="docutils literal"><span class="pre"><span class="Identifier">addWrite</span></span></tt> only if really need it (main usecase is adaptation of unix-like libraries to be asynchronous on Windows).</p>
    582. 

  582. <p>If you use this function, you don't need to use asyncdispatch.send() or asyncdispatch.connect(), because they are using IOCP, please use nativesockets.send() and nativesockets.connect() instead.</p>
    583. 

  583. <p>Be sure your callback <tt class="docutils literal"><span class="pre"><span class="Identifier">cb</span></span></tt> returns <tt class="docutils literal"><span class="pre"><span class="Identifier">true</span></span></tt>, if you want to remove watch of <tt class="docutils literal"><span class="pre"><span class="Identifier">write</span></span></tt> notifications, and <tt class="docutils literal"><span class="pre"><span class="Identifier">false</span></span></tt>, if you want to continue receiving notifications.</p>
    584. 

  584. 

  585.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L992" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    586. 

  586. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L992" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    587. 

  587. 

  588.   </dd>
    589. 

  589. </div>
    590. 

  590. 

  591. </div>
    592. 

  592. <div id="callSoon-procs-all">
    593. 

  593.   <div id="callSoon,proc)">
    594. 

  594.   <dt><pre><span class="Keyword">proc</span> <a href="#callSoon%2Cproc%29"><span class="Identifier">callSoon</span></a><span class="Other">(</span><span class="Identifier">cbproc</span><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span></span>.}<span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <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 class="Other">,</span>
    595. 

  595.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    596. 

  596.   <dd>
    597. 

  597.     
    598. 

  598.     Schedule <tt class="docutils literal"><span class="pre"><span class="Identifier">cbproc</span></span></tt> to be called as soon as possible. The callback is called when control returns to the event loop.
    599. 

  599.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L286" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    600. 

  600. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L286" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    601. 

  601. 

  602.   </dd>
    603. 

  603. </div>
    604. 

  604. 

  605. </div>
    606. 

  606. <div id="close-procs-all">
    607. 

  607.   <div id="close,AsyncEvent">
    608. 

  608.   <dt><pre><span class="Keyword">proc</span> <a href="#close%2CAsyncEvent"><span class="Identifier">close</span></a><span class="Other">(</span><span class="Identifier">ev</span><span class="Other">:</span> <a href="asyncdispatch.html#AsyncEvent"><span class="Identifier">AsyncEvent</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="Identifier">OSError</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 class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    609. 

  609.   <dd>
    610. 

  610.     
    611. 

  611.     Closes event <tt class="docutils literal"><span class="pre"><span class="Identifier">ev</span></span></tt>.
    612. 

  612.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L1129" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    613. 

  613. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L1129" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    614. 

  614. 

  615.   </dd>
    616. 

  616. </div>
    617. 

  617. 

  618. </div>
    619. 

  619. <div id="closeSocket-procs-all">
    620. 

  620.   <div id="closeSocket,AsyncFD">
    621. 

  621.   <dt><pre><span class="Keyword">proc</span> <a href="#closeSocket%2CAsyncFD"><span class="Identifier">closeSocket</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="asyncdispatch.html#AsyncFD"><span class="Identifier">AsyncFD</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 class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    622. 

  622.   <dd>
    623. 

  623.     
    624. 

  624.     Closes a socket and ensures that it is unregistered.
    625. 

  625.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L870" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    626. 

  626. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L870" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    627. 

  627. 

  628.   </dd>
    629. 

  629. </div>
    630. 

  630. 

  631. </div>
    632. 

  632. <div id="connect-procs-all">
    633. 

  633.   <div id="connect,AsyncFD,string,Port">
    634. 

  634.   <dt><pre><span class="Keyword">proc</span> <a href="#connect%2CAsyncFD%2Cstring%2CPort"><span class="Identifier">connect</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="asyncdispatch.html#AsyncFD"><span class="Identifier">AsyncFD</span></a><span class="Other">;</span> <span class="Identifier">address</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">port</span><span class="Other">:</span> <a href="nativesockets.html#Port"><span class="Identifier">Port</span></a><span class="Other">;</span>
    635. 

  635.              <span class="Identifier">domain</span> <span class="Other">=</span> <a href="nativesockets.html#Domain"><span class="Identifier">Domain</span></a><span class="Other">.</span><span class="Identifier">AF_INET</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span><a href="asyncfutures.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span><a href="system.html#void"><span class="Identifier">void</span></a><span class="Other">]</span><span class="Other">)</span> {.
    636. 

  636.     <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="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span>
    637. 

  637.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    638. 

  638.   <dd>
    639. 

  639.     
    640. 

  640.     
    641. 

  641.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L1905" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    642. 

  642. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L1905" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    643. 

  643. 

  644.   </dd>
    645. 

  645. </div>
    646. 

  646. 

  647. </div>
    648. 

  648. <div id="contains-procs-all">
    649. 

  649.   <div id="contains,PDispatcher,AsyncFD">
    650. 

  650.   <dt><pre><span class="Keyword">proc</span> <a href="#contains%2CPDispatcher%2CAsyncFD"><span class="Identifier">contains</span></a><span class="Other">(</span><span class="Identifier">disp</span><span class="Other">:</span> <a href="asyncdispatch.html#PDispatcher"><span class="Identifier">PDispatcher</span></a><span class="Other">;</span> <span class="Identifier">fd</span><span class="Other">:</span> <a href="asyncdispatch.html#AsyncFD"><span class="Identifier">AsyncFD</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</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 class="Other">,</span>
    651. 

  651.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    652. 

  652.   <dd>
    653. 

  653.     
    654. 

  654.     
    655. 

  655.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L879" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    656. 

  656. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L879" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    657. 

  657. 

  658.   </dd>
    659. 

  659. </div>
    660. 

  660. 

  661. </div>
    662. 

  662. <div id="createAsyncNativeSocket-procs-all">
    663. 

  663.   <div id="createAsyncNativeSocket,cint,cint,cint">
    664. 

  664.   <dt><pre><span class="Keyword">proc</span> <a href="#createAsyncNativeSocket%2Ccint%2Ccint%2Ccint"><span class="Identifier">createAsyncNativeSocket</span></a><span class="Other">(</span><span class="Identifier">domain</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a><span class="Other">;</span> <span class="Identifier">sockType</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a><span class="Other">;</span> <span class="Identifier">protocol</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a><span class="Other">;</span>
    665. 

  665.                              <span class="Identifier">inheritable</span> <span class="Other">=</span> <span class="Identifier">defined</span><span class="Other">(</span><span class="Identifier">nimInheritHandles</span><span class="Other">)</span><span class="Other">)</span><span class="Other">:</span> <a href="asyncdispatch.html#AsyncFD"><span class="Identifier">AsyncFD</span></a> {.
    666. 

  666.     <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="Identifier">OSError</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 class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    667. 

  667.   <dd>
    668. 

  668.     
    669. 

  669.     
    670. 

  670.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L1725" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    671. 

  671. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L1725" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    672. 

  672. 

  673.   </dd>
    674. 

  674. </div>
    675. 

  675. <div id="createAsyncNativeSocket,Domain,SockType,Protocol">
    676. 

  676.   <dt><pre><span class="Keyword">proc</span> <a href="#createAsyncNativeSocket%2CDomain%2CSockType%2CProtocol"><span class="Identifier">createAsyncNativeSocket</span></a><span class="Other">(</span><span class="Identifier">domain</span><span class="Other">:</span> <a href="nativesockets.html#Domain"><span class="Identifier">Domain</span></a> <span class="Other">=</span> <a href="nativesockets.html#Domain"><span class="Identifier">Domain</span></a><span class="Other">.</span><span class="Identifier">AF_INET</span><span class="Other">;</span>
    677. 

  677.                              <span class="Identifier">sockType</span><span class="Other">:</span> <a href="nativesockets.html#SockType"><span class="Identifier">SockType</span></a> <span class="Other">=</span> <span class="Identifier">SOCK_STREAM</span><span class="Other">;</span>
    678. 

  678.                              <span class="Identifier">protocol</span><span class="Other">:</span> <a href="nativesockets.html#Protocol"><span class="Identifier">Protocol</span></a> <span class="Other">=</span> <span class="Identifier">IPPROTO_TCP</span><span class="Other">;</span>
    679. 

  679.                              <span class="Identifier">inheritable</span> <span class="Other">=</span> <span class="Identifier">defined</span><span class="Other">(</span><span class="Identifier">nimInheritHandles</span><span class="Other">)</span><span class="Other">)</span><span class="Other">:</span> <a href="asyncdispatch.html#AsyncFD"><span class="Identifier">AsyncFD</span></a> {.
    680. 

  680.     <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="Identifier">OSError</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 class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    681. 

  681.   <dd>
    682. 

  682.     
    683. 

  683.     
    684. 

  684.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L1730" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    685. 

  685. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L1730" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    686. 

  686. 

  687.   </dd>
    688. 

  688. </div>
    689. 

  689. 

  690. </div>
    691. 

  691. <div id="dial-procs-all">
    692. 

  692.   <div id="dial,string,Port,Protocol">
    693. 

  693.   <dt><pre><span class="Keyword">proc</span> <a href="#dial%2Cstring%2CPort%2CProtocol"><span class="Identifier">dial</span></a><span class="Other">(</span><span class="Identifier">address</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">port</span><span class="Other">:</span> <a href="nativesockets.html#Port"><span class="Identifier">Port</span></a><span class="Other">;</span> <span class="Identifier">protocol</span><span class="Other">:</span> <a href="nativesockets.html#Protocol"><span class="Identifier">Protocol</span></a> <span class="Other">=</span> <span class="Identifier">IPPROTO_TCP</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span>
    694. 

  694.     <a href="asyncfutures.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span><a href="asyncdispatch.html#AsyncFD"><span class="Identifier">AsyncFD</span></a><span class="Other">]</span><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="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span>
    695. 

  695.                        <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    696. 

  696.   <dd>
    697. 

  697.     
    698. 

  698.     Establishes connection to the specified <tt class="docutils literal"><span class="pre"><span class="Identifier">address</span></span></tt>:<tt class="docutils literal"><span class="pre"><span class="Identifier">port</span></span></tt> pair via the specified protocol. The procedure iterates through possible resolutions of the <tt class="docutils literal"><span class="pre"><span class="Identifier">address</span></span></tt> until it succeeds, meaning that it seamlessly works with both IPv4 and IPv6. Returns the async file descriptor, registered in the dispatcher of the current thread, ready to send or receive data.
    699. 

  699.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L1890" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    700. 

  700. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L1890" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    701. 

  701. 

  702.   </dd>
    703. 

  703. </div>
    704. 

  704. 

  705. </div>
    706. 

  706. <div id="drain-procs-all">
    707. 

  707.   <div id="drain,int">
    708. 

  708.   <dt><pre><span class="Keyword">proc</span> <a href="#drain%2Cint"><span class="Identifier">drain</span></a><span class="Other">(</span><span class="Identifier">timeout</span> <span class="Other">=</span> <span class="DecNumber">500</span><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="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    709. 

  709.                             <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">TimeEffect</span><span class="Other">,</span> <span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    710. 

  710.   <dd>
    711. 

  711.     
    712. 

  712.     Waits for completion of <strong>all</strong> events and processes them. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">ValueError</span></span></tt> if there are no pending operations. In contrast to <tt class="docutils literal"><span class="pre"><span class="Identifier">poll</span></span></tt> this processes as many events as are available until the timeout has elapsed.
    713. 

  713.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L1696" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    714. 

  714. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L1696" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    715. 

  715. 

  716.   </dd>
    717. 

  717. </div>
    718. 

  718. 

  719. </div>
    720. 

  720. <div id="getGlobalDispatcher-procs-all">
    721. 

  721.   <div id="getGlobalDispatcher">
    722. 

  722.   <dt><pre><span class="Keyword">proc</span> <a href="#getGlobalDispatcher"><span class="Identifier">getGlobalDispatcher</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="asyncdispatch.html#PDispatcher"><span class="Identifier">PDispatcher</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 class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    723. 

  723.   <dd>
    724. 

  724.     
    725. 

  725.     
    726. 

  726.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L362" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    727. 

  727. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L362" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    728. 

  728. 

  729.   </dd>
    730. 

  730. </div>
    731. 

  731. 

  732. </div>
    733. 

  733. <div id="getIoHandler-procs-all">
    734. 

  734.   <div id="getIoHandler,PDispatcher">
    735. 

  735.   <dt><pre><span class="Keyword">proc</span> <a href="#getIoHandler%2CPDispatcher"><span class="Identifier">getIoHandler</span></a><span class="Other">(</span><span class="Identifier">disp</span><span class="Other">:</span> <a href="asyncdispatch.html#PDispatcher"><span class="Identifier">PDispatcher</span></a><span class="Other">)</span><span class="Other">:</span> <a href="winlean.html#Handle"><span class="Identifier">Handle</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 class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    736. 

  736.   <dd>
    737. 

  737.     
    738. 

  738.     Returns the underlying IO Completion Port handle (Windows) or selector (Unix) for the specified dispatcher.
    739. 

  739.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L367" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    740. 

  740. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L367" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    741. 

  741. 

  742.   </dd>
    743. 

  743. </div>
    744. 

  744. 

  745. </div>
    746. 

  746. <div id="hasPendingOperations-procs-all">
    747. 

  747.   <div id="hasPendingOperations">
    748. 

  748.   <dt><pre><span class="Keyword">proc</span> <a href="#hasPendingOperations"><span class="Identifier">hasPendingOperations</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</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 class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    749. 

  749.   <dd>
    750. 

  750.     
    751. 

  751.     Returns <tt class="docutils literal"><span class="pre"><span class="Identifier">true</span></span></tt> if the global dispatcher has pending operations.
    752. 

  752.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L390" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    753. 

  753. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L390" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    754. 

  754. 

  755.   </dd>
    756. 

  756. </div>
    757. 

  757. 

  758. </div>
    759. 

  759. <div id="maxDescriptors-procs-all">
    760. 

  760.   <div id="maxDescriptors">
    761. 

  761.   <dt><pre><span class="Keyword">proc</span> <a href="#maxDescriptors"><span class="Identifier">maxDescriptors</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    762. 

  762.   <dd>
    763. 

  763.     
    764. 

  764.     Returns the maximum number of active file descriptors for the current process. This involves a system call. For now <tt class="docutils literal"><span class="pre"><span class="Identifier">maxDescriptors</span></span></tt> is supported on the following OSes: Windows, Linux, OSX, BSD, Solaris.
    765. 

  765.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L2040" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    766. 

  766. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L2040" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    767. 

  767. 

  768.   </dd>
    769. 

  769. </div>
    770. 

  770. 

  771. </div>
    772. 

  772. <div id="newAsyncEvent-procs-all">
    773. 

  773.   <div id="newAsyncEvent">
    774. 

  774.   <dt><pre><span class="Keyword">proc</span> <a href="#newAsyncEvent"><span class="Identifier">newAsyncEvent</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="asyncdispatch.html#AsyncEvent"><span class="Identifier">AsyncEvent</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="Identifier">OSError</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 class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    775. 

  775.   <dd>
    776. 

  776.     
    777. 

  777.     <p>Creates a new thread-safe <tt class="docutils literal"><span class="pre"><span class="Identifier">AsyncEvent</span></span></tt> object.</p>
    778. 

  778. <p>New <tt class="docutils literal"><span class="pre"><span class="Identifier">AsyncEvent</span></span></tt> object is not automatically registered with dispatcher like <tt class="docutils literal"><span class="pre"><span class="Identifier">AsyncSocket</span></span></tt>.</p>
    779. 

  779. 

  780.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L1098" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    781. 

  781. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L1098" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    782. 

  782. 

  783.   </dd>
    784. 

  784. </div>
    785. 

  785. 

  786. </div>
    787. 

  787. <div id="newCustom-procs-all">
    788. 

  788.   <div id="newCustom">
    789. 

  789.   <dt><pre><span class="Keyword">proc</span> <a href="#newCustom"><span class="Identifier">newCustom</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="asyncdispatch.html#CustomRef"><span class="Identifier">CustomRef</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 class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    790. 

  790.   <dd>
    791. 

  791.     
    792. 

  792.     
    793. 

  793.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L487" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    794. 

  794. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L487" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    795. 

  795. 

  796.   </dd>
    797. 

  797. </div>
    798. 

  798. 

  799. </div>
    800. 

  800. <div id="newDispatcher-procs-all">
    801. 

  801.   <div id="newDispatcher">
    802. 

  802.   <dt><pre><span class="Keyword">proc</span> <a href="#newDispatcher"><span class="Identifier">newDispatcher</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span> <span class="Identifier">PDispatcher</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 class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    803. 

  803.   <dd>
    804. 

  804.     
    805. 

  805.     Creates a new Dispatcher instance.
    806. 

  806.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L346" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    807. 

  807. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L346" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    808. 

  808. 

  809.   </dd>
    810. 

  810. </div>
    811. 

  811. 

  812. </div>
    813. 

  813. <div id="poll-procs-all">
    814. 

  814.   <div id="poll,int">
    815. 

  815.   <dt><pre><span class="Keyword">proc</span> <a href="#poll%2Cint"><span class="Identifier">poll</span></a><span class="Other">(</span><span class="Identifier">timeout</span> <span class="Other">=</span> <span class="DecNumber">500</span><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="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    816. 

  816.                            <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">TimeEffect</span><span class="Other">,</span> <span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    817. 

  817.   <dd>
    818. 

  818.     
    819. 

  819.     Waits for completion events and processes them. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">ValueError</span></span></tt> if there are no pending operations. This runs the underlying OS <span id="epoll_1">epoll</span> or <span id="kqueue_1">kqueue</span> primitive only once.
    820. 

  820.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L1708" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    821. 

  821. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L1708" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    822. 

  822. 

  823.   </dd>
    824. 

  824. </div>
    825. 

  825. 

  826. </div>
    827. 

  827. <div id="readAll-procs-all">
    828. 

  828.   <div id="readAll,FutureStream[string]">
    829. 

  829.   <dt><pre><span class="Keyword">proc</span> <a href="#readAll%2CFutureStream%5Bstring%5D"><span class="Identifier">readAll</span></a><span class="Other">(</span><span class="Identifier">future</span><span class="Other">:</span> <a href="asyncstreams.html#FutureStream"><span class="Identifier">FutureStream</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span><a href="asyncfutures.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span><span class="Other">)</span> {.
    830. 

  830.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span>
    831. 

  831.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    832. 

  832.   <dd>
    833. 

  833.     
    834. 

  834.     Returns a future that will complete when all the string data from the specified future stream is retrieved.
    835. 

  835.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L2001" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    836. 

  836. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L2001" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    837. 

  837. 

  838.   </dd>
    839. 

  839. </div>
    840. 

  840. 

  841. </div>
    842. 

  842. <div id="recv-procs-all">
    843. 

  843.   <div id="recv,AsyncFD,int">
    844. 

  844.   <dt><pre><span class="Keyword">proc</span> <a href="#recv%2CAsyncFD%2Cint"><span class="Identifier">recv</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="asyncdispatch.html#AsyncFD"><span class="Identifier">AsyncFD</span></a><span class="Other">;</span> <span class="Identifier">size</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">flags</span> <span class="Other">=</span> <span class="Other">{</span><span class="Identifier">SafeDisconn</span><span class="Other">}</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span>
    845. 

  845.     <a href="asyncfutures.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span><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="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span>
    846. 

  846.                       <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    847. 

  847.   <dd>
    848. 

  848.     
    849. 

  849.     Reads <strong>up to</strong> <tt class="docutils literal"><span class="pre"><span class="Identifier">size</span></span></tt> bytes from <tt class="docutils literal"><span class="pre"><span class="Identifier">socket</span></span></tt>. Returned future will complete once all the data requested is read, a part of the data has been read, or the socket has disconnected in which case the future will complete with a value of <tt class="docutils literal"><span class="pre"><span class="StringLit">&quot;&quot;</span></span></tt>.<div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
    850. 

  850. The <tt class="docutils literal"><span class="pre"><span class="Identifier">Peek</span></span></tt> socket flag is not supported on Windows.</div>
    851. 

  851. 

  852.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L494" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    853. 

  853. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L494" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    854. 

  854. 

  855.   </dd>
    856. 

  856. </div>
    857. 

  857. 

  858. </div>
    859. 

  859. <div id="recvFromInto-procs-all">
    860. 

  860.   <div id="recvFromInto,AsyncFD,pointer,int,ptr.SockAddr,ptr.SockLen">
    861. 

  861.   <dt><pre><span class="Keyword">proc</span> <a href="#recvFromInto%2CAsyncFD%2Cpointer%2Cint%2Cptr.SockAddr%2Cptr.SockLen"><span class="Identifier">recvFromInto</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="asyncdispatch.html#AsyncFD"><span class="Identifier">AsyncFD</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">;</span> <span class="Identifier">size</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span>
    862. 

  862.                   <span class="Identifier">saddr</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="winlean.html#SockAddr"><span class="Identifier">SockAddr</span></a><span class="Other">;</span> <span class="Identifier">saddrLen</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="winlean.html#SockLen"><span class="Identifier">SockLen</span></a><span class="Other">;</span>
    863. 

  863.                   <span class="Identifier">flags</span> <span class="Other">=</span> <span class="Other">{</span><span class="Identifier">SafeDisconn</span><span class="Other">}</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span><a href="asyncfutures.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span><a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">]</span><span class="Other">)</span> {.
    864. 

  864.     <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="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    865. 

  865.   <dd>
    866. 

  866.     
    867. 

  867.     Receives a datagram data from <tt class="docutils literal"><span class="pre"><span class="Identifier">socket</span></span></tt> into <tt class="docutils literal"><span class="pre"><span class="Identifier">buf</span></span></tt>, which must be at least of size <tt class="docutils literal"><span class="pre"><span class="Identifier">size</span></span></tt>, address of datagram's sender will be stored into <tt class="docutils literal"><span class="pre"><span class="Identifier">saddr</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">saddrLen</span></span></tt>. Returned future will complete once one datagram has been received, and will return size of packet received.
    868. 

  868.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L723" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    869. 

  869. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L723" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    870. 

  870. 

  871.   </dd>
    872. 

  872. </div>
    873. 

  873. 

  874. </div>
    875. 

  875. <div id="recvInto-procs-all">
    876. 

  876.   <div id="recvInto,AsyncFD,pointer,int">
    877. 

  877.   <dt><pre><span class="Keyword">proc</span> <a href="#recvInto%2CAsyncFD%2Cpointer%2Cint"><span class="Identifier">recvInto</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="asyncdispatch.html#AsyncFD"><span class="Identifier">AsyncFD</span></a><span class="Other">;</span> <span class="Identifier">buf</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">;</span> <span class="Identifier">size</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">flags</span> <span class="Other">=</span> <span class="Other">{</span><span class="Identifier">SafeDisconn</span><span class="Other">}</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span>
    878. 

  878.     <a href="asyncfutures.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span><a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">]</span><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="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span>
    879. 

  879.                    <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    880. 

  880.   <dd>
    881. 

  881.     
    882. 

  882.     Reads <strong>up to</strong> <tt class="docutils literal"><span class="pre"><span class="Identifier">size</span></span></tt> bytes from <tt class="docutils literal"><span class="pre"><span class="Identifier">socket</span></span></tt> into <tt class="docutils literal"><span class="pre"><span class="Identifier">buf</span></span></tt>, which must at least be of that size. Returned future will complete once all the data requested is read, a part of the data has been read, or the socket has disconnected in which case the future will complete with a value of <tt class="docutils literal"><span class="pre"><span class="DecNumber">0</span></span></tt>.<div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
    883. 

  883. The <tt class="docutils literal"><span class="pre"><span class="Identifier">Peek</span></span></tt> socket flag is not supported on Windows.</div>
    884. 

  884. 

  885.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L567" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    886. 

  886. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L567" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    887. 

  887. 

  888.   </dd>
    889. 

  889. </div>
    890. 

  890. 

  891. </div>
    892. 

  892. <div id="register-procs-all">
    893. 

  893.   <div id="register,AsyncFD">
    894. 

  894.   <dt><pre><span class="Keyword">proc</span> <a href="#register%2CAsyncFD"><span class="Identifier">register</span></a><span class="Other">(</span><span class="Identifier">fd</span><span class="Other">:</span> <a href="asyncdispatch.html#AsyncFD"><span class="Identifier">AsyncFD</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="Identifier">OSError</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 class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    895. 

  895.   <dd>
    896. 

  896.     
    897. 

  897.     Registers <tt class="docutils literal"><span class="pre"><span class="Identifier">fd</span></span></tt> with the dispatcher.
    898. 

  898.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L372" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    899. 

  899. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L372" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    900. 

  900. 

  901.   </dd>
    902. 

  902. </div>
    903. 

  903. 

  904. </div>
    905. 

  905. <div id="runForever-procs-all">
    906. 

  906.   <div id="runForever">
    907. 

  907.   <dt><pre><span class="Keyword">proc</span> <a href="#runForever"><span class="Identifier">runForever</span></a><span class="Other">(</span><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="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    908. 

  908.                     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">TimeEffect</span><span class="Other">,</span> <span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    909. 

  909.   <dd>
    910. 

  910.     
    911. 

  911.     Begins a never ending global dispatcher poll loop.
    912. 

  912.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L2015" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    913. 

  913. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L2015" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    914. 

  914. 

  915.   </dd>
    916. 

  916. </div>
    917. 

  917. 

  918. </div>
    919. 

  919. <div id="send-procs-all">
    920. 

  920.   <div id="send,AsyncFD,pointer,int">
    921. 

  921.   <dt><pre><span class="Keyword">proc</span> <a href="#send%2CAsyncFD%2Cpointer%2Cint"><span class="Identifier">send</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="asyncdispatch.html#AsyncFD"><span class="Identifier">AsyncFD</span></a><span class="Other">;</span> <span class="Identifier">buf</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">;</span> <span class="Identifier">size</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">flags</span> <span class="Other">=</span> <span class="Other">{</span><span class="Identifier">SafeDisconn</span><span class="Other">}</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span>
    922. 

  922.     <a href="asyncfutures.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span><a href="system.html#void"><span class="Identifier">void</span></a><span class="Other">]</span><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="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span>
    923. 

  923.                     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    924. 

  924.   <dd>
    925. 

  925.     
    926. 

  926.     Sends <tt class="docutils literal"><span class="pre"><span class="Identifier">size</span></span></tt> bytes from <tt class="docutils literal"><span class="pre"><span class="Identifier">buf</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">socket</span></span></tt>. The returned future will complete once all data has been sent.<div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
    927. 

  927. Use it with caution. If <tt class="docutils literal"><span class="pre"><span class="Identifier">buf</span></span></tt> refers to GC'ed object, you must use GC_ref/GC_unref calls to avoid early freeing of the buffer.</div>
    928. 

  928. 

  929.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L633" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    930. 

  930. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L633" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    931. 

  931. 

  932.   </dd>
    933. 

  933. </div>
    934. 

  934. <div id="send,AsyncFD,string">
    935. 

  935.   <dt><pre><span class="Keyword">proc</span> <a href="#send%2CAsyncFD%2Cstring"><span class="Identifier">send</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="asyncdispatch.html#AsyncFD"><span class="Identifier">AsyncFD</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">flags</span> <span class="Other">=</span> <span class="Other">{</span><span class="Identifier">SafeDisconn</span><span class="Other">}</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span>
    936. 

  936.     <a href="asyncfutures.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span><a href="system.html#void"><span class="Identifier">void</span></a><span class="Other">]</span><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="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span>
    937. 

  937.                     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    938. 

  938.   <dd>
    939. 

  939.     
    940. 

  940.     Sends <tt class="docutils literal"><span class="pre"><span class="Identifier">data</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">socket</span></span></tt>. The returned future will complete once all data has been sent.
    941. 

  941.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L1978" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    942. 

  942. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L1978" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    943. 

  943. 

  944.   </dd>
    945. 

  945. </div>
    946. 

  946. 

  947. </div>
    948. 

  948. <div id="sendTo-procs-all">
    949. 

  949.   <div id="sendTo,AsyncFD,pointer,int,ptr.SockAddr,SockLen">
    950. 

  950.   <dt><pre><span class="Keyword">proc</span> <a href="#sendTo%2CAsyncFD%2Cpointer%2Cint%2Cptr.SockAddr%2CSockLen"><span class="Identifier">sendTo</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="asyncdispatch.html#AsyncFD"><span class="Identifier">AsyncFD</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">;</span> <span class="Identifier">size</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">saddr</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="winlean.html#SockAddr"><span class="Identifier">SockAddr</span></a><span class="Other">;</span>
    951. 

  951.             <span class="Identifier">saddrLen</span><span class="Other">:</span> <a href="winlean.html#SockLen"><span class="Identifier">SockLen</span></a><span class="Other">;</span> <span class="Identifier">flags</span> <span class="Other">=</span> <span class="Other">{</span><span class="Identifier">SafeDisconn</span><span class="Other">}</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span><a href="asyncfutures.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span><a href="system.html#void"><span class="Identifier">void</span></a><span class="Other">]</span><span class="Other">)</span> {.
    952. 

  952.     <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="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    953. 

  953.   <dd>
    954. 

  954.     
    955. 

  955.     Sends <tt class="docutils literal"><span class="pre"><span class="Identifier">data</span></span></tt> to specified destination <tt class="docutils literal"><span class="pre"><span class="Identifier">saddr</span></span></tt>, using socket <tt class="docutils literal"><span class="pre"><span class="Identifier">socket</span></span></tt>. The returned future will complete once all data has been sent.
    956. 

  956.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L678" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    957. 

  957. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L678" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    958. 

  958. 

  959.   </dd>
    960. 

  960. </div>
    961. 

  961. 

  962. </div>
    963. 

  963. <div id="setGlobalDispatcher-procs-all">
    964. 

  964.   <div id="setGlobalDispatcher,sinkPDispatcher">
    965. 

  965.   <dt><pre><span class="Keyword">proc</span> <a href="#setGlobalDispatcher%2CsinkPDispatcher"><span class="Identifier">setGlobalDispatcher</span></a><span class="Other">(</span><span class="Identifier">disp</span><span class="Other">:</span> <a href="system.html#sink"><span class="Identifier">sink</span></a> <a href="asyncdispatch.html#PDispatcher"><span class="Identifier">PDispatcher</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 class="Other">,</span>
    966. 

  966.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    967. 

  967.   <dd>
    968. 

  968.     
    969. 

  969.     
    970. 

  970.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L356" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    971. 

  971. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L356" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    972. 

  972. 

  973.   </dd>
    974. 

  974. </div>
    975. 

  975. 

  976. </div>
    977. 

  977. <div id="setInheritable-procs-all">
    978. 

  978.   <div id="setInheritable,AsyncFD,bool">
    979. 

  979.   <dt><pre><span class="Keyword">proc</span> <a href="#setInheritable%2CAsyncFD%2Cbool"><span class="Identifier">setInheritable</span></a><span class="Other">(</span><span class="Identifier">fd</span><span class="Other">:</span> <a href="asyncdispatch.html#AsyncFD"><span class="Identifier">AsyncFD</span></a><span class="Other">;</span> <span class="Identifier">inheritable</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</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>
    980. 

  980.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    981. 

  981.   <dd>
    982. 

  982.     
    983. 

  983.     <p>Control whether a file handle can be inherited by child processes. Returns <tt class="docutils literal"><span class="pre"><span class="Identifier">true</span></span></tt> on success.</p>
    984. 

  984. <p>This procedure is not guaranteed to be available for all platforms. Test for availability with <a class="reference external" href="system.html#declared,untyped">declared()</a>.</p>
    985. 

  985. 

  986.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L868" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    987. 

  987. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L868" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    988. 

  988. 

  989.   </dd>
    990. 

  990. </div>
    991. 

  991. 

  992. </div>
    993. 

  993. <div id="sleepAsync-procs-all">
    994. 

  994.   <div id="sleepAsync">
    995. 

  995.   <dt><pre><span class="Keyword">proc</span> <a href="#sleepAsync"><span class="Identifier">sleepAsync</span></a><span class="Other">(</span><span class="Identifier">ms</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Operator">|</span> <a href="system.html#float"><span class="Identifier">float</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span><a href="asyncfutures.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span><a href="system.html#void"><span class="Identifier">void</span></a><span class="Other">]</span><span class="Other">)</span></pre></dt>
    996. 

  996.   <dd>
    997. 

  997.     
    998. 

  998.     Suspends the execution of the current async procedure for the next <tt class="docutils literal"><span class="pre"><span class="Identifier">ms</span></span></tt> milliseconds.
    999. 

  999.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L1920" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1000. 

  1000. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L1920" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1001. 

  1001. 

  1002.   </dd>
    1003. 

  1003. </div>
    1004. 

  1004. 

  1005. </div>
    1006. 

  1006. <div id="trigger-procs-all">
    1007. 

  1007.   <div id="trigger,AsyncEvent">
    1008. 

  1008.   <dt><pre><span class="Keyword">proc</span> <a href="#trigger%2CAsyncEvent"><span class="Identifier">trigger</span></a><span class="Other">(</span><span class="Identifier">ev</span><span class="Other">:</span> <a href="asyncdispatch.html#AsyncEvent"><span class="Identifier">AsyncEvent</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="Identifier">OSError</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 class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1009. 

  1009.   <dd>
    1010. 

  1010.     
    1011. 

  1011.     Set event <tt class="docutils literal"><span class="pre"><span class="Identifier">ev</span></span></tt> to signaled state.
    1012. 

  1012.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L1113" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1013. 

  1013. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L1113" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1014. 

  1014. 

  1015.   </dd>
    1016. 

  1016. </div>
    1017. 

  1017. 

  1018. </div>
    1019. 

  1019. <div id="unregister-procs-all">
    1020. 

  1020.   <div id="unregister,AsyncEvent">
    1021. 

  1021.   <dt><pre><span class="Keyword">proc</span> <a href="#unregister%2CAsyncEvent"><span class="Identifier">unregister</span></a><span class="Other">(</span><span class="Identifier">ev</span><span class="Other">:</span> <a href="asyncdispatch.html#AsyncEvent"><span class="Identifier">AsyncEvent</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="Identifier">OSError</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 class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1022. 

  1022.   <dd>
    1023. 

  1023.     
    1024. 

  1024.     Unregisters event <tt class="docutils literal"><span class="pre"><span class="Identifier">ev</span></span></tt>.
    1025. 

  1025.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L1118" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1026. 

  1026. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L1118" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1027. 

  1027. 

  1028.   </dd>
    1029. 

  1029. </div>
    1030. 

  1030. <div id="unregister,AsyncFD">
    1031. 

  1031.   <dt><pre><span class="Keyword">proc</span> <a href="#unregister%2CAsyncFD"><span class="Identifier">unregister</span></a><span class="Other">(</span><span class="Identifier">fd</span><span class="Other">:</span> <a href="asyncdispatch.html#AsyncFD"><span class="Identifier">AsyncFD</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 class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1032. 

  1032.   <dd>
    1033. 

  1033.     
    1034. 

  1034.     Unregisters <tt class="docutils literal"><span class="pre"><span class="Identifier">fd</span></span></tt>.
    1035. 

  1035.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L875" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1036. 

  1036. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L875" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1037. 

  1037. 

  1038.   </dd>
    1039. 

  1039. </div>
    1040. 

  1040. 

  1041. </div>
    1042. 

  1042. <div id="waitFor-procs-all">
    1043. 

  1043.   <div id="waitFor,Future[T]">
    1044. 

  1044.   <dt><pre><span class="Keyword">proc</span> <a href="#waitFor%2CFuture%5BT%5D"><span class="Identifier">waitFor</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">fut</span><span class="Other">:</span> <a href="asyncfutures.html#Future"><span class="Identifier">Future</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">T</span></pre></dt>
    1045. 

  1045.   <dd>
    1046. 

  1046.     
    1047. 

  1047.     <strong>Blocks</strong> the current thread until the specified future completes.
    1048. 

  1048.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L2020" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1049. 

  1049. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L2020" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1050. 

  1050. 

  1051.   </dd>
    1052. 

  1052. </div>
    1053. 

  1053. 

  1054. </div>
    1055. 

  1055. <div id="withTimeout-procs-all">
    1056. 

  1056.   <div id="withTimeout,Future[T],int">
    1057. 

  1057.   <dt><pre><span class="Keyword">proc</span> <a href="#withTimeout%2CFuture%5BT%5D%2Cint"><span class="Identifier">withTimeout</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">fut</span><span class="Other">:</span> <a href="asyncfutures.html#Future"><span class="Identifier">Future</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> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span><a href="asyncfutures.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span><a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">]</span><span class="Other">)</span></pre></dt>
    1058. 

  1058.   <dd>
    1059. 

  1059.     
    1060. 

  1060.     <p>Returns a future which will complete once <tt class="docutils literal"><span class="pre"><span class="Identifier">fut</span></span></tt> completes or after <tt class="docutils literal"><span class="pre"><span class="Identifier">timeout</span></span></tt> milliseconds has elapsed.</p>
    1061. 

  1061. <p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">fut</span></span></tt> completes first the returned future will hold true, otherwise, if <tt class="docutils literal"><span class="pre"><span class="Identifier">timeout</span></span></tt> milliseconds has elapsed first, the returned future will hold false.</p>
    1062. 

  1062. 

  1063.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/asyncdispatch.nim#L1932" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1064. 

  1064. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncdispatch.nim#L1932" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1065. 

  1065. 

  1066.   </dd>
    1067. 

  1067. </div>
    1068. 

  1068. 

  1069. </div>
    1070. 

  1070. 

  1071.   </dl>
    1072. 

  1072. </div>
    1073. 

  1073. 

  1074.   </div>
    1075. 

  1075. </div>
    1076. 

  1076. 

  1077.       <div class="twelve-columns footer">
    1078. 

  1078.         <span class="nim-sprite"></span>
    1079. 

  1079.         <br>
    1080. 

  1080.         <small style="color: var(--hint);">Made with Nim. Generated: 2025-02-03 14:57:13 UTC</small>
    1081. 

  1081.       </div>
    1082. 

  1082.     </div>
    1083. 

  1083.   </div>
    1084. 

  1084.       <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
    1085. 

  1085.     
    1086. 

  1086. </body>
    1087. 

  1087. </html>
    1088. 

  1088.