Home Esplora Aiuto
Accedi
levovix
/
Nim
mirror da https://github.com/nim-lang/Nim
Segui 1
Vota 0
Forka 1
File Problemi 0 Wiki
Albero (Tree): d69e064e0c
Rami (Branch) Tag
Nim
/
net.html

net.html 201 KB
Cronologia Originale

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826 
  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/net</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/net</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="ssl_toc" href="#ssl">SSL</a></li>
    55. 

  55. <li><a class="reference" id="ssl-on-windows_toc" href="#ssl-on-windows">SSL on Windows</a></li>
    56. 

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

  57. <ul class="simple"><li><a class="reference" id="examples-connecting-to-a-server_toc" href="#examples-connecting-to-a-server">Connecting to a server</a></li>
    58. 

  58. <li><a class="reference" id="examples-creating-a-server_toc" href="#examples-creating-a-server">Creating a server</a></li>
    59. 

  59. </ul><li>
    60. 

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

  61. </li>
    62. 

  62. <li>
    63. 

  63.   <details open>
    64. 

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

  65.     <ul class="simple simple-toc-section">
    66. 

  66.       <li><a class="reference" href="#Certificate" title="Certificate = string">Certificate</a></li>
    67. 

  67. <li><a class="reference" href="#IpAddress" title="IpAddress = object
    68. 

  68.   case family*: IpAddressFamily ## the type of the IP address (IPv4 or IPv6)
    69. 

  69.   of IpAddressFamily.IPv6:
    70. 

  70.     address_v6*: array[0 .. 15, uint8] ## Contains the IP address in bytes in
    71. 

  71.                                        ## case of IPv6
    72. 

  72.   of IpAddressFamily.IPv4:
    73. 

  73.     address_v4*: array[0 .. 3, uint8] ## Contains the IP address in bytes in
    74. 

  74.                                       ## case of IPv4">IpAddress</a></li>
    75. 

  75. <li><a class="reference" href="#IpAddressFamily" title="IpAddressFamily {.pure.} = enum
    76. 

  76.   IPv6,                     ## IPv6 address
    77. 

  77.   IPv4                       ## IPv4 address">IpAddressFamily</a></li>
    78. 

  78. <li><a class="reference" href="#ReadLineResult" title="ReadLineResult = enum
    79. 

  79.   ReadFullLine, ReadPartialLine, ReadDisconnected, ReadNone">ReadLineResult</a></li>
    80. 

  80. <li><a class="reference" href="#SOBool" title="SOBool = enum
    81. 

  81.   OptAcceptConn, OptBroadcast, OptDebug, OptDontRoute, OptKeepAlive,
    82. 

  82.   OptOOBInline, OptReuseAddr, OptReusePort, OptNoDelay">SOBool</a></li>
    83. 

  83. <li><a class="reference" href="#Socket" title="Socket = ref SocketImpl">Socket</a></li>
    84. 

  84. <li><a class="reference" href="#SocketFlag" title="SocketFlag {.pure.} = enum
    85. 

  85.   Peek, SafeDisconn          ## Ensures disconnection exceptions (ECONNRESET, EPIPE etc) are not thrown.">SocketFlag</a></li>
    86. 

  86. <li><a class="reference" href="#SocketImpl" title="SocketImpl = object
    87. 

  87.   when defineSsl:
    88. 

  88.   ## stores the last error on this socket">SocketImpl</a></li>
    89. 

  89. <li><a class="reference" href="#SslAcceptResult" title="SslAcceptResult = enum
    90. 

  90.   AcceptNoClient = 0, AcceptNoHandshake, AcceptSuccess">SslAcceptResult</a></li>
    91. 

  91. <li><a class="reference" href="#SslClientGetPskFunc" title="SslClientGetPskFunc = proc (hint: string): tuple[identity: string, psk: string]">SslClientGetPskFunc</a></li>
    92. 

  92. <li><a class="reference" href="#SslContext" title="SslContext = ref object
    93. 

  93.   context*: SslCtx">SslContext</a></li>
    94. 

  94. <li><a class="reference" href="#SslCVerifyMode" title="SslCVerifyMode = enum
    95. 

  95.   CVerifyNone, CVerifyPeer, CVerifyPeerUseEnvVars">SslCVerifyMode</a></li>
    96. 

  96. <li><a class="reference" href="#SslError" title="SslError = object of CatchableError">SslError</a></li>
    97. 

  97. <li><a class="reference" href="#SslHandshakeType" title="SslHandshakeType = enum
    98. 

  98.   handshakeAsClient, handshakeAsServer">SslHandshakeType</a></li>
    99. 

  99. <li><a class="reference" href="#SslProtVersion" title="SslProtVersion = enum
    100. 

  100.   protSSLv2, protSSLv3, protTLSv1, protSSLv23">SslProtVersion</a></li>
    101. 

  101. <li><a class="reference" href="#SslServerGetPskFunc" title="SslServerGetPskFunc = proc (identity: string): string">SslServerGetPskFunc</a></li>
    102. 

  102. <li><a class="reference" href="#TimeoutError" title="TimeoutError = object of CatchableError">TimeoutError</a></li>
    103. 

  103. 

  104.     </ul>
    105. 

  105.   </details>
    106. 

  106. </li>
    107. 

  107. <li>
    108. 

  108.   <details open>
    109. 

  109.     <summary><a class="reference reference-toplevel" href="#10" id="60">Consts</a></summary>
    110. 

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

  111.       <li><a class="reference" href="#BufferSize" title="BufferSize: int = 4000">BufferSize</a></li>
    112. 

  112. <li><a class="reference" href="#MaxLineLength" title="MaxLineLength = 1000000">MaxLineLength</a></li>
    113. 

  113. 

  114.     </ul>
    115. 

  115.   </details>
    116. 

  116. </li>
    117. 

  117. <li>
    118. 

  118.   <details open>
    119. 

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

  120.     <ul class="simple simple-toc-section">
    121. 

  121.       <ul class="simple nested-toc-section">$
    122. 

  122.   <li><a class="reference" href="#%24%2CIpAddress" title="`$`(address: IpAddress): string">`$`(address: IpAddress): string</a></li>
    123. 

  123. 

  124. </ul>
    125. 

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

  126.   <li><a class="reference" href="#%3D%3D%2CIpAddress%2CIpAddress" title="`==`(lhs, rhs: IpAddress): bool">`==`(lhs, rhs: IpAddress): bool</a></li>
    127. 

  127. 

  128. </ul>
    129. 

  129. <ul class="simple nested-toc-section">accept
    130. 

  130.   <li><a class="reference" href="#accept%2CSocket%2C" title="accept(server: Socket; client: var owned(Socket); flags = {SafeDisconn};
    131. 

  131.        inheritable = defined(nimInheritHandles))">accept(server: Socket; client: var owned(Socket); flags = {SafeDisconn};
    132. 

  132.        inheritable = defined(nimInheritHandles))</a></li>
    133. 

  133. 

  134. </ul>
    135. 

  135. <ul class="simple nested-toc-section">acceptAddr
    136. 

  136.   <li><a class="reference" href="#acceptAddr%2CSocket%2C%2Cstring" title="acceptAddr(server: Socket; client: var owned(Socket); address: var string;
    137. 

  137.            flags = {SafeDisconn}; inheritable = defined(nimInheritHandles))">acceptAddr(server: Socket; client: var owned(Socket); address: var string;
    138. 

  138.            flags = {SafeDisconn}; inheritable = defined(nimInheritHandles))</a></li>
    139. 

  139. 

  140. </ul>
    141. 

  141. <ul class="simple nested-toc-section">bindAddr
    142. 

  142.   <li><a class="reference" href="#bindAddr%2CSocket%2Cstring" title="bindAddr(socket: Socket; port = Port(0); address = &quot;&quot;)">bindAddr(socket: Socket; port = Port(0); address = &quot;&quot;)</a></li>
    143. 

  143. 

  144. </ul>
    145. 

  145. <ul class="simple nested-toc-section">bindUnix
    146. 

  146.   <li><a class="reference" href="#bindUnix%2CSocket%2Cstring" title="bindUnix(socket: Socket; path: string)">bindUnix(socket: Socket; path: string)</a></li>
    147. 

  147. 

  148. </ul>
    149. 

  149. <ul class="simple nested-toc-section">clientGetPskFunc
    150. 

  150.   <li><a class="reference" href="#clientGetPskFunc%2CSslContext" title="clientGetPskFunc(ctx: SslContext): SslClientGetPskFunc">clientGetPskFunc(ctx: SslContext): SslClientGetPskFunc</a></li>
    151. 

  151. 

  152. </ul>
    153. 

  153. <ul class="simple nested-toc-section">clientGetPskFunc=
    154. 

  154.   <li><a class="reference" href="#clientGetPskFunc%3D%2CSslContext%2CSslClientGetPskFunc" title="clientGetPskFunc=(ctx: SslContext; fun: SslClientGetPskFunc)">clientGetPskFunc=(ctx: SslContext; fun: SslClientGetPskFunc)</a></li>
    155. 

  155. 

  156. </ul>
    157. 

  157. <ul class="simple nested-toc-section">close
    158. 

  158.   <li><a class="reference" href="#close%2CSocket" title="close(socket: Socket; flags = {SafeDisconn})">close(socket: Socket; flags = {SafeDisconn})</a></li>
    159. 

  159. 

  160. </ul>
    161. 

  161. <ul class="simple nested-toc-section">connect
    162. 

  162.   <li><a class="reference" href="#connect%2CSocket%2Cstring" title="connect(socket: Socket; address: string; port = Port(0))">connect(socket: Socket; address: string; port = Port(0))</a></li>
    163. 

  163. <li><a class="reference" href="#connect%2CSocket%2Cstring%2Cint" title="connect(socket: Socket; address: string; port = Port(0); timeout: int)">connect(socket: Socket; address: string; port = Port(0); timeout: int)</a></li>
    164. 

  164. 

  165. </ul>
    166. 

  166. <ul class="simple nested-toc-section">connectUnix
    167. 

  167.   <li><a class="reference" href="#connectUnix%2CSocket%2Cstring" title="connectUnix(socket: Socket; path: string)">connectUnix(socket: Socket; path: string)</a></li>
    168. 

  168. 

  169. </ul>
    170. 

  170. <ul class="simple nested-toc-section">destroyContext
    171. 

  171.   <li><a class="reference" href="#destroyContext%2CSslContext" title="destroyContext(ctx: SslContext)">destroyContext(ctx: SslContext)</a></li>
    172. 

  172. 

  173. </ul>
    174. 

  174. <ul class="simple nested-toc-section">dial
    175. 

  175.   <li><a class="reference" href="#dial%2Cstring%2CPort" title="dial(address: string; port: Port; protocol = IPPROTO_TCP; buffered = true): owned(
    176. 

  176.     Socket)">dial(address: string; port: Port; protocol = IPPROTO_TCP; buffered = true): owned(
    177. 

  177.     Socket)</a></li>
    178. 

  178. 

  179. </ul>
    180. 

  180. <ul class="simple nested-toc-section">fromSockAddr
    181. 

  181.   <li><a class="reference" href="#fromSockAddr%2C%2CSockLen%2CIpAddress%2CPort" title="fromSockAddr(sa: Sockaddr_storage | SockAddr | Sockaddr_in | Sockaddr_in6;
    182. 

  182.              sl: SockLen; address: var IpAddress; port: var Port)">fromSockAddr(sa: Sockaddr_storage | SockAddr | Sockaddr_in | Sockaddr_in6;
    183. 

  183.              sl: SockLen; address: var IpAddress; port: var Port)</a></li>
    184. 

  184. 

  185. </ul>
    186. 

  186. <ul class="simple nested-toc-section">getExtraData
    187. 

  187.   <li><a class="reference" href="#getExtraData%2CSslContext%2Cint" title="getExtraData(ctx: SslContext; index: int): RootRef">getExtraData(ctx: SslContext; index: int): RootRef</a></li>
    188. 

  188. 

  189. </ul>
    190. 

  190. <ul class="simple nested-toc-section">getFd
    191. 

  191.   <li><a class="reference" href="#getFd%2CSocket" title="getFd(socket: Socket): SocketHandle">getFd(socket: Socket): SocketHandle</a></li>
    192. 

  192. 

  193. </ul>
    194. 

  194. <ul class="simple nested-toc-section">getLocalAddr
    195. 

  195.   <li><a class="reference" href="#getLocalAddr%2CSocket" title="getLocalAddr(socket: Socket): (string, Port)">getLocalAddr(socket: Socket): (string, Port)</a></li>
    196. 

  196. 

  197. </ul>
    198. 

  198. <ul class="simple nested-toc-section">getPeerAddr
    199. 

  199.   <li><a class="reference" href="#getPeerAddr%2CSocket" title="getPeerAddr(socket: Socket): (string, Port)">getPeerAddr(socket: Socket): (string, Port)</a></li>
    200. 

  200. 

  201. </ul>
    202. 

  202. <ul class="simple nested-toc-section">getPeerCertificates
    203. 

  203.   <li><a class="reference" href="#getPeerCertificates%2CSocket" title="getPeerCertificates(socket: Socket): seq[Certificate]">getPeerCertificates(socket: Socket): seq[Certificate]</a></li>
    204. 

  204. <li><a class="reference" href="#getPeerCertificates%2CSslPtr" title="getPeerCertificates(sslHandle: SslPtr): seq[Certificate]">getPeerCertificates(sslHandle: SslPtr): seq[Certificate]</a></li>
    205. 

  205. 

  206. </ul>
    207. 

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

  208.   <li><a class="reference" href="#getPrimaryIPAddr" title="getPrimaryIPAddr(dest = parseIpAddress(&quot;8.8.8.8&quot;)): IpAddress">getPrimaryIPAddr(dest = parseIpAddress(&quot;8.8.8.8&quot;)): IpAddress</a></li>
    209. 

  209. 

  210. </ul>
    211. 

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

  212.   <li><a class="reference" href="#getPskIdentity%2CSocket" title="getPskIdentity(socket: Socket): string">getPskIdentity(socket: Socket): string</a></li>
    213. 

  213. 

  214. </ul>
    215. 

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

  216.   <li><a class="reference" href="#getSocketError%2CSocket" title="getSocketError(socket: Socket): OSErrorCode">getSocketError(socket: Socket): OSErrorCode</a></li>
    217. 

  217. 

  218. </ul>
    219. 

  219. <ul class="simple nested-toc-section">getSockOpt
    220. 

  220.   <li><a class="reference" href="#getSockOpt%2CSocket%2CSOBool" title="getSockOpt(socket: Socket; opt: SOBool; level = SOL_SOCKET): bool">getSockOpt(socket: Socket; opt: SOBool; level = SOL_SOCKET): bool</a></li>
    221. 

  221. 

  222. </ul>
    223. 

  223. <ul class="simple nested-toc-section">gotHandshake
    224. 

  224.   <li><a class="reference" href="#gotHandshake%2CSocket" title="gotHandshake(socket: Socket): bool">gotHandshake(socket: Socket): bool</a></li>
    225. 

  225. 

  226. </ul>
    227. 

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

  228.   <li><a class="reference" href="#hasDataBuffered%2CSocket" title="hasDataBuffered(s: Socket): bool">hasDataBuffered(s: Socket): bool</a></li>
    229. 

  229. 

  230. </ul>
    231. 

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

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

  233. 

  234. </ul>
    235. 

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

  236.   <li><a class="reference" href="#IPv4_broadcast" title="IPv4_broadcast(): IpAddress">IPv4_broadcast(): IpAddress</a></li>
    237. 

  237. 

  238. </ul>
    239. 

  239. <ul class="simple nested-toc-section">IPv4_loopback
    240. 

  240.   <li><a class="reference" href="#IPv4_loopback" title="IPv4_loopback(): IpAddress">IPv4_loopback(): IpAddress</a></li>
    241. 

  241. 

  242. </ul>
    243. 

  243. <ul class="simple nested-toc-section">IPv6_any
    244. 

  244.   <li><a class="reference" href="#IPv6_any" title="IPv6_any(): IpAddress">IPv6_any(): IpAddress</a></li>
    245. 

  245. 

  246. </ul>
    247. 

  247. <ul class="simple nested-toc-section">IPv6_loopback
    248. 

  248.   <li><a class="reference" href="#IPv6_loopback" title="IPv6_loopback(): IpAddress">IPv6_loopback(): IpAddress</a></li>
    249. 

  249. 

  250. </ul>
    251. 

  251. <ul class="simple nested-toc-section">isDisconnectionError
    252. 

  252.   <li><a class="reference" href="#isDisconnectionError%2Cset%5BSocketFlag%5D%2COSErrorCode" title="isDisconnectionError(flags: set[SocketFlag]; lastError: OSErrorCode): bool">isDisconnectionError(flags: set[SocketFlag]; lastError: OSErrorCode): bool</a></li>
    253. 

  253. 

  254. </ul>
    255. 

  255. <ul class="simple nested-toc-section">isIpAddress
    256. 

  256.   <li><a class="reference" href="#isIpAddress%2Cstring" title="isIpAddress(addressStr: string): bool">isIpAddress(addressStr: string): bool</a></li>
    257. 

  257. 

  258. </ul>
    259. 

  259. <ul class="simple nested-toc-section">isSsl
    260. 

  260.   <li><a class="reference" href="#isSsl%2CSocket" title="isSsl(socket: Socket): bool">isSsl(socket: Socket): bool</a></li>
    261. 

  261. 

  262. </ul>
    263. 

  263. <ul class="simple nested-toc-section">listen
    264. 

  264.   <li><a class="reference" href="#listen%2CSocket" title="listen(socket: Socket; backlog = SOMAXCONN)">listen(socket: Socket; backlog = SOMAXCONN)</a></li>
    265. 

  265. 

  266. </ul>
    267. 

  267. <ul class="simple nested-toc-section">newContext
    268. 

  268.   <li><a class="reference" href="#newContext%2Cstring%2Cstring%2Cstring%2Cstring" title="newContext(protVersion = protSSLv23; verifyMode = CVerifyPeer; certFile = &quot;&quot;;
    269. 

  269.            keyFile = &quot;&quot;; cipherList = CiphersIntermediate; caDir = &quot;&quot;;
    270. 

  270.            caFile = &quot;&quot;; ciphersuites = CiphersModern): SslContext">newContext(protVersion = protSSLv23; verifyMode = CVerifyPeer; certFile = &quot;&quot;;
    271. 

  271.            keyFile = &quot;&quot;; cipherList = CiphersIntermediate; caDir = &quot;&quot;;
    272. 

  272.            caFile = &quot;&quot;; ciphersuites = CiphersModern): SslContext</a></li>
    273. 

  273. 

  274. </ul>
    275. 

  275. <ul class="simple nested-toc-section">newSocket
    276. 

  276.   <li><a class="reference" href="#newSocket%2Ccint%2Ccint%2Ccint" title="newSocket(domain, sockType, protocol: cint; buffered = true;
    277. 

  277.           inheritable = defined(nimInheritHandles)): owned(Socket)">newSocket(domain, sockType, protocol: cint; buffered = true;
    278. 

  278.           inheritable = defined(nimInheritHandles)): owned(Socket)</a></li>
    279. 

  279. <li><a class="reference" href="#newSocket%2CDomain%2CSockType%2CProtocol" title="newSocket(domain: Domain = AF_INET; sockType: SockType = SOCK_STREAM;
    280. 

  280.           protocol: Protocol = IPPROTO_TCP; buffered = true;
    281. 

  281.           inheritable = defined(nimInheritHandles)): owned(Socket)">newSocket(domain: Domain = AF_INET; sockType: SockType = SOCK_STREAM;
    282. 

  282.           protocol: Protocol = IPPROTO_TCP; buffered = true;
    283. 

  283.           inheritable = defined(nimInheritHandles)): owned(Socket)</a></li>
    284. 

  284. <li><a class="reference" href="#newSocket%2CSocketHandle%2CDomain%2CSockType%2CProtocol" title="newSocket(fd: SocketHandle; domain: Domain = AF_INET;
    285. 

  285.           sockType: SockType = SOCK_STREAM; protocol: Protocol = IPPROTO_TCP;
    286. 

  286.           buffered = true): owned(Socket)">newSocket(fd: SocketHandle; domain: Domain = AF_INET;
    287. 

  287.           sockType: SockType = SOCK_STREAM; protocol: Protocol = IPPROTO_TCP;
    288. 

  288.           buffered = true): owned(Socket)</a></li>
    289. 

  289. 

  290. </ul>
    291. 

  291. <ul class="simple nested-toc-section">parseIpAddress
    292. 

  292.   <li><a class="reference" href="#parseIpAddress%2Cstring" title="parseIpAddress(addressStr: string): IpAddress">parseIpAddress(addressStr: string): IpAddress</a></li>
    293. 

  293. 

  294. </ul>
    295. 

  295. <ul class="simple nested-toc-section">pskIdentityHint=
    296. 

  296.   <li><a class="reference" href="#pskIdentityHint%3D%2CSslContext%2Cstring" title="pskIdentityHint=(ctx: SslContext; hint: string)">pskIdentityHint=(ctx: SslContext; hint: string)</a></li>
    297. 

  297. 

  298. </ul>
    299. 

  299. <ul class="simple nested-toc-section">raiseSSLError
    300. 

  300.   <li><a class="reference" href="#raiseSSLError%2Cstring" title="raiseSSLError(s = &quot;&quot;)">raiseSSLError(s = &quot;&quot;)</a></li>
    301. 

  301. 

  302. </ul>
    303. 

  303. <ul class="simple nested-toc-section">readLine
    304. 

  304.   <li><a class="reference" href="#readLine%2CSocket%2Cstring%2Cint" title="readLine(socket: Socket; line: var string; timeout = -1; flags = {SafeDisconn};
    305. 

  305.          maxLength = MaxLineLength)">readLine(socket: Socket; line: var string; timeout = -1; flags = {SafeDisconn};
    306. 

  306.          maxLength = MaxLineLength)</a></li>
    307. 

  307. 

  308. </ul>
    309. 

  309. <ul class="simple nested-toc-section">recv
    310. 

  310.   <li><a class="reference" href="#recv%2CSocket%2Cpointer%2Cint" title="recv(socket: Socket; data: pointer; size: int): int">recv(socket: Socket; data: pointer; size: int): int</a></li>
    311. 

  311. <li><a class="reference" href="#recv%2CSocket%2Cpointer%2Cint%2Cint" title="recv(socket: Socket; data: pointer; size: int; timeout: int): int">recv(socket: Socket; data: pointer; size: int; timeout: int): int</a></li>
    312. 

  312. <li><a class="reference" href="#recv%2CSocket%2Cstring%2Cint%2Cint" title="recv(socket: Socket; data: var string; size: int; timeout = -1;
    313. 

  313.      flags = {SafeDisconn}): int">recv(socket: Socket; data: var string; size: int; timeout = -1;
    314. 

  314.      flags = {SafeDisconn}): int</a></li>
    315. 

  315. <li><a class="reference" href="#recv%2CSocket%2Cint%2Cint" title="recv(socket: Socket; size: int; timeout = -1; flags = {SafeDisconn}): string">recv(socket: Socket; size: int; timeout = -1; flags = {SafeDisconn}): string</a></li>
    316. 

  316. 

  317. </ul>
    318. 

  318. <ul class="simple nested-toc-section">recvFrom
    319. 

  319.   <li><a class="reference" href="#recvFrom%2CSocket%2Cstring%2Cint%2CT%2CPort%2Cint32" title="recvFrom[T: string | IpAddress](socket: Socket; data: var string; length: int;
    320. 

  320.                                 address: var T; port: var Port; flags = 0'i32): int">recvFrom[T: string | IpAddress](socket: Socket; data: var string; length: int;
    321. 

  321.                                 address: var T; port: var Port; flags = 0'i32): int</a></li>
    322. 

  322. 

  323. </ul>
    324. 

  324. <ul class="simple nested-toc-section">recvLine
    325. 

  325.   <li><a class="reference" href="#recvLine%2CSocket%2Cint" title="recvLine(socket: Socket; timeout = -1; flags = {SafeDisconn};
    326. 

  326.          maxLength = MaxLineLength): string">recvLine(socket: Socket; timeout = -1; flags = {SafeDisconn};
    327. 

  327.          maxLength = MaxLineLength): string</a></li>
    328. 

  328. 

  329. </ul>
    330. 

  330. <ul class="simple nested-toc-section">send
    331. 

  331.   <li><a class="reference" href="#send%2CSocket%2Cpointer%2Cint" title="send(socket: Socket; data: pointer; size: int): int">send(socket: Socket; data: pointer; size: int): int</a></li>
    332. 

  332. <li><a class="reference" href="#send%2CSocket%2Cstring%2Cint" title="send(socket: Socket; data: string; flags = {SafeDisconn}; maxRetries = 100)">send(socket: Socket; data: string; flags = {SafeDisconn}; maxRetries = 100)</a></li>
    333. 

  333. 

  334. </ul>
    335. 

  335. <ul class="simple nested-toc-section">sendTo
    336. 

  336.   <li><a class="reference" href="#sendTo%2CSocket%2CIpAddress%2CPort%2Cstring%2Cint32" title="sendTo(socket: Socket; address: IpAddress; port: Port; data: string;
    337. 

  337.        flags = 0'i32): int">sendTo(socket: Socket; address: IpAddress; port: Port; data: string;
    338. 

  338.        flags = 0'i32): int</a></li>
    339. 

  339. <li><a class="reference" href="#sendTo%2CSocket%2Cstring%2CPort%2Cpointer%2Cint%2CDomain%2Cint32" title="sendTo(socket: Socket; address: string; port: Port; data: pointer; size: int;
    340. 

  340.        af: Domain = AF_INET; flags = 0'i32)">sendTo(socket: Socket; address: string; port: Port; data: pointer; size: int;
    341. 

  341.        af: Domain = AF_INET; flags = 0'i32)</a></li>
    342. 

  342. <li><a class="reference" href="#sendTo%2CSocket%2Cstring%2CPort%2Cstring" title="sendTo(socket: Socket; address: string; port: Port; data: string)">sendTo(socket: Socket; address: string; port: Port; data: string)</a></li>
    343. 

  343. 

  344. </ul>
    345. 

  345. <ul class="simple nested-toc-section">serverGetPskFunc
    346. 

  346.   <li><a class="reference" href="#serverGetPskFunc%2CSslContext" title="serverGetPskFunc(ctx: SslContext): SslServerGetPskFunc">serverGetPskFunc(ctx: SslContext): SslServerGetPskFunc</a></li>
    347. 

  347. 

  348. </ul>
    349. 

  349. <ul class="simple nested-toc-section">serverGetPskFunc=
    350. 

  350.   <li><a class="reference" href="#serverGetPskFunc%3D%2CSslContext%2CSslServerGetPskFunc" title="serverGetPskFunc=(ctx: SslContext; fun: SslServerGetPskFunc)">serverGetPskFunc=(ctx: SslContext; fun: SslServerGetPskFunc)</a></li>
    351. 

  351. 

  352. </ul>
    353. 

  353. <ul class="simple nested-toc-section">sessionIdContext=
    354. 

  354.   <li><a class="reference" href="#sessionIdContext%3D%2CSslContext%2Cstring" title="sessionIdContext=(ctx: SslContext; sidCtx: string)">sessionIdContext=(ctx: SslContext; sidCtx: string)</a></li>
    355. 

  355. 

  356. </ul>
    357. 

  357. <ul class="simple nested-toc-section">setExtraData
    358. 

  358.   <li><a class="reference" href="#setExtraData%2CSslContext%2Cint%2CRootRef" title="setExtraData(ctx: SslContext; index: int; data: RootRef)">setExtraData(ctx: SslContext; index: int; data: RootRef)</a></li>
    359. 

  359. 

  360. </ul>
    361. 

  361. <ul class="simple nested-toc-section">setSockOpt
    362. 

  362.   <li><a class="reference" href="#setSockOpt%2CSocket%2CSOBool%2Cbool" title="setSockOpt(socket: Socket; opt: SOBool; value: bool; level = SOL_SOCKET)">setSockOpt(socket: Socket; opt: SOBool; value: bool; level = SOL_SOCKET)</a></li>
    363. 

  363. 

  364. </ul>
    365. 

  365. <ul class="simple nested-toc-section">skip
    366. 

  366.   <li><a class="reference" href="#skip%2CSocket%2Cint%2Cint" title="skip(socket: Socket; size: int; timeout = -1)">skip(socket: Socket; size: int; timeout = -1)</a></li>
    367. 

  367. 

  368. </ul>
    369. 

  369. <ul class="simple nested-toc-section">socketError
    370. 

  370.   <li><a class="reference" href="#socketError%2CSocket%2Cint%2Cset%5BSocketFlag%5D" title="socketError(socket: Socket; err: int = -1; async = false;
    371. 

  371.             lastError = -1.OSErrorCode; flags: set[SocketFlag] = {})">socketError(socket: Socket; err: int = -1; async = false;
    372. 

  372.             lastError = -1.OSErrorCode; flags: set[SocketFlag] = {})</a></li>
    373. 

  373. 

  374. </ul>
    375. 

  375. <ul class="simple nested-toc-section">sslHandle
    376. 

  376.   <li><a class="reference" href="#sslHandle%2CSocket" title="sslHandle(self: Socket): SslPtr">sslHandle(self: Socket): SslPtr</a></li>
    377. 

  377. 

  378. </ul>
    379. 

  379. <ul class="simple nested-toc-section">toCInt
    380. 

  380.   <li><a class="reference" href="#toCInt%2CSOBool" title="toCInt(opt: SOBool): cint">toCInt(opt: SOBool): cint</a></li>
    381. 

  381. 

  382. </ul>
    383. 

  383. <ul class="simple nested-toc-section">toOSFlags
    384. 

  384.   <li><a class="reference" href="#toOSFlags%2Cset%5BSocketFlag%5D" title="toOSFlags(socketFlags: set[SocketFlag]): cint">toOSFlags(socketFlags: set[SocketFlag]): cint</a></li>
    385. 

  385. 

  386. </ul>
    387. 

  387. <ul class="simple nested-toc-section">toSockAddr
    388. 

  388.   <li><a class="reference" href="#toSockAddr%2CIpAddress%2CPort%2CSockaddr_storage%2CSockLen" title="toSockAddr(address: IpAddress; port: Port; sa: var Sockaddr_storage;
    389. 

  389.            sl: var SockLen)">toSockAddr(address: IpAddress; port: Port; sa: var Sockaddr_storage;
    390. 

  390.            sl: var SockLen)</a></li>
    391. 

  391. 

  392. </ul>
    393. 

  393. <ul class="simple nested-toc-section">trySend
    394. 

  394.   <li><a class="reference" href="#trySend%2CSocket%2Cstring" title="trySend(socket: Socket; data: string): bool">trySend(socket: Socket; data: string): bool</a></li>
    395. 

  395. 

  396. </ul>
    397. 

  397. <ul class="simple nested-toc-section">wrapConnectedSocket
    398. 

  398.   <li><a class="reference" href="#wrapConnectedSocket%2CSslContext%2CSocket%2CSslHandshakeType%2Cstring" title="wrapConnectedSocket(ctx: SslContext; socket: Socket;
    399. 

  399.                     handshake: SslHandshakeType; hostname: string = &quot;&quot;)">wrapConnectedSocket(ctx: SslContext; socket: Socket;
    400. 

  400.                     handshake: SslHandshakeType; hostname: string = &quot;&quot;)</a></li>
    401. 

  401. 

  402. </ul>
    403. 

  403. <ul class="simple nested-toc-section">wrapSocket
    404. 

  404.   <li><a class="reference" href="#wrapSocket%2CSslContext%2CSocket" title="wrapSocket(ctx: SslContext; socket: Socket)">wrapSocket(ctx: SslContext; socket: Socket)</a></li>
    405. 

  405. 

  406. </ul>
    407. 

  407. 

  408.     </ul>
    409. 

  409.   </details>
    410. 

  410. </li>
    411. 

  411. <li>
    412. 

  412.   <details open>
    413. 

  413.     <summary><a class="reference reference-toplevel" href="#18" id="68">Templates</a></summary>
    414. 

  414.     <ul class="simple simple-toc-section">
    415. 

  415.       <ul class="simple nested-toc-section">&=
    416. 

  416.   <li><a class="reference" href="#%26%3D.t%2CSocket%2Ctyped" title="`&amp;=`(socket: Socket; data: typed)">`&amp;=`(socket: Socket; data: typed)</a></li>
    417. 

  417. 

  418. </ul>
    419. 

  419. 

  420.     </ul>
    421. 

  421.   </details>
    422. 

  422. </li>
    423. 

  423. 

  424. </ul>
    425. 

  425. 

  426.   </div>
    427. 

  427.   <div class="nine columns" id="content">
    428. 

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

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

  430. 

  431.     <div id="tocRoot"></div>
    432. 

  432.     
    433. 

  433.     <p class="module-desc"><p>This module implements a high-level cross-platform sockets interface. The procedures implemented in this module are primarily for blocking sockets. For asynchronous non-blocking sockets use the <tt class="docutils literal"><span class="pre"><span class="Identifier">asyncnet</span></span></tt> module together with the <tt class="docutils literal"><span class="pre"><span class="Identifier">asyncdispatch</span></span></tt> module.</p>
    434. 

  434. <p>The first thing you will always need to do in order to start using sockets, is to create a new instance of the <tt class="docutils literal"><span class="pre"><span class="Identifier">Socket</span></span></tt> type using the <tt class="docutils literal"><span class="pre"><span class="Identifier">newSocket</span></span></tt> procedure.</p>
    435. 

  435. 

  436. <h1><a class="toc-backref" id="ssl" href="#ssl">SSL</a></h1><p>In order to use the SSL procedures defined in this module, you will need to compile your application with the <tt class="docutils literal"><span class="pre"><span class="Operator">-</span><span class="Identifier">d</span><span class="Punctuation">:</span><span class="Identifier">ssl</span></span></tt> flag. See the <a class="reference external" href="net.html#newContext%2Cstring%2Cstring%2Cstring%2Cstring">newContext</a> procedure for additional details.</p>
    437. 

  437. 

  438. <h1><a class="toc-backref" id="ssl-on-windows" href="#ssl-on-windows">SSL on Windows</a></h1><p>On Windows the SSL library checks for valid certificates. It uses the <tt class="docutils literal"><span class="pre"><span class="Identifier">cacert</span><span class="Operator">.</span><span class="Identifier">pem</span></span></tt> file for this purpose which was extracted from <tt class="docutils literal"><span class="pre"><span class="Identifier">https</span><span class="Punctuation">:</span><span class="Operator">//</span><span class="Identifier">curl</span><span class="Operator">.</span><span class="Identifier">se</span><span class="Operator">/</span><span class="Identifier">ca</span><span class="Operator">/</span><span class="Identifier">cacert</span><span class="Operator">.</span><span class="Identifier">pem</span></span></tt>. Besides the OpenSSL DLLs (e.g. libssl-1_1-x64.dll, libcrypto-1_1-x64.dll) you also need to ship <tt class="docutils literal"><span class="pre"><span class="Identifier">cacert</span><span class="Operator">.</span><span class="Identifier">pem</span></span></tt> with your <tt class="docutils literal"><span class="pre"><span class="Operator">.</span><span class="Identifier">exe</span></span></tt> file.</p>
    439. 

  439. 

  440. <h1><a class="toc-backref" id="examples" href="#examples">Examples</a></h1>
    441. 

  441. <h2><a class="toc-backref" id="examples-connecting-to-a-server" href="#examples-connecting-to-a-server">Connecting to a server</a></h2><p>After you create a socket with the <tt class="docutils literal"><span class="pre"><span class="Identifier">newSocket</span></span></tt> procedure, you can easily connect it to a server running at a known hostname (or IP address) and port. To do so over TCP, use the example below.</p>
    442. 

  442. 

  443. <p><strong class="examples_text">Example: cmd: -r:off</strong></p>
    444. 

  444. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">net</span>
    445. 

  445. <span class="Keyword">let</span> <span class="Identifier">socket</span> <span class="Operator">=</span> <span class="Identifier">newSocket</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    446. 

  446. <span class="Identifier">socket</span><span class="Operator">.</span><span class="Identifier">connect</span><span class="Punctuation">(</span><span class="StringLit">&quot;google.com&quot;</span><span class="Punctuation">,</span> <span class="Identifier">Port</span><span class="Punctuation">(</span><span class="DecNumber">80</span><span class="Punctuation">)</span><span class="Punctuation">)</span></pre>For SSL, use the following example:
    447. 

  447. <p><strong class="examples_text">Example: cmd: -r:off -d:ssl</strong></p>
    448. 

  448. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">net</span>
    449. 

  449. <span class="Keyword">let</span> <span class="Identifier">socket</span> <span class="Operator">=</span> <span class="Identifier">newSocket</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    450. 

  450. <span class="Keyword">let</span> <span class="Identifier">ctx</span> <span class="Operator">=</span> <span class="Identifier">newContext</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    451. 

  451. <span class="Identifier">wrapSocket</span><span class="Punctuation">(</span><span class="Identifier">ctx</span><span class="Punctuation">,</span> <span class="Identifier">socket</span><span class="Punctuation">)</span>
    452. 

  452. <span class="Identifier">socket</span><span class="Operator">.</span><span class="Identifier">connect</span><span class="Punctuation">(</span><span class="StringLit">&quot;google.com&quot;</span><span class="Punctuation">,</span> <span class="Identifier">Port</span><span class="Punctuation">(</span><span class="DecNumber">443</span><span class="Punctuation">)</span><span class="Punctuation">)</span></pre>UDP is a connectionless protocol, so UDP sockets don't have to explicitly call the <a class="reference external" href="net.html#connect%2CSocket%2Cstring">connect</a> procedure. They can simply start sending data immediately.
    453. 

  453. <p><strong class="examples_text">Example: cmd: -r:off</strong></p>
    454. 

  454. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">net</span>
    455. 

  455. <span class="Keyword">let</span> <span class="Identifier">socket</span> <span class="Operator">=</span> <span class="Identifier">newSocket</span><span class="Punctuation">(</span><span class="Identifier">AF_INET</span><span class="Punctuation">,</span> <span class="Identifier">SOCK_DGRAM</span><span class="Punctuation">,</span> <span class="Identifier">IPPROTO_UDP</span><span class="Punctuation">)</span>
    456. 

  456. <span class="Identifier">socket</span><span class="Operator">.</span><span class="Identifier">sendTo</span><span class="Punctuation">(</span><span class="StringLit">&quot;192.168.0.1&quot;</span><span class="Punctuation">,</span> <span class="Identifier">Port</span><span class="Punctuation">(</span><span class="DecNumber">27960</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="StringLit">&quot;status</span><span class="EscapeSequence">\n</span><span class="StringLit">&quot;</span><span class="Punctuation">)</span></pre>
    457. 

  457. <p><strong class="examples_text">Example: cmd: -r:off</strong></p>
    458. 

  458. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">net</span>
    459. 

  459. <span class="Keyword">let</span> <span class="Identifier">socket</span> <span class="Operator">=</span> <span class="Identifier">newSocket</span><span class="Punctuation">(</span><span class="Identifier">AF_INET</span><span class="Punctuation">,</span> <span class="Identifier">SOCK_DGRAM</span><span class="Punctuation">,</span> <span class="Identifier">IPPROTO_UDP</span><span class="Punctuation">)</span>
    460. 

  460. <span class="Keyword">let</span> <span class="Identifier">ip</span> <span class="Operator">=</span> <span class="Identifier">parseIpAddress</span><span class="Punctuation">(</span><span class="StringLit">&quot;192.168.0.1&quot;</span><span class="Punctuation">)</span>
    461. 

  461. <span class="Identifier">doAssert</span> <span class="Identifier">socket</span><span class="Operator">.</span><span class="Identifier">sendTo</span><span class="Punctuation">(</span><span class="Identifier">ip</span><span class="Punctuation">,</span> <span class="Identifier">Port</span><span class="Punctuation">(</span><span class="DecNumber">27960</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="StringLit">&quot;status</span><span class="EscapeSequence">\c</span><span class="EscapeSequence">\l</span><span class="StringLit">&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">8</span></pre>
    462. 

  462. <h2><a class="toc-backref" id="examples-creating-a-server" href="#examples-creating-a-server">Creating a server</a></h2><p>After you create a socket with the <tt class="docutils literal"><span class="pre"><span class="Identifier">newSocket</span></span></tt> procedure, you can create a TCP server by calling the <tt class="docutils literal"><span class="pre"><span class="Identifier">bindAddr</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">listen</span></span></tt> procedures.</p>
    463. 

  463. 

  464. <p><strong class="examples_text">Example: cmd: -r:off</strong></p>
    465. 

  465. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">net</span>
    466. 

  466. <span class="Keyword">let</span> <span class="Identifier">socket</span> <span class="Operator">=</span> <span class="Identifier">newSocket</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    467. 

  467. <span class="Identifier">socket</span><span class="Operator">.</span><span class="Identifier">bindAddr</span><span class="Punctuation">(</span><span class="Identifier">Port</span><span class="Punctuation">(</span><span class="DecNumber">1234</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
    468. 

  468. <span class="Identifier">socket</span><span class="Operator">.</span><span class="Identifier">listen</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    469. 

  469. 

  470. <span class="Comment"># You can then begin accepting connections using the `accept` procedure.</span>
    471. 

  471. <span class="Keyword">var</span> <span class="Identifier">client</span><span class="Punctuation">:</span> <span class="Identifier">Socket</span>
    472. 

  472. <span class="Keyword">var</span> <span class="Identifier">address</span> <span class="Operator">=</span> <span class="StringLit">&quot;&quot;</span>
    473. 

  473. <span class="Keyword">while</span> <span class="Identifier">true</span><span class="Punctuation">:</span>
    474. 

  474.   <span class="Identifier">socket</span><span class="Operator">.</span><span class="Identifier">acceptAddr</span><span class="Punctuation">(</span><span class="Identifier">client</span><span class="Punctuation">,</span> <span class="Identifier">address</span><span class="Punctuation">)</span>
    475. 

  475.   <span class="Identifier">echo</span> <span class="StringLit">&quot;Client connected from: &quot;</span><span class="Punctuation">,</span> <span class="Identifier">address</span></pre></p>
    476. 

  476.     <div class="section" id="6">
    477. 

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

  478.   <dl class="item">
    479. 

  479.     <a class="reference external" href="since.html">since</a>, <a class="reference external" href="assertions.html">assertions</a>, <a class="reference external" href="nativesockets.html">nativesockets</a>, <a class="reference external" href="os.html">os</a>, <a class="reference external" href="strutils.html">strutils</a>, <a class="reference external" href="times.html">times</a>, <a class="reference external" href="sets.html">sets</a>, <a class="reference external" href="options.html">options</a>, <a class="reference external" href="monotimes.html">monotimes</a>, <a class="reference external" href="ssl_config.html">ssl_config</a>, <a class="reference external" href="winlean.html">winlean</a>, <a class="reference external" href="openssl.html">openssl</a>, <a class="reference external" href="ssl_certs.html">ssl_certs</a>, <a class="reference external" href="posix.html">posix</a>, <a class="reference external" href="posix.html">posix</a>, <a class="reference external" href="posix.html">posix</a>
    480. 

  480.   </dl>
    481. 

  481. </div>
    482. 

  482. <div class="section" id="7">
    483. 

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

  484.   <dl class="item">
    485. 

  485.     <div id="Certificate">
    486. 

  486.   <dt><pre><a href="net.html#Certificate"><span class="Identifier">Certificate</span></a> <span class="Other">=</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
    487. 

  487.   <dd>
    488. 

  488.     
    489. 

  489.     DER encoded certificate
    490. 

  490.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L119" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    491. 

  491. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L119" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    492. 

  492. 

  493.   </dd>
    494. 

  494. </div>
    495. 

  495. <div id="IpAddress">
    496. 

  496.   <dt><pre><a href="net.html#IpAddress"><span class="Identifier">IpAddress</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
    497. 

  497.   <span class="Keyword">case</span> <span class="Identifier">family</span><span class="Operator">*</span><span class="Other">:</span> <a href="net.html#IpAddressFamily"><span class="Identifier">IpAddressFamily</span></a> <span class="Comment">## the type of the IP address (IPv4 or IPv6)</span>
    498. 

  498.   <span class="Keyword">of</span> <span class="Identifier">IpAddressFamily</span><span class="Other">.</span><span class="Identifier">IPv6</span><span class="Other">:</span>
    499. 

  499.     <span class="Identifier">address_v6</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#array"><span class="Identifier">array</span></a><span class="Other">[</span><span class="DecNumber">0</span> <span class="Operator">..</span> <span class="DecNumber">15</span><span class="Other">,</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a><span class="Other">]</span> <span class="Comment">## Contains the IP address in bytes in</span>
    500. 

  500.                                        <span class="Comment">## case of IPv6</span>
    501. 

  501.   <span class="Keyword">of</span> <span class="Identifier">IpAddressFamily</span><span class="Other">.</span><span class="Identifier">IPv4</span><span class="Other">:</span>
    502. 

  502.     <span class="Identifier">address_v4</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#array"><span class="Identifier">array</span></a><span class="Other">[</span><span class="DecNumber">0</span> <span class="Operator">..</span> <span class="DecNumber">3</span><span class="Other">,</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a><span class="Other">]</span> <span class="Comment">## Contains the IP address in bytes in</span>
    503. 

  503.                                       <span class="Comment">## case of IPv4</span></pre></dt>
    504. 

  504.   <dd>
    505. 

  505.     
    506. 

  506.     stores an arbitrary IP address
    507. 

  507.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L199" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    508. 

  508. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L199" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    509. 

  509. 

  510.   </dd>
    511. 

  511. </div>
    512. 

  512. <div id="IpAddressFamily">
    513. 

  513.   <dt><pre><a href="net.html#IpAddressFamily"><span class="Identifier">IpAddressFamily</span></a> {.<span class="Identifier">pure</span>.} <span class="Other">=</span> <span class="Keyword">enum</span>
    514. 

  514.   <span class="Identifier">IPv6</span><span class="Other">,</span>                     <span class="Comment">## IPv6 address</span>
    515. 

  515.   <span class="Identifier">IPv4</span>                       <span class="Comment">## IPv4 address</span></pre></dt>
    516. 

  516.   <dd>
    517. 

  517.     
    518. 

  518.     Describes the type of an IP address
    519. 

  519.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L195" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    520. 

  520. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L195" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    521. 

  521. 

  522.   </dd>
    523. 

  523. </div>
    524. 

  524. <div id="ReadLineResult">
    525. 

  525.   <dt><pre><a href="net.html#ReadLineResult"><span class="Identifier">ReadLineResult</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    526. 

  526.   <span class="Identifier">ReadFullLine</span><span class="Other">,</span> <span class="Identifier">ReadPartialLine</span><span class="Other">,</span> <span class="Identifier">ReadDisconnected</span><span class="Other">,</span> <span class="Identifier">ReadNone</span></pre></dt>
    527. 

  527.   <dd>
    528. 

  528.     
    529. 

  529.     result for readLineAsync
    530. 

  530.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L182" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    531. 

  531. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L182" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    532. 

  532. 

  533.   </dd>
    534. 

  534. </div>
    535. 

  535. <div id="SOBool">
    536. 

  536.   <dt><pre><a href="net.html#SOBool"><span class="Identifier">SOBool</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    537. 

  537.   <span class="Identifier">OptAcceptConn</span><span class="Other">,</span> <span class="Identifier">OptBroadcast</span><span class="Other">,</span> <span class="Identifier">OptDebug</span><span class="Other">,</span> <span class="Identifier">OptDontRoute</span><span class="Other">,</span> <span class="Identifier">OptKeepAlive</span><span class="Other">,</span>
    538. 

  538.   <span class="Identifier">OptOOBInline</span><span class="Other">,</span> <span class="Identifier">OptReuseAddr</span><span class="Other">,</span> <span class="Identifier">OptReusePort</span><span class="Other">,</span> <span class="Identifier">OptNoDelay</span></pre></dt>
    539. 

  539.   <dd>
    540. 

  540.     
    541. 

  541.     Boolean socket options.
    542. 

  542.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L178" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    543. 

  543. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L178" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    544. 

  544. 

  545.   </dd>
    546. 

  546. </div>
    547. 

  547. <div id="Socket">
    548. 

  548.   <dt><pre><a href="net.html#Socket"><span class="Identifier">Socket</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <a href="net.html#SocketImpl"><span class="Identifier">SocketImpl</span></a></pre></dt>
    549. 

  549.   <dd>
    550. 

  550.     
    551. 

  551.     
    552. 

  552.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L176" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    553. 

  553. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L176" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    554. 

  554. 

  555.   </dd>
    556. 

  556. </div>
    557. 

  557. <div id="SocketFlag">
    558. 

  558.   <dt><pre><a href="net.html#SocketFlag"><span class="Identifier">SocketFlag</span></a> {.<span class="Identifier">pure</span>.} <span class="Other">=</span> <span class="Keyword">enum</span>
    559. 

  559.   <span class="Identifier">Peek</span><span class="Other">,</span> <span class="Identifier">SafeDisconn</span>          <span class="Comment">## Ensures disconnection exceptions (ECONNRESET, EPIPE etc) are not thrown.</span></pre></dt>
    560. 

  560.   <dd>
    561. 

  561.     
    562. 

  562.     
    563. 

  563.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L187" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    564. 

  564. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L187" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    565. 

  565. 

  566.   </dd>
    567. 

  567. </div>
    568. 

  568. <div id="SocketImpl">
    569. 

  569.   <dt><pre><a href="net.html#SocketImpl"><span class="Identifier">SocketImpl</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
    570. 

  570.   <span class="Keyword">when</span> <span class="Identifier">defineSsl</span><span class="Other">:</span>
    571. 

  571.   <span class="Comment">## stores the last error on this socket</span></pre></dt>
    572. 

  572.   <dd>
    573. 

  573.     
    574. 

  574.     socket type
    575. 

  575.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L157" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    576. 

  576. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L157" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    577. 

  577. 

  578.   </dd>
    579. 

  579. </div>
    580. 

  580. <div id="SslAcceptResult">
    581. 

  581.   <dt><pre><a href="net.html#SslAcceptResult"><span class="Identifier">SslAcceptResult</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    582. 

  582.   <span class="Identifier">AcceptNoClient</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">,</span> <span class="Identifier">AcceptNoHandshake</span><span class="Other">,</span> <span class="Identifier">AcceptSuccess</span></pre></dt>
    583. 

  583.   <dd>
    584. 

  584.     
    585. 

  585.     
    586. 

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

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

  588. 

  589.   </dd>
    590. 

  590. </div>
    591. 

  591. <div id="SslClientGetPskFunc">
    592. 

  592.   <dt><pre><a href="net.html#SslClientGetPskFunc"><span class="Identifier">SslClientGetPskFunc</span></a> <span class="Other">=</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">hint</span><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="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">identity</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span> <span class="Identifier">psk</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span></pre></dt>
    593. 

  593.   <dd>
    594. 

  594.     
    595. 

  595.     
    596. 

  596.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L140" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    597. 

  597. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L140" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    598. 

  598. 

  599.   </dd>
    600. 

  600. </div>
    601. 

  601. <div id="SslContext">
    602. 

  602.   <dt><pre><a href="net.html#SslContext"><span class="Identifier">SslContext</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span>
    603. 

  603.   <span class="Identifier">context</span><span class="Operator">*</span><span class="Other">:</span> <a href="openssl.html#SslCtx"><span class="Identifier">SslCtx</span></a></pre></dt>
    604. 

  604.   <dd>
    605. 

  605.     
    606. 

  606.     
    607. 

  607.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L129" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    608. 

  608. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L129" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    609. 

  609. 

  610.   </dd>
    611. 

  611. </div>
    612. 

  612. <div id="SslCVerifyMode">
    613. 

  613.   <dt><pre><a href="net.html#SslCVerifyMode"><span class="Identifier">SslCVerifyMode</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    614. 

  614.   <span class="Identifier">CVerifyNone</span><span class="Other">,</span> <span class="Identifier">CVerifyPeer</span><span class="Other">,</span> <span class="Identifier">CVerifyPeerUseEnvVars</span></pre></dt>
    615. 

  615.   <dd>
    616. 

  616.     
    617. 

  617.     
    618. 

  618.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L123" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    619. 

  619. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L123" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    620. 

  620. 

  621.   </dd>
    622. 

  622. </div>
    623. 

  623. <div id="SslError">
    624. 

  624.   <dt><pre><a href="net.html#SslError"><span class="Identifier">SslError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="system.html#CatchableError"><span class="Identifier">CatchableError</span></a></pre></dt>
    625. 

  625.   <dd>
    626. 

  626.     
    627. 

  627.     
    628. 

  628.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L121" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    629. 

  629. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L121" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    630. 

  630. 

  631.   </dd>
    632. 

  632. </div>
    633. 

  633. <div id="SslHandshakeType">
    634. 

  634.   <dt><pre><a href="net.html#SslHandshakeType"><span class="Identifier">SslHandshakeType</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    635. 

  635.   <span class="Identifier">handshakeAsClient</span><span class="Other">,</span> <span class="Identifier">handshakeAsServer</span></pre></dt>
    636. 

  636.   <dd>
    637. 

  637.     
    638. 

  638.     
    639. 

  639.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L137" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    640. 

  640. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L137" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    641. 

  641. 

  642.   </dd>
    643. 

  643. </div>
    644. 

  644. <div id="SslProtVersion">
    645. 

  645.   <dt><pre><a href="net.html#SslProtVersion"><span class="Identifier">SslProtVersion</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    646. 

  646.   <span class="Identifier">protSSLv2</span><span class="Other">,</span> <span class="Identifier">protSSLv3</span><span class="Other">,</span> <span class="Identifier">protTLSv1</span><span class="Other">,</span> <span class="Identifier">protSSLv23</span></pre></dt>
    647. 

  647.   <dd>
    648. 

  648.     
    649. 

  649.     
    650. 

  650.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L126" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    651. 

  651. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L126" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    652. 

  652. 

  653.   </dd>
    654. 

  654. </div>
    655. 

  655. <div id="SslServerGetPskFunc">
    656. 

  656.   <dt><pre><a href="net.html#SslServerGetPskFunc"><span class="Identifier">SslServerGetPskFunc</span></a> <span class="Other">=</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">identity</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
    657. 

  657.   <dd>
    658. 

  658.     
    659. 

  659.     
    660. 

  660.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L142" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    661. 

  661. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L142" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    662. 

  662. 

  663.   </dd>
    664. 

  664. </div>
    665. 

  665. <div id="TimeoutError">
    666. 

  666.   <dt><pre><a href="net.html#TimeoutError"><span class="Identifier">TimeoutError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="system.html#CatchableError"><span class="Identifier">CatchableError</span></a></pre></dt>
    667. 

  667.   <dd>
    668. 

  668.     
    669. 

  669.     
    670. 

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

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

  672. 

  673.   </dd>
    674. 

  674. </div>
    675. 

  675. 

  676.   </dl>
    677. 

  677. </div>
    678. 

  678. <div class="section" id="10">
    679. 

  679.   <h1><a class="toc-backref" href="#10">Consts</a></h1>
    680. 

  680.   <dl class="item">
    681. 

  681.     <div id="BufferSize">
    682. 

  682.   <dt><pre><a href="net.html#BufferSize"><span class="Identifier">BufferSize</span></a><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Other">=</span> <span class="DecNumber">4000</span></pre></dt>
    683. 

  683.   <dd>
    684. 

  684.     
    685. 

  685.     size of a buffered socket's buffer
    686. 

  686.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L153" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    687. 

  687. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L153" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    688. 

  688. 

  689.   </dd>
    690. 

  690. </div>
    691. 

  691. <div id="MaxLineLength">
    692. 

  692.   <dt><pre><a href="net.html#MaxLineLength"><span class="Identifier">MaxLineLength</span></a> <span class="Other">=</span> <span class="DecNumber">1000000</span></pre></dt>
    693. 

  693.   <dd>
    694. 

  694.     
    695. 

  695.     
    696. 

  696.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L154" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    697. 

  697. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L154" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    698. 

  698. 

  699.   </dd>
    700. 

  700. </div>
    701. 

  701. 

  702.   </dl>
    703. 

  703. </div>
    704. 

  704. <div class="section" id="12">
    705. 

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

  706.   <dl class="item">
    707. 

  707.     <div id="$-procs-all">
    708. 

  708.   <div id="$,IpAddress">
    709. 

  709.   <dt><pre><span class="Keyword">proc</span> <a href="#%24%2CIpAddress"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">address</span><span class="Other">:</span> <a href="net.html#IpAddress"><span class="Identifier">IpAddress</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</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>
    710. 

  710.   <dd>
    711. 

  711.     
    712. 

  712.     Converts an IpAddress into the textual representation
    713. 

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

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

  715. 

  716.   </dd>
    717. 

  717. </div>
    718. 

  718. 

  719. </div>
    720. 

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

  721.   <div id="==,IpAddress,IpAddress">
    722. 

  722.   <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2CIpAddress%2CIpAddress"><span class="Identifier">`==`</span></a><span class="Other">(</span><span class="Identifier">lhs</span><span class="Other">,</span> <span class="Identifier">rhs</span><span class="Other">:</span> <a href="net.html#IpAddress"><span class="Identifier">IpAddress</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> <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.     Compares two IpAddresses for Equality. Returns true if the addresses are equal
    726. 

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

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

  728. 

  729.   </dd>
    730. 

  730. </div>
    731. 

  731. 

  732. </div>
    733. 

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

  734.   <div id="accept,Socket,">
    735. 

  735.   <dt><pre><span class="Keyword">proc</span> <a href="#accept%2CSocket%2C"><span class="Identifier">accept</span></a><span class="Other">(</span><span class="Identifier">server</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</span></a><span class="Other">;</span> <span class="Identifier">client</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">owned</span><span class="Other">(</span><span class="Identifier">Socket</span><span class="Other">)</span><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>
    736. 

  736.             <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><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ReadIOEffect"><span class="Identifier">ReadIOEffect</span></a><span class="Other">]</span><span class="Other">,</span>
    737. 

  737.     <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">SslError</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>
    738. 

  738.   <dd>
    739. 

  739.     
    740. 

  740.     <p>Equivalent to <tt class="docutils literal"><span class="pre"><span class="Identifier">acceptAddr</span></span></tt> but doesn't return the address, only the socket.</p>
    741. 

  741. <p>The SocketHandle associated with the resulting client will not be inheritable by child processes by default. This can be changed via the <tt class="docutils literal"><span class="pre"><span class="Identifier">inheritable</span></span></tt> parameter.</p>
    742. 

  742. <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>
    743. 

  743. 

  744.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1139" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    745. 

  745. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1139" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    746. 

  746. 

  747.   </dd>
    748. 

  748. </div>
    749. 

  749. 

  750. </div>
    751. 

  751. <div id="acceptAddr-procs-all">
    752. 

  752.   <div id="acceptAddr,Socket,,string">
    753. 

  753.   <dt><pre><span class="Keyword">proc</span> <a href="#acceptAddr%2CSocket%2C%2Cstring"><span class="Identifier">acceptAddr</span></a><span class="Other">(</span><span class="Identifier">server</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</span></a><span class="Other">;</span> <span class="Identifier">client</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">owned</span><span class="Other">(</span><span class="Identifier">Socket</span><span class="Other">)</span><span class="Other">;</span> <span class="Identifier">address</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span>
    754. 

  754.                 <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="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> {.
    755. 

  755.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ReadIOEffect"><span class="Identifier">ReadIOEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <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">SslError</span><span class="Other">]</span><span class="Other">,</span>
    756. 

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

  757.   <dd>
    758. 

  758.     
    759. 

  759.     <p>Blocks until a connection is being made from a client. When a connection is made sets <tt class="docutils literal"><span class="pre"><span class="Identifier">client</span></span></tt> to the client socket and <tt class="docutils literal"><span class="pre"><span class="Identifier">address</span></span></tt> to the address of the connecting client. This function will raise OSError if an error occurs.</p>
    760. 

  760. <p>The resulting client will inherit any properties of the server socket. For example: whether the socket is buffered or not.</p>
    761. 

  761. <p>The SocketHandle associated with the resulting client will not be inheritable by child processes by default. This can be changed via the <tt class="docutils literal"><span class="pre"><span class="Identifier">inheritable</span></span></tt> parameter.</p>
    762. 

  762. <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>
    763. 

  763. 

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

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

  766. 

  767.   </dd>
    768. 

  768. </div>
    769. 

  769. 

  770. </div>
    771. 

  771. <div id="bindAddr-procs-all">
    772. 

  772.   <div id="bindAddr,Socket,string">
    773. 

  773.   <dt><pre><span class="Keyword">proc</span> <a href="#bindAddr%2CSocket%2Cstring"><span class="Identifier">bindAddr</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</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="DecNumber">0</span><span class="Other">)</span><span class="Other">;</span> <span class="Identifier">address</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">)</span> {.
    774. 

  774.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ReadIOEffect"><span class="Identifier">ReadIOEffect</span></a><span class="Other">]</span><span class="Other">,</span> <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="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>Binds <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> to the socket.</p>
    778. 

  778. <p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">address</span></span></tt> is &quot;&quot; then ADDR_ANY will be bound.</p>
    779. 

  779. 

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

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

  782. 

  783.   </dd>
    784. 

  784. </div>
    785. 

  785. 

  786. </div>
    787. 

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

  788.   <div id="bindUnix,Socket,string">
    789. 

  789.   <dt><pre><span class="Keyword">proc</span> <a href="#bindUnix%2CSocket%2Cstring"><span class="Identifier">bindUnix</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</span></a><span class="Other">;</span> <span class="Identifier">path</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</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>
    790. 

  790.   <dd>
    791. 

  791.     
    792. 

  792.     Binds Unix socket to <tt class="docutils literal"><span class="pre"><span class="Identifier">path</span></span></tt>. This only works on Unix-style systems: Mac OS X, BSD and Linux
    793. 

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

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

  795. 

  796.   </dd>
    797. 

  797. </div>
    798. 

  798. 

  799. </div>
    800. 

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

  801.   <div id="clientGetPskFunc,SslContext">
    802. 

  802.   <dt><pre><span class="Keyword">proc</span> <a href="#clientGetPskFunc%2CSslContext"><span class="Identifier">clientGetPskFunc</span></a><span class="Other">(</span><span class="Identifier">ctx</span><span class="Other">:</span> <a href="net.html#SslContext"><span class="Identifier">SslContext</span></a><span class="Other">)</span><span class="Other">:</span> <a href="net.html#SslClientGetPskFunc"><span class="Identifier">SslClientGetPskFunc</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>
    803. 

  803.     <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>
    804. 

  804.   <dd>
    805. 

  805.     
    806. 

  806.     
    807. 

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

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

  809. 

  810.   </dd>
    811. 

  811. </div>
    812. 

  812. 

  813. </div>
    814. 

  814. <div id="clientGetPskFunc=-procs-all">
    815. 

  815.   <div id="clientGetPskFunc=,SslContext,SslClientGetPskFunc">
    816. 

  816.   <dt><pre><span class="Keyword">proc</span> <a href="#clientGetPskFunc%3D%2CSslContext%2CSslClientGetPskFunc"><span class="Identifier">clientGetPskFunc=</span></a><span class="Other">(</span><span class="Identifier">ctx</span><span class="Other">:</span> <a href="net.html#SslContext"><span class="Identifier">SslContext</span></a><span class="Other">;</span> <span class="Identifier">fun</span><span class="Other">:</span> <a href="net.html#SslClientGetPskFunc"><span class="Identifier">SslClientGetPskFunc</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>
    817. 

  817.     <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>
    818. 

  818.   <dd>
    819. 

  819.     
    820. 

  820.     <p>Sets function that returns the client identity and the PSK based on identity hint from the server.</p>
    821. 

  821. <p>Only used in PSK ciphersuites.</p>
    822. 

  822. 

  823.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L774" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    824. 

  824. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L774" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    825. 

  825. 

  826.   </dd>
    827. 

  827. </div>
    828. 

  828. 

  829. </div>
    830. 

  830. <div id="close-procs-all">
    831. 

  831.   <div id="close,Socket">
    832. 

  832.   <dt><pre><span class="Keyword">proc</span> <a href="#close%2CSocket"><span class="Identifier">close</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</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> {.
    833. 

  833.     <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">LibraryError</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="Identifier">SslError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    834. 

  834.     <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>
    835. 

  835.   <dd>
    836. 

  836.     
    837. 

  837.     <p>Closes a socket.</p>
    838. 

  838. <p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">socket</span></span></tt> is an SSL/TLS socket, this proc will also send a closure notification to the peer. If <tt class="docutils literal"><span class="pre"><span class="Identifier">SafeDisconn</span></span></tt> is in <tt class="docutils literal"><span class="pre"><span class="Identifier">flags</span></span></tt>, failure to do so due to disconnections will be ignored. This is generally safe in practice. See <a class="reference external" href="https://security.stackexchange.com/a/82044">here</a> for more details.</p>
    839. 

  839. 

  840.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1215" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    841. 

  841. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1215" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    842. 

  842. 

  843.   </dd>
    844. 

  844. </div>
    845. 

  845. 

  846. </div>
    847. 

  847. <div id="connect-procs-all">
    848. 

  848.   <div id="connect,Socket,string">
    849. 

  849.   <dt><pre><span class="Keyword">proc</span> <a href="#connect%2CSocket%2Cstring"><span class="Identifier">connect</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</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="DecNumber">0</span><span class="Other">)</span><span class="Other">)</span> {.
    850. 

  850.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ReadIOEffect"><span class="Identifier">ReadIOEffect</span></a><span class="Other">,</span> <a href="system.html#RootEffect"><span class="Identifier">RootEffect</span></a><span class="Other">]</span><span class="Other">,</span> <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">SslError</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>
    851. 

  851.   <dd>
    852. 

  852.     
    853. 

  853.     <p>Connects socket to <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>. <tt class="docutils literal"><span class="pre"><span class="Identifier">Address</span></span></tt> can be an IP address or a host name. If <tt class="docutils literal"><span class="pre"><span class="Identifier">address</span></span></tt> is a host name, this function will try each IP of that host name. <tt class="docutils literal"><span class="pre"><span class="Identifier">htons</span></span></tt> is already performed on <tt class="docutils literal"><span class="pre"><span class="Identifier">port</span></span></tt> so you must not do it.</p>
    854. 

  854. <p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">socket</span></span></tt> is an SSL socket a handshake will be automatically performed.</p>
    855. 

  855. 

  856.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L2051" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    857. 

  857. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L2051" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    858. 

  858. 

  859.   </dd>
    860. 

  860. </div>
    861. 

  861. <div id="connect,Socket,string,int">
    862. 

  862.   <dt><pre><span class="Keyword">proc</span> <a href="#connect%2CSocket%2Cstring%2Cint"><span class="Identifier">connect</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</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="DecNumber">0</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> {.
    863. 

  863.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ReadIOEffect"><span class="Identifier">ReadIOEffect</span></a><span class="Other">,</span> <a href="exceptions.html#WriteIOEffect"><span class="Identifier">WriteIOEffect</span></a><span class="Other">,</span> <a href="system.html#RootEffect"><span class="Identifier">RootEffect</span></a><span class="Other">]</span><span class="Other">,</span>
    864. 

  864.     <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">TimeoutError</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.     <p>Connects to server as specified by <tt class="docutils literal"><span class="pre"><span class="Identifier">address</span></span></tt> on port specified by <tt class="docutils literal"><span class="pre"><span class="Identifier">port</span></span></tt>.</p>
    868. 

  868. <p>The <tt class="docutils literal"><span class="pre"><span class="Identifier">timeout</span></span></tt> parameter specifies the time in milliseconds to allow for the connection to the server to be made.</p>
    869. 

  869. 

  870.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L2126" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    871. 

  871. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L2126" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    872. 

  872. 

  873.   </dd>
    874. 

  874. </div>
    875. 

  875. 

  876. </div>
    877. 

  877. <div id="connectUnix-procs-all">
    878. 

  878.   <div id="connectUnix,Socket,string">
    879. 

  879.   <dt><pre><span class="Keyword">proc</span> <a href="#connectUnix%2CSocket%2Cstring"><span class="Identifier">connectUnix</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</span></a><span class="Other">;</span> <span class="Identifier">path</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</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>
    880. 

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

  881.   <dd>
    882. 

  882.     
    883. 

  883.     Connects to Unix socket on <tt class="docutils literal"><span class="pre"><span class="Identifier">path</span></span></tt>. This only works on Unix-style systems: Mac OS X, BSD and Linux
    884. 

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

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

  886. 

  887.   </dd>
    888. 

  888. </div>
    889. 

  889. 

  890. </div>
    891. 

  891. <div id="destroyContext-procs-all">
    892. 

  892.   <div id="destroyContext,SslContext">
    893. 

  893.   <dt><pre><span class="Keyword">proc</span> <a href="#destroyContext%2CSslContext"><span class="Identifier">destroyContext</span></a><span class="Other">(</span><span class="Identifier">ctx</span><span class="Other">:</span> <a href="net.html#SslContext"><span class="Identifier">SslContext</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">SslError</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>
    894. 

  894.   <dd>
    895. 

  895.     
    896. 

  896.     Free memory referenced by SslContext.
    897. 

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

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

  899. 

  900.   </dd>
    901. 

  901. </div>
    902. 

  902. 

  903. </div>
    904. 

  904. <div id="dial-procs-all">
    905. 

  905.   <div id="dial,string,Port">
    906. 

  906.   <dt><pre><span class="Keyword">proc</span> <a href="#dial%2Cstring%2CPort"><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> <span class="Identifier">IPPROTO_TCP</span><span class="Other">;</span> <span class="Identifier">buffered</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span>
    907. 

  907.     <span class="Identifier">Socket</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ReadIOEffect"><span class="Identifier">ReadIOEffect</span></a><span class="Other">,</span> <a href="exceptions.html#WriteIOEffect"><span class="Identifier">WriteIOEffect</span></a><span class="Other">]</span><span class="Other">,</span> <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="Other">,</span>
    908. 

  908.               <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.     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 Socket ready to send or receive data.
    912. 

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

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

  914. 

  915.   </dd>
    916. 

  916. </div>
    917. 

  917. 

  918. </div>
    919. 

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

  920.   <div id="fromSockAddr,,SockLen,IpAddress,Port">
    921. 

  921.   <dt><pre><span class="Keyword">proc</span> <a href="#fromSockAddr%2C%2CSockLen%2CIpAddress%2CPort"><span class="Identifier">fromSockAddr</span></a><span class="Other">(</span><span class="Identifier">sa</span><span class="Other">:</span> <a href="winlean.html#Sockaddr_storage"><span class="Identifier">Sockaddr_storage</span></a> <span class="Operator">|</span> <a href="winlean.html#SockAddr"><span class="Identifier">SockAddr</span></a> <span class="Operator">|</span> <a href="winlean.html#Sockaddr_in"><span class="Identifier">Sockaddr_in</span></a> <span class="Operator">|</span> <a href="winlean.html#Sockaddr_in6"><span class="Identifier">Sockaddr_in6</span></a><span class="Other">;</span>
    922. 

  922.                   <span class="Identifier">sl</span><span class="Other">:</span> <a href="winlean.html#SockLen"><span class="Identifier">SockLen</span></a><span class="Other">;</span> <span class="Identifier">address</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="net.html#IpAddress"><span class="Identifier">IpAddress</span></a><span class="Other">;</span> <span class="Identifier">port</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="nativesockets.html#Port"><span class="Identifier">Port</span></a><span class="Other">)</span> {.<span class="Identifier">inline</span>.}</pre></dt>
    923. 

  923.   <dd>
    924. 

  924.     
    925. 

  925.     Converts <tt class="docutils literal"><span class="pre"><span class="Identifier">SockAddr</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">SockLen</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">IpAddress</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">Port</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">ObjectConversionDefect</span></span></tt> in case of invalid <tt class="docutils literal"><span class="pre"><span class="Identifier">sa</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">sl</span></span></tt> arguments.
    926. 

  926.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L544" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    927. 

  927. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L544" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    928. 

  928. 

  929.   </dd>
    930. 

  930. </div>
    931. 

  931. 

  932. </div>
    933. 

  933. <div id="getExtraData-procs-all">
    934. 

  934.   <div id="getExtraData,SslContext,int">
    935. 

  935.   <dt><pre><span class="Keyword">proc</span> <a href="#getExtraData%2CSslContext%2Cint"><span class="Identifier">getExtraData</span></a><span class="Other">(</span><span class="Identifier">ctx</span><span class="Other">:</span> <a href="net.html#SslContext"><span class="Identifier">SslContext</span></a><span class="Other">;</span> <span class="Identifier">index</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#RootRef"><span class="Identifier">RootRef</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">SslError</span><span class="Other">]</span><span class="Other">,</span>
    936. 

  936.     <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>
    937. 

  937.   <dd>
    938. 

  938.     
    939. 

  939.     Retrieves arbitrary data stored inside SslContext.
    940. 

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

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

  942. 

  943.   </dd>
    944. 

  944. </div>
    945. 

  945. 

  946. </div>
    947. 

  947. <div id="getFd-procs-all">
    948. 

  948.   <div id="getFd,Socket">
    949. 

  949.   <dt><pre><span class="Keyword">proc</span> <a href="#getFd%2CSocket"><span class="Identifier">getFd</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</span></a><span class="Other">)</span><span class="Other">:</span> <a href="winlean.html#SocketHandle"><span class="Identifier">SocketHandle</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>
    950. 

  950.   <dd>
    951. 

  951.     
    952. 

  952.     Returns the socket's file descriptor
    953. 

  953.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1860" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    954. 

  954. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1860" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    955. 

  955. 

  956.   </dd>
    957. 

  957. </div>
    958. 

  958. 

  959. </div>
    960. 

  960. <div id="getLocalAddr-procs-all">
    961. 

  961.   <div id="getLocalAddr,Socket">
    962. 

  962.   <dt><pre><span class="Keyword">proc</span> <a href="#getLocalAddr%2CSocket"><span class="Identifier">getLocalAddr</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Other">(</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span> <a href="nativesockets.html#Port"><span class="Identifier">Port</span></a><span class="Other">)</span> {.
    963. 

  963.     <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">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="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>
    964. 

  964.   <dd>
    965. 

  965.     
    966. 

  966.     <p>Get the socket's local address and port number.</p>
    967. 

  967. <p>This is high-level interface for <span id="getsockname_1">getsockname</span>.</p>
    968. 

  968. 

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

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

  971. 

  972.   </dd>
    973. 

  973. </div>
    974. 

  974. 

  975. </div>
    976. 

  976. <div id="getPeerAddr-procs-all">
    977. 

  977.   <div id="getPeerAddr,Socket">
    978. 

  978.   <dt><pre><span class="Keyword">proc</span> <a href="#getPeerAddr%2CSocket"><span class="Identifier">getPeerAddr</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Other">(</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span> <a href="nativesockets.html#Port"><span class="Identifier">Port</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="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span>
    979. 

  979.     <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>
    980. 

  980.   <dd>
    981. 

  981.     
    982. 

  982.     <p>Get the socket's peer address and port number.</p>
    983. 

  983. <p>This is high-level interface for <span id="getpeername_1">getpeername</span>.</p>
    984. 

  984. 

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

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

  987. 

  988.   </dd>
    989. 

  989. </div>
    990. 

  990. 

  991. </div>
    992. 

  992. <div id="getPeerCertificates-procs-all">
    993. 

  993.   <div id="getPeerCertificates,Socket">
    994. 

  994.   <dt><pre><span class="Keyword">proc</span> <a href="#getPeerCertificates%2CSocket"><span class="Identifier">getPeerCertificates</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="net.html#Certificate"><span class="Identifier">Certificate</span></a><span class="Other">]</span> {.
    995. 

  995.     <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">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="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>
    996. 

  996.   <dd>
    997. 

  997.     
    998. 

  998.     Returns the certificate chain received by the peer we are connected to through the given socket. The handshake must have been completed and the certificate chain must have been verified successfully or else an empty sequence is returned. The chain is ordered from leaf certificate to root certificate.
    999. 

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

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

  1001. 

  1002.   </dd>
    1003. 

  1003. </div>
    1004. 

  1004. <div id="getPeerCertificates,SslPtr">
    1005. 

  1005.   <dt><pre><span class="Keyword">proc</span> <a href="#getPeerCertificates%2CSslPtr"><span class="Identifier">getPeerCertificates</span></a><span class="Other">(</span><span class="Identifier">sslHandle</span><span class="Other">:</span> <a href="openssl.html#SslPtr"><span class="Identifier">SslPtr</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="net.html#Certificate"><span class="Identifier">Certificate</span></a><span class="Other">]</span> {.
    1006. 

  1006.     <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">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="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>
    1007. 

  1007.   <dd>
    1008. 

  1008.     
    1009. 

  1009.     Returns the certificate chain received by the peer we are connected to through the OpenSSL connection represented by <tt class="docutils literal"><span class="pre"><span class="Identifier">sslHandle</span></span></tt>. The handshake must have been completed and the certificate chain must have been verified successfully or else an empty sequence is returned. The chain is ordered from leaf certificate to root certificate.
    1010. 

  1010.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L889" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1011. 

  1011. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L889" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1012. 

  1012. 

  1013.   </dd>
    1014. 

  1014. </div>
    1015. 

  1015. 

  1016. </div>
    1017. 

  1017. <div id="getPrimaryIPAddr-procs-all">
    1018. 

  1018.   <div id="getPrimaryIPAddr">
    1019. 

  1019.   <dt><pre><span class="Keyword">proc</span> <a href="#getPrimaryIPAddr"><span class="Identifier">getPrimaryIPAddr</span></a><span class="Other">(</span><span class="Identifier">dest</span> <span class="Other">=</span> <span class="Identifier">parseIpAddress</span><span class="Other">(</span><span class="StringLit">&quot;8.8.8.8&quot;</span><span class="Other">)</span><span class="Other">)</span><span class="Other">:</span> <a href="net.html#IpAddress"><span class="Identifier">IpAddress</span></a> {.
    1020. 

  1020.     <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">OSError</span><span class="Other">,</span> <span class="Identifier">SslError</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">LibraryError</span><span class="Other">]</span><span class="Other">,</span>
    1021. 

  1021.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</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>
    1022. 

  1022.   <dd>
    1023. 

  1023.     
    1024. 

  1024.     <p>Finds the local IP address, usually assigned to eth0 on LAN or wlan0 on WiFi, used to reach an external address. Useful to run local services.</p>
    1025. 

  1025. <p>No traffic is sent.</p>
    1026. 

  1026. <p>Supports IPv4 and v6. Raises OSError if external networking is not set up.</p>
    1027. 

  1027. 

  1028. <p><strong class="examples_text">Example: cmd: -r:off</strong></p>
    1029. 

  1029. <pre class="listing"><span class="Identifier">echo</span> <span class="Identifier">getPrimaryIPAddr</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Comment"># &quot;192.168.1.2&quot;</span></pre>
    1030. 

  1030.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L2158" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1031. 

  1031. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L2158" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1032. 

  1032. 

  1033.   </dd>
    1034. 

  1034. </div>
    1035. 

  1035. 

  1036. </div>
    1037. 

  1037. <div id="getPskIdentity-procs-all">
    1038. 

  1038.   <div id="getPskIdentity,Socket">
    1039. 

  1039.   <dt><pre><span class="Keyword">proc</span> <a href="#getPskIdentity%2CSocket"><span class="Identifier">getPskIdentity</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</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>
    1040. 

  1040.   <dd>
    1041. 

  1041.     
    1042. 

  1042.     Gets the PSK identity provided by the client.
    1043. 

  1043.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L804" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1044. 

  1044. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L804" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1045. 

  1045. 

  1046.   </dd>
    1047. 

  1047. </div>
    1048. 

  1048. 

  1049. </div>
    1050. 

  1050. <div id="getSocketError-procs-all">
    1051. 

  1051.   <div id="getSocketError,Socket">
    1052. 

  1052.   <dt><pre><span class="Keyword">proc</span> <a href="#getSocketError%2CSocket"><span class="Identifier">getSocketError</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</span></a><span class="Other">)</span><span class="Other">:</span> <a href="oserrors.html#OSErrorCode"><span class="Identifier">OSErrorCode</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>
    1053. 

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

  1054.   <dd>
    1055. 

  1055.     
    1056. 

  1056.     Checks <tt class="docutils literal"><span class="pre"><span class="Identifier">osLastError</span></span></tt> for a valid error. If it has been reset it uses the last error stored in the socket object.
    1057. 

  1057.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L935" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1058. 

  1058. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L935" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1059. 

  1059. 

  1060.   </dd>
    1061. 

  1061. </div>
    1062. 

  1062. 

  1063. </div>
    1064. 

  1064. <div id="getSockOpt-procs-all">
    1065. 

  1065.   <div id="getSockOpt,Socket,SOBool">
    1066. 

  1066.   <dt><pre><span class="Keyword">proc</span> <a href="#getSockOpt%2CSocket%2CSOBool"><span class="Identifier">getSockOpt</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</span></a><span class="Other">;</span> <span class="Identifier">opt</span><span class="Other">:</span> <a href="net.html#SOBool"><span class="Identifier">SOBool</span></a><span class="Other">;</span> <span class="Identifier">level</span> <span class="Other">=</span> <span class="Identifier">SOL_SOCKET</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.
    1067. 

  1067.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ReadIOEffect"><span class="Identifier">ReadIOEffect</span></a><span class="Other">]</span><span class="Other">,</span> <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">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1068. 

  1068.   <dd>
    1069. 

  1069.     
    1070. 

  1070.     Retrieves option <tt class="docutils literal"><span class="pre"><span class="Identifier">opt</span></span></tt> as a boolean value.
    1071. 

  1071.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1289" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1072. 

  1072. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1289" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1073. 

  1073. 

  1074.   </dd>
    1075. 

  1075. </div>
    1076. 

  1076. 

  1077. </div>
    1078. 

  1078. <div id="gotHandshake-procs-all">
    1079. 

  1079.   <div id="gotHandshake,Socket">
    1080. 

  1080.   <dt><pre><span class="Keyword">proc</span> <a href="#gotHandshake%2CSocket"><span class="Identifier">gotHandshake</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</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="Identifier">SslError</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>
    1081. 

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

  1082.   <dd>
    1083. 

  1083.     
    1084. 

  1084.     <p>Determines whether a handshake has occurred between a client (<tt class="docutils literal"><span class="pre"><span class="Identifier">socket</span></span></tt>) and the server that <tt class="docutils literal"><span class="pre"><span class="Identifier">socket</span></span></tt> is connected to.</p>
    1085. 

  1085. <p>Throws SslError if <tt class="docutils literal"><span class="pre"><span class="Identifier">socket</span></span></tt> is not an SSL socket.</p>
    1086. 

  1086. 

  1087.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1338" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1088. 

  1088. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1338" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1089. 

  1089. 

  1090.   </dd>
    1091. 

  1091. </div>
    1092. 

  1092. 

  1093. </div>
    1094. 

  1094. <div id="hasDataBuffered-procs-all">
    1095. 

  1095.   <div id="hasDataBuffered,Socket">
    1096. 

  1096.   <dt><pre><span class="Keyword">proc</span> <a href="#hasDataBuffered%2CSocket"><span class="Identifier">hasDataBuffered</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1097. 

  1097.   <dd>
    1098. 

  1098.     
    1099. 

  1099.     Determines whether a socket has data buffered.
    1100. 

  1100.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1348" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1101. 

  1101. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1348" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1102. 

  1102. 

  1103.   </dd>
    1104. 

  1104. </div>
    1105. 

  1105. 

  1106. </div>
    1107. 

  1107. <div id="IPv4_any-procs-all">
    1108. 

  1108.   <div id="IPv4_any">
    1109. 

  1109.   <dt><pre><span class="Keyword">proc</span> <a href="#IPv4_any"><span class="Identifier">IPv4_any</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="net.html#IpAddress"><span class="Identifier">IpAddress</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>
    1110. 

  1110.   <dd>
    1111. 

  1111.     
    1112. 

  1112.     Returns the IPv4 any address, which can be used to listen on all available network adapters
    1113. 

  1113.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1876" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1114. 

  1114. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1876" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1115. 

  1115. 

  1116.   </dd>
    1117. 

  1117. </div>
    1118. 

  1118. 

  1119. </div>
    1120. 

  1120. <div id="IPv4_broadcast-procs-all">
    1121. 

  1121.   <div id="IPv4_broadcast">
    1122. 

  1122.   <dt><pre><span class="Keyword">proc</span> <a href="#IPv4_broadcast"><span class="Identifier">IPv4_broadcast</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="net.html#IpAddress"><span class="Identifier">IpAddress</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>
    1123. 

  1123.   <dd>
    1124. 

  1124.     
    1125. 

  1125.     Returns the IPv4 broadcast address (255.255.255.255)
    1126. 

  1126.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1889" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1127. 

  1127. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1889" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1128. 

  1128. 

  1129.   </dd>
    1130. 

  1130. </div>
    1131. 

  1131. 

  1132. </div>
    1133. 

  1133. <div id="IPv4_loopback-procs-all">
    1134. 

  1134.   <div id="IPv4_loopback">
    1135. 

  1135.   <dt><pre><span class="Keyword">proc</span> <a href="#IPv4_loopback"><span class="Identifier">IPv4_loopback</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="net.html#IpAddress"><span class="Identifier">IpAddress</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>
    1136. 

  1136.   <dd>
    1137. 

  1137.     
    1138. 

  1138.     Returns the IPv4 loopback address (127.0.0.1)
    1139. 

  1139.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1883" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1140. 

  1140. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1883" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1141. 

  1141. 

  1142.   </dd>
    1143. 

  1143. </div>
    1144. 

  1144. 

  1145. </div>
    1146. 

  1146. <div id="IPv6_any-procs-all">
    1147. 

  1147.   <div id="IPv6_any">
    1148. 

  1148.   <dt><pre><span class="Keyword">proc</span> <a href="#IPv6_any"><span class="Identifier">IPv6_any</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="net.html#IpAddress"><span class="Identifier">IpAddress</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>
    1149. 

  1149.   <dd>
    1150. 

  1150.     
    1151. 

  1151.     Returns the IPv6 any address (::0), which can be used to listen on all available network adapters
    1152. 

  1152.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1895" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1153. 

  1153. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1895" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1154. 

  1154. 

  1155.   </dd>
    1156. 

  1156. </div>
    1157. 

  1157. 

  1158. </div>
    1159. 

  1159. <div id="IPv6_loopback-procs-all">
    1160. 

  1160.   <div id="IPv6_loopback">
    1161. 

  1161.   <dt><pre><span class="Keyword">proc</span> <a href="#IPv6_loopback"><span class="Identifier">IPv6_loopback</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="net.html#IpAddress"><span class="Identifier">IpAddress</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>
    1162. 

  1162.   <dd>
    1163. 

  1163.     
    1164. 

  1164.     Returns the IPv6 loopback address (::1)
    1165. 

  1165.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1902" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1166. 

  1166. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1902" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1167. 

  1167. 

  1168.   </dd>
    1169. 

  1169. </div>
    1170. 

  1170. 

  1171. </div>
    1172. 

  1172. <div id="isDisconnectionError-procs-all">
    1173. 

  1173.   <div id="isDisconnectionError,set[SocketFlag],OSErrorCode">
    1174. 

  1174.   <dt><pre><span class="Keyword">proc</span> <a href="#isDisconnectionError%2Cset%5BSocketFlag%5D%2COSErrorCode"><span class="Identifier">isDisconnectionError</span></a><span class="Other">(</span><span class="Identifier">flags</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><a href="net.html#SocketFlag"><span class="Identifier">SocketFlag</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">lastError</span><span class="Other">:</span> <a href="oserrors.html#OSErrorCode"><span class="Identifier">OSErrorCode</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.
    1175. 

  1175.     <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>
    1176. 

  1176.   <dd>
    1177. 

  1177.     
    1178. 

  1178.     Determines whether <tt class="docutils literal"><span class="pre"><span class="Identifier">lastError</span></span></tt> is a disconnection error. Only does this if flags contains <tt class="docutils literal"><span class="pre"><span class="Identifier">SafeDisconn</span></span></tt>.
    1179. 

  1179.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L238" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1180. 

  1180. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L238" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1181. 

  1181. 

  1182.   </dd>
    1183. 

  1183. </div>
    1184. 

  1184. 

  1185. </div>
    1186. 

  1186. <div id="isIpAddress-procs-all">
    1187. 

  1187.   <div id="isIpAddress,string">
    1188. 

  1188.   <dt><pre><span class="Keyword">proc</span> <a href="#isIpAddress%2Cstring"><span class="Identifier">isIpAddress</span></a><span class="Other">(</span><span class="Identifier">addressStr</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</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">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</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">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1189. 

  1189.   <dd>
    1190. 

  1190.     
    1191. 

  1191.     Checks if a string is an IP address Returns true if it is, false otherwise
    1192. 

  1192.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L497" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1193. 

  1193. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L497" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1194. 

  1194. 

  1195.   </dd>
    1196. 

  1196. </div>
    1197. 

  1197. 

  1198. </div>
    1199. 

  1199. <div id="isSsl-procs-all">
    1200. 

  1200.   <div id="isSsl,Socket">
    1201. 

  1201.   <dt><pre><span class="Keyword">proc</span> <a href="#isSsl%2CSocket"><span class="Identifier">isSsl</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1202. 

  1202.   <dd>
    1203. 

  1203.     
    1204. 

  1204.     Determines whether <tt class="docutils literal"><span class="pre"><span class="Identifier">socket</span></span></tt> is a SSL socket.
    1205. 

  1205.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1853" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1206. 

  1206. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1853" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1207. 

  1207. 

  1208.   </dd>
    1209. 

  1209. </div>
    1210. 

  1210. 

  1211. </div>
    1212. 

  1212. <div id="listen-procs-all">
    1213. 

  1213.   <div id="listen,Socket">
    1214. 

  1214.   <dt><pre><span class="Keyword">proc</span> <a href="#listen%2CSocket"><span class="Identifier">listen</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</span></a><span class="Other">;</span> <span class="Identifier">backlog</span> <span class="Other">=</span> <span class="Identifier">SOMAXCONN</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ReadIOEffect"><span class="Identifier">ReadIOEffect</span></a><span class="Other">]</span><span class="Other">,</span>
    1215. 

  1215.     <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">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1216. 

  1216.   <dd>
    1217. 

  1217.     
    1218. 

  1218.     <p>Marks <tt class="docutils literal"><span class="pre"><span class="Identifier">socket</span></span></tt> as accepting connections. <tt class="docutils literal"><span class="pre"><span class="Identifier">Backlog</span></span></tt> specifies the maximum length of the queue of pending connections.</p>
    1219. 

  1219. <p>Raises an OSError error upon failure.</p>
    1220. 

  1220. 

  1221.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1009" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1222. 

  1222. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1009" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1223. 

  1223. 

  1224.   </dd>
    1225. 

  1225. </div>
    1226. 

  1226. 

  1227. </div>
    1228. 

  1228. <div id="newContext-procs-all">
    1229. 

  1229.   <div id="newContext,string,string,string,string">
    1230. 

  1230.   <dt><pre><span class="Keyword">proc</span> <a href="#newContext%2Cstring%2Cstring%2Cstring%2Cstring"><span class="Identifier">newContext</span></a><span class="Other">(</span><span class="Identifier">protVersion</span> <span class="Other">=</span> <span class="Identifier">protSSLv23</span><span class="Other">;</span> <span class="Identifier">verifyMode</span> <span class="Other">=</span> <span class="Identifier">CVerifyPeer</span><span class="Other">;</span>
    1231. 

  1231.                 <span class="Identifier">certFile</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span> <span class="Identifier">keyFile</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span> <span class="Identifier">cipherList</span> <span class="Other">=</span> <span class="Identifier">CiphersIntermediate</span><span class="Other">;</span>
    1232. 

  1232.                 <span class="Identifier">caDir</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span> <span class="Identifier">caFile</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span> <span class="Identifier">ciphersuites</span> <span class="Other">=</span> <span class="Identifier">CiphersModern</span><span class="Other">)</span><span class="Other">:</span> <a href="net.html#SslContext"><span class="Identifier">SslContext</span></a> {.
    1233. 

  1233.     <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">LibraryError</span><span class="Other">,</span> <span class="Identifier">SslError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span>
    1234. 

  1234.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">,</span> <span class="Identifier">ReadDirEffect</span><span class="Other">,</span> <span class="Identifier">ReadEnvEffect</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>
    1235. 

  1235.   <dd>
    1236. 

  1236.     
    1237. 

  1237.     <p>Creates an SSL context.</p>
    1238. 

  1238. <p>Protocol version is currently ignored by default and TLS is used. With <tt class="docutils literal"><span class="pre"><span class="Operator">-</span><span class="Identifier">d</span><span class="Punctuation">:</span><span class="Identifier">openssl10</span></span></tt>, only SSLv23 and TLSv1 may be used.</p>
    1239. 

  1239. <p>There are three options for verify mode: <tt class="docutils literal"><span class="pre"><span class="Identifier">CVerifyNone</span></span></tt>: certificates are not verified; <tt class="docutils literal"><span class="pre"><span class="Identifier">CVerifyPeer</span></span></tt>: certificates are verified; <tt class="docutils literal"><span class="pre"><span class="Identifier">CVerifyPeerUseEnvVars</span></span></tt>: certificates are verified and the optional environment variables SSL_CERT_FILE and SSL_CERT_DIR are also used to locate certificates</p>
    1240. 

  1240. <p>The <tt class="docutils literal"><span class="pre"><span class="Identifier">nimDisableCertificateValidation</span></span></tt> define overrides verifyMode and disables certificate verification globally!</p>
    1241. 

  1241. <p>CA certificates will be loaded, in the following order, from:</p>
    1242. 

  1242. <ul class="simple"><li>caFile, caDir, parameters, if set</li>
    1243. 

  1243. <li>if <tt class="docutils literal"><span class="pre"><span class="Identifier">verifyMode</span></span></tt> is set to <tt class="docutils literal"><span class="pre"><span class="Identifier">CVerifyPeerUseEnvVars</span></span></tt>, the SSL_CERT_FILE and SSL_CERT_DIR environment variables are used</li>
    1244. 

  1244. <li>a set of files and directories from the <a class="reference external" href="ssl_certs.html">ssl_certs</a> file.</li>
    1245. 

  1245. </ul>
    1246. 

  1246. <p>The last two parameters specify the certificate file path and the key file path, a server socket will most likely not work without these.</p>
    1247. 

  1247. <p>Certificates can be generated using the following command:</p>
    1248. 

  1248. <ul class="simple"><li><tt class="docutils literal"><span class="pre"><span class="Identifier">openssl</span> <span class="Identifier">req</span> <span class="Operator">-</span><span class="Identifier">x509</span> <span class="Operator">-</span><span class="Identifier">nodes</span> <span class="Operator">-</span><span class="Identifier">days</span> <span class="DecNumber">365</span> <span class="Operator">-</span><span class="Identifier">newkey</span> <span class="Identifier">rsa</span><span class="Punctuation">:</span><span class="DecNumber">4096</span> <span class="Operator">-</span><span class="Identifier">keyout</span> <span class="Identifier">mykey</span><span class="Operator">.</span><span class="Identifier">pem</span> <span class="Operator">-</span><span class="Keyword">out</span> <span class="Identifier">mycert</span><span class="Operator">.</span><span class="Identifier">pem</span></span></tt></li>
    1249. 

  1249. </ul>
    1250. 

  1250. <p>or using ECDSA:</p>
    1251. 

  1251. <ul class="simple"><li><tt class="docutils literal"><span class="pre"><span class="Identifier">openssl</span> <span class="Identifier">ecparam</span> <span class="Operator">-</span><span class="Keyword">out</span> <span class="Identifier">mykey</span><span class="Operator">.</span><span class="Identifier">pem</span> <span class="Operator">-</span><span class="Identifier">name</span> <span class="Identifier">secp256k1</span> <span class="Operator">-</span><span class="Identifier">genkey</span></span></tt></li>
    1252. 

  1252. <li><tt class="docutils literal"><span class="pre"><span class="Identifier">openssl</span> <span class="Identifier">req</span> <span class="Operator">-</span><span class="Identifier">new</span> <span class="Operator">-</span><span class="Identifier">key</span> <span class="Identifier">mykey</span><span class="Operator">.</span><span class="Identifier">pem</span> <span class="Operator">-</span><span class="Identifier">x509</span> <span class="Operator">-</span><span class="Identifier">nodes</span> <span class="Operator">-</span><span class="Identifier">days</span> <span class="DecNumber">365</span> <span class="Operator">-</span><span class="Keyword">out</span> <span class="Identifier">mycert</span><span class="Operator">.</span><span class="Identifier">pem</span></span></tt></li>
    1253. 

  1253. </ul>
    1254. 

  1254. 

  1255.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L624" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1256. 

  1256. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L624" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1257. 

  1257. 

  1258.   </dd>
    1259. 

  1259. </div>
    1260. 

  1260. 

  1261. </div>
    1262. 

  1262. <div id="newSocket-procs-all">
    1263. 

  1263.   <div id="newSocket,cint,cint,cint">
    1264. 

  1264.   <dt><pre><span class="Keyword">proc</span> <a href="#newSocket%2Ccint%2Ccint%2Ccint"><span class="Identifier">newSocket</span></a><span class="Other">(</span><span class="Identifier">domain</span><span class="Other">,</span> <span class="Identifier">sockType</span><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> <span class="Identifier">buffered</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">;</span>
    1265. 

  1265.                <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><span class="Identifier">Socket</span><span class="Other">)</span> {.
    1266. 

  1266.     <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>
    1267. 

  1267.   <dd>
    1268. 

  1268.     
    1269. 

  1269.     <p>Creates a new socket.</p>
    1270. 

  1270. <p>The SocketHandle associated with the resulting Socket will not be inheritable by child processes by default. This can be changed via the <tt class="docutils literal"><span class="pre"><span class="Identifier">inheritable</span></span></tt> parameter.</p>
    1271. 

  1271. <p>If an error occurs OSError will be raised.</p>
    1272. 

  1272. 

  1273.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L283" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1274. 

  1274. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L283" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1275. 

  1275. 

  1276.   </dd>
    1277. 

  1277. </div>
    1278. 

  1278. <div id="newSocket,Domain,SockType,Protocol">
    1279. 

  1279.   <dt><pre><span class="Keyword">proc</span> <a href="#newSocket%2CDomain%2CSockType%2CProtocol"><span class="Identifier">newSocket</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> <span class="Identifier">AF_INET</span><span class="Other">;</span> <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>
    1280. 

  1280.                <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="Identifier">buffered</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">;</span>
    1281. 

  1281.                <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><span class="Identifier">Socket</span><span class="Other">)</span> {.
    1282. 

  1282.     <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>
    1283. 

  1283.   <dd>
    1284. 

  1284.     
    1285. 

  1285.     <p>Creates a new socket.</p>
    1286. 

  1286. <p>The SocketHandle associated with the resulting Socket will not be inheritable by child processes by default. This can be changed via the <tt class="docutils literal"><span class="pre"><span class="Identifier">inheritable</span></span></tt> parameter.</p>
    1287. 

  1287. <p>If an error occurs OSError will be raised.</p>
    1288. 

  1288. 

  1289.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L298" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1290. 

  1290. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L298" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1291. 

  1291. 

  1292.   </dd>
    1293. 

  1293. </div>
    1294. 

  1294. <div id="newSocket,SocketHandle,Domain,SockType,Protocol">
    1295. 

  1295.   <dt><pre><span class="Keyword">proc</span> <a href="#newSocket%2CSocketHandle%2CDomain%2CSockType%2CProtocol"><span class="Identifier">newSocket</span></a><span class="Other">(</span><span class="Identifier">fd</span><span class="Other">:</span> <a href="winlean.html#SocketHandle"><span class="Identifier">SocketHandle</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> <span class="Identifier">AF_INET</span><span class="Other">;</span>
    1296. 

  1296.                <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>
    1297. 

  1297.                <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="Identifier">buffered</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span><span class="Identifier">Socket</span><span class="Other">)</span> {.
    1298. 

  1298.     <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>
    1299. 

  1299.   <dd>
    1300. 

  1300.     
    1301. 

  1301.     Creates a new socket as specified by the params.
    1302. 

  1302.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L265" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1303. 

  1303. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L265" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1304. 

  1304. 

  1305.   </dd>
    1306. 

  1306. </div>
    1307. 

  1307. 

  1308. </div>
    1309. 

  1309. <div id="parseIpAddress-procs-all">
    1310. 

  1310.   <div id="parseIpAddress,string">
    1311. 

  1311.   <dt><pre><span class="Keyword">proc</span> <a href="#parseIpAddress%2Cstring"><span class="Identifier">parseIpAddress</span></a><span class="Other">(</span><span class="Identifier">addressStr</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="net.html#IpAddress"><span class="Identifier">IpAddress</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">ValueError</span><span class="Other">]</span><span class="Other">,</span>
    1312. 

  1312.     <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>
    1313. 

  1313.   <dd>
    1314. 

  1314.     
    1315. 

  1315.     <p>Parses an IP address</p>
    1316. 

  1316. <p>Raises ValueError on error.</p>
    1317. 

  1317. <p>For IPv4 addresses, only the strict form as defined in RFC 6943 is considered valid, see <a class="reference external" href="https://datatracker.ietf.org/doc/html/rfc6943#section-3.1.1">https://datatracker.ietf.org/doc/html/rfc6943#section-3.1.1</a>.</p>
    1318. 

  1318. 

  1319.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L482" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1320. 

  1320. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L482" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1321. 

  1321. 

  1322.   </dd>
    1323. 

  1323. </div>
    1324. 

  1324. 

  1325. </div>
    1326. 

  1326. <div id="pskIdentityHint=-procs-all">
    1327. 

  1327.   <div id="pskIdentityHint=,SslContext,string">
    1328. 

  1328.   <dt><pre><span class="Keyword">proc</span> <a href="#pskIdentityHint%3D%2CSslContext%2Cstring"><span class="Identifier">pskIdentityHint=</span></a><span class="Other">(</span><span class="Identifier">ctx</span><span class="Other">:</span> <a href="net.html#SslContext"><span class="Identifier">SslContext</span></a><span class="Other">;</span> <span class="Identifier">hint</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</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">SslError</span><span class="Other">]</span><span class="Other">,</span>
    1329. 

  1329.     <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>
    1330. 

  1330.   <dd>
    1331. 

  1331.     
    1332. 

  1332.     <p>Sets the identity hint passed to server.</p>
    1333. 

  1333. <p>Only used in PSK ciphersuites.</p>
    1334. 

  1334. 

  1335.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L749" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1336. 

  1336. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L749" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1337. 

  1337. 

  1338.   </dd>
    1339. 

  1339. </div>
    1340. 

  1340. 

  1341. </div>
    1342. 

  1342. <div id="raiseSSLError-procs-all">
    1343. 

  1343.   <div id="raiseSSLError,string">
    1344. 

  1344.   <dt><pre><span class="Keyword">proc</span> <a href="#raiseSSLError%2Cstring"><span class="Identifier">raiseSSLError</span></a><span class="Other">(</span><span class="Identifier">s</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</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><a href="net.html#SslError"><span class="Identifier">SslError</span></a><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>
    1345. 

  1345.   <dd>
    1346. 

  1346.     
    1347. 

  1347.     Raises a new SSL error.
    1348. 

  1348.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L564" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1349. 

  1349. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L564" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1350. 

  1350. 

  1351.   </dd>
    1352. 

  1352. </div>
    1353. 

  1353. 

  1354. </div>
    1355. 

  1355. <div id="readLine-procs-all">
    1356. 

  1356.   <div id="readLine,Socket,string,int">
    1357. 

  1357.   <dt><pre><span class="Keyword">proc</span> <a href="#readLine%2CSocket%2Cstring%2Cint"><span class="Identifier">readLine</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</span></a><span class="Other">;</span> <span class="Identifier">line</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">timeout</span> <span class="Other">=</span> <span class="DecNumber">-1</span><span class="Other">;</span>
    1358. 

  1358.               <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="Identifier">maxLength</span> <span class="Other">=</span> <span class="Identifier">MaxLineLength</span><span class="Other">)</span> {.
    1359. 

  1359.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ReadIOEffect"><span class="Identifier">ReadIOEffect</span></a><span class="Other">,</span> <a href="exceptions.html#TimeEffect"><span class="Identifier">TimeEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">TimeoutError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">SslError</span><span class="Other">]</span><span class="Other">,</span>
    1360. 

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

  1361.   <dd>
    1362. 

  1362.     
    1363. 

  1363.     <p>Reads a line of data from <tt class="docutils literal"><span class="pre"><span class="Identifier">socket</span></span></tt>.</p>
    1364. 

  1364. <p>If a full line is read <tt class="docutils literal"><span class="pre"><span class="Operator">\</span><span class="Identifier">r</span><span class="Operator">\</span><span class="Identifier">L</span></span></tt> is not added to <tt class="docutils literal"><span class="pre"><span class="Identifier">line</span></span></tt>, however if solely <tt class="docutils literal"><span class="pre"><span class="Operator">\</span><span class="Identifier">r</span><span class="Operator">\</span><span class="Identifier">L</span></span></tt> is read then <tt class="docutils literal"><span class="pre"><span class="Identifier">line</span></span></tt> will be set to it.</p>
    1365. 

  1365. <p>If the socket is disconnected, <tt class="docutils literal"><span class="pre"><span class="Identifier">line</span></span></tt> will be set to <tt class="docutils literal"><span class="pre"><span class="StringLit">&quot;&quot;</span></span></tt>.</p>
    1366. 

  1366. <p>An OSError exception will be raised in the case of a socket error.</p>
    1367. 

  1367. <p>A timeout can be specified in milliseconds, if data is not received within the specified time a TimeoutError exception will be raised.</p>
    1368. 

  1368. <p>The <tt class="docutils literal"><span class="pre"><span class="Identifier">maxLength</span></span></tt> parameter determines the maximum amount of characters that can be read. The result is truncated after that.</p>
    1369. 

  1369. <div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
    1370. 

  1370. Only the <tt class="docutils literal"><span class="pre"><span class="Identifier">SafeDisconn</span></span></tt> flag is currently supported.</div>
    1371. 

  1371. 

  1372.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1577" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1373. 

  1373. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1577" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1374. 

  1374. 

  1375.   </dd>
    1376. 

  1376. </div>
    1377. 

  1377. 

  1378. </div>
    1379. 

  1379. <div id="recv-procs-all">
    1380. 

  1380.   <div id="recv,Socket,pointer,int">
    1381. 

  1381.   <dt><pre><span class="Keyword">proc</span> <a href="#recv%2CSocket%2Cpointer%2Cint"><span class="Identifier">recv</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</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="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">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ReadIOEffect"><span class="Identifier">ReadIOEffect</span></a><span class="Other">]</span><span class="Other">,</span>
    1382. 

  1382.     <span class="Identifier">raises</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>
    1383. 

  1383.   <dd>
    1384. 

  1384.     
    1385. 

  1385.     <p>Receives data from a socket.</p>
    1386. 

  1386. <p><strong>Note</strong>: This is a low-level function, you may be interested in the higher level versions of this function which are also named <tt class="docutils literal"><span class="pre"><span class="Identifier">recv</span></span></tt>.</p>
    1387. 

  1387. 

  1388.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1397" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1389. 

  1389. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1397" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1390. 

  1390. 

  1391.   </dd>
    1392. 

  1392. </div>
    1393. 

  1393. <div id="recv,Socket,pointer,int,int">
    1394. 

  1394.   <dt><pre><span class="Keyword">proc</span> <a href="#recv%2CSocket%2Cpointer%2Cint%2Cint"><span class="Identifier">recv</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</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">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> <a href="system.html#int"><span class="Identifier">int</span></a> {.
    1395. 

  1395.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ReadIOEffect"><span class="Identifier">ReadIOEffect</span></a><span class="Other">,</span> <a href="exceptions.html#TimeEffect"><span class="Identifier">TimeEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">TimeoutError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    1396. 

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

  1397.   <dd>
    1398. 

  1398.     
    1399. 

  1399.     overload with a <tt class="docutils literal"><span class="pre"><span class="Identifier">timeout</span></span></tt> parameter in milliseconds.
    1400. 

  1400.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1479" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1401. 

  1401. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1479" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1402. 

  1402. 

  1403.   </dd>
    1404. 

  1404. </div>
    1405. 

  1405. <div id="recv,Socket,string,int,int">
    1406. 

  1406.   <dt><pre><span class="Keyword">proc</span> <a href="#recv%2CSocket%2Cstring%2Cint%2Cint"><span class="Identifier">recv</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</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">timeout</span> <span class="Other">=</span> <span class="DecNumber">-1</span><span class="Other">;</span>
    1407. 

  1407.           <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> <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> <span class="Other">[</span><span class="Identifier">TimeoutError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">SslError</span><span class="Other">]</span><span class="Other">,</span>
    1408. 

  1408.                                         <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">]</span><span class="Other">,</span>
    1409. 

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

  1410.   <dd>
    1411. 

  1411.     
    1412. 

  1412.     <p>Higher-level version of <tt class="docutils literal"><span class="pre"><span class="Identifier">recv</span></span></tt>.</p>
    1413. 

  1413. <p>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">data</span></span></tt>.</p>
    1414. 

  1414. <p>For buffered sockets this function will attempt to read all the requested data. It will read this data in <tt class="docutils literal"><span class="pre"><span class="Identifier">BufferSize</span></span></tt> chunks.</p>
    1415. 

  1415. <p>For unbuffered sockets this function makes no effort to read all the data requested. It will return as much data as the operating system gives it.</p>
    1416. 

  1416. <p>When 0 is returned the socket's connection has been closed.</p>
    1417. 

  1417. <p>This function will throw an OSError exception when an error occurs. A value lower than 0 is never returned.</p>
    1418. 

  1418. <p>A timeout may be specified in milliseconds, if enough data is not received within the time specified a TimeoutError exception will be raised.</p>
    1419. 

  1419. <div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
    1420. 

  1420. Only the <tt class="docutils literal"><span class="pre"><span class="Identifier">SafeDisconn</span></span></tt> flag is currently supported.</div>
    1421. 

  1421. 

  1422.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1497" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1423. 

  1423. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1497" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1424. 

  1424. 

  1425.   </dd>
    1426. 

  1426. </div>
    1427. 

  1427. <div id="recv,Socket,int,int">
    1428. 

  1428.   <dt><pre><span class="Keyword">proc</span> <a href="#recv%2CSocket%2Cint%2Cint"><span class="Identifier">recv</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</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">timeout</span> <span class="Other">=</span> <span class="DecNumber">-1</span><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> <a href="system.html#string"><span class="Identifier">string</span></a> {.
    1429. 

  1429.     <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="Identifier">TimeoutError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">SslError</span><span class="Other">]</span><span class="Other">,</span>
    1430. 

  1430.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</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>
    1431. 

  1431.   <dd>
    1432. 

  1432.     
    1433. 

  1433.     <p>Higher-level version of <tt class="docutils literal"><span class="pre"><span class="Identifier">recv</span></span></tt> which returns a string.</p>
    1434. 

  1434. <p>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 the result.</p>
    1435. 

  1435. <p>For buffered sockets this function will attempt to read all the requested data. It will read this data in <tt class="docutils literal"><span class="pre"><span class="Identifier">BufferSize</span></span></tt> chunks.</p>
    1436. 

  1436. <p>For unbuffered sockets this function makes no effort to read all the data requested. It will return as much data as the operating system gives it.</p>
    1437. 

  1437. <p>When <tt class="docutils literal"><span class="pre"><span class="StringLit">&quot;&quot;</span></span></tt> is returned the socket's connection has been closed.</p>
    1438. 

  1438. <p>This function will throw an OSError exception when an error occurs.</p>
    1439. 

  1439. <p>A timeout may be specified in milliseconds, if enough data is not received within the time specified a TimeoutError exception will be raised.</p>
    1440. 

  1440. <div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
    1441. 

  1441. Only the <tt class="docutils literal"><span class="pre"><span class="Identifier">SafeDisconn</span></span></tt> flag is currently supported.</div>
    1442. 

  1442. 

  1443.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1532" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1444. 

  1444. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1532" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1445. 

  1445. 

  1446.   </dd>
    1447. 

  1447. </div>
    1448. 

  1448. 

  1449. </div>
    1450. 

  1450. <div id="recvFrom-procs-all">
    1451. 

  1451.   <div id="recvFrom,Socket,string,int,T,Port,int32">
    1452. 

  1452.   <dt><pre><span class="Keyword">proc</span> <a href="#recvFrom%2CSocket%2Cstring%2Cint%2CT%2CPort%2Cint32"><span class="Identifier">recvFrom</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Operator">|</span> <a href="net.html#IpAddress"><span class="Identifier">IpAddress</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span>
    1453. 

  1453.                                      <span class="Identifier">length</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">address</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">;</span>
    1454. 

  1454.                                      <span class="Identifier">port</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="nativesockets.html#Port"><span class="Identifier">Port</span></a><span class="Other">;</span> <span class="Identifier">flags</span> <span class="Other">=</span> <span class="DecNumber">0'i32</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.
    1455. 

  1455.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ReadIOEffect"><span class="Identifier">ReadIOEffect</span></a><span class="Other">]</span></span>.}</pre></dt>
    1456. 

  1456.   <dd>
    1457. 

  1457.     
    1458. 

  1458.     <p>Receives data from <tt class="docutils literal"><span class="pre"><span class="Identifier">socket</span></span></tt>. This function should normally be used with connection-less sockets (UDP sockets). The source address of the data packet is stored in the <tt class="docutils literal"><span class="pre"><span class="Identifier">address</span></span></tt> argument as either a string or an IpAddress.</p>
    1459. 

  1459. <p>If an error occurs an OSError exception will be raised. Otherwise the return value will be the length of data received.</p>
    1460. 

  1460. <div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
    1461. 

  1461. This function does not yet have a buffered implementation, so when <tt class="docutils literal"><span class="pre"><span class="Identifier">socket</span></span></tt> is buffered the non-buffered implementation will be used. Therefore if <tt class="docutils literal"><span class="pre"><span class="Identifier">socket</span></span></tt> contains something in its buffer this function will make no effort to return it.</div>
    1462. 

  1462. 

  1463.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1657" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1464. 

  1464. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1657" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1465. 

  1465. 

  1466.   </dd>
    1467. 

  1467. </div>
    1468. 

  1468. 

  1469. </div>
    1470. 

  1470. <div id="recvLine-procs-all">
    1471. 

  1471.   <div id="recvLine,Socket,int">
    1472. 

  1472.   <dt><pre><span class="Keyword">proc</span> <a href="#recvLine%2CSocket%2Cint"><span class="Identifier">recvLine</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</span></a><span class="Other">;</span> <span class="Identifier">timeout</span> <span class="Other">=</span> <span class="DecNumber">-1</span><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>
    1473. 

  1473.               <span class="Identifier">maxLength</span> <span class="Other">=</span> <span class="Identifier">MaxLineLength</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.
    1474. 

  1474.     <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">TimeoutError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">SslError</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">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">]</span><span class="Other">,</span>
    1475. 

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

  1476.   <dd>
    1477. 

  1477.     
    1478. 

  1478.     <p>Reads a line of data from <tt class="docutils literal"><span class="pre"><span class="Identifier">socket</span></span></tt>.</p>
    1479. 

  1479. <p>If a full line is read <tt class="docutils literal"><span class="pre"><span class="Operator">\</span><span class="Identifier">r</span><span class="Operator">\</span><span class="Identifier">L</span></span></tt> is not added to the result, however if solely <tt class="docutils literal"><span class="pre"><span class="Operator">\</span><span class="Identifier">r</span><span class="Operator">\</span><span class="Identifier">L</span></span></tt> is read then the result will be set to it.</p>
    1480. 

  1480. <p>If the socket is disconnected, the result will be set to <tt class="docutils literal"><span class="pre"><span class="StringLit">&quot;&quot;</span></span></tt>.</p>
    1481. 

  1481. <p>An OSError exception will be raised in the case of a socket error.</p>
    1482. 

  1482. <p>A timeout can be specified in milliseconds, if data is not received within the specified time a TimeoutError exception will be raised.</p>
    1483. 

  1483. <p>The <tt class="docutils literal"><span class="pre"><span class="Identifier">maxLength</span></span></tt> parameter determines the maximum amount of characters that can be read. The result is truncated after that.</p>
    1484. 

  1484. <div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
    1485. 

  1485. Only the <tt class="docutils literal"><span class="pre"><span class="Identifier">SafeDisconn</span></span></tt> flag is currently supported.</div>
    1486. 

  1486. 

  1487.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1634" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1488. 

  1488. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1634" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1489. 

  1489. 

  1490.   </dd>
    1491. 

  1491. </div>
    1492. 

  1492. 

  1493. </div>
    1494. 

  1494. <div id="send-procs-all">
    1495. 

  1495.   <div id="send,Socket,pointer,int">
    1496. 

  1496.   <dt><pre><span class="Keyword">proc</span> <a href="#send%2CSocket%2Cpointer%2Cint"><span class="Identifier">send</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</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="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.
    1497. 

  1497.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#WriteIOEffect"><span class="Identifier">WriteIOEffect</span></a><span class="Other">]</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">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1498. 

  1498.   <dd>
    1499. 

  1499.     
    1500. 

  1500.     <p>Sends data to a socket.</p>
    1501. 

  1501. <p><strong>Note</strong>: This is a low-level version of <tt class="docutils literal"><span class="pre"><span class="Identifier">send</span></span></tt>. You likely should use the version below.</p>
    1502. 

  1502. 

  1503.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1720" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1504. 

  1504. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1720" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1505. 

  1505. 

  1506.   </dd>
    1507. 

  1507. </div>
    1508. 

  1508. <div id="send,Socket,string,int">
    1509. 

  1509.   <dt><pre><span class="Keyword">proc</span> <a href="#send%2CSocket%2Cstring%2Cint"><span class="Identifier">send</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</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="Identifier">maxRetries</span> <span class="Other">=</span> <span class="DecNumber">100</span><span class="Other">)</span> {.
    1510. 

  1510.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#WriteIOEffect"><span class="Identifier">WriteIOEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">SslError</span><span class="Other">,</span> <span class="Identifier">OSError</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>
    1511. 

  1511.   <dd>
    1512. 

  1512.     
    1513. 

  1513.     Sends data to a socket. Will try to send all the data by handling interrupts and incomplete writes up to <tt class="docutils literal"><span class="pre"><span class="Identifier">maxRetries</span></span></tt>.
    1514. 

  1514.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1739" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1515. 

  1515. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1739" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1516. 

  1516. 

  1517.   </dd>
    1518. 

  1518. </div>
    1519. 

  1519. 

  1520. </div>
    1521. 

  1521. <div id="sendTo-procs-all">
    1522. 

  1522.   <div id="sendTo,Socket,IpAddress,Port,string,int32">
    1523. 

  1523.   <dt><pre><span class="Keyword">proc</span> <a href="#sendTo%2CSocket%2CIpAddress%2CPort%2Cstring%2Cint32"><span class="Identifier">sendTo</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</span></a><span class="Other">;</span> <span class="Identifier">address</span><span class="Other">:</span> <a href="net.html#IpAddress"><span class="Identifier">IpAddress</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">data</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span>
    1524. 

  1524.             <span class="Identifier">flags</span> <span class="Other">=</span> <span class="DecNumber">0'i32</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">discardable</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#WriteIOEffect"><span class="Identifier">WriteIOEffect</span></a><span class="Other">]</span><span class="Other">,</span>
    1525. 

  1525.                                   <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">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1526. 

  1526.   <dd>
    1527. 

  1527.     
    1528. 

  1528.     <p>This proc sends <tt class="docutils literal"><span class="pre"><span class="Identifier">data</span></span></tt> to the specified <tt class="docutils literal"><span class="pre"><span class="Identifier">IpAddress</span></span></tt> and returns the number of bytes written.</p>
    1529. 

  1529. <p>Generally for use with connection-less (UDP) sockets.</p>
    1530. 

  1530. <p>If an error occurs an OSError exception will be raised.</p>
    1531. 

  1531. <p>This is the high-level version of the above <tt class="docutils literal"><span class="pre"><span class="Identifier">sendTo</span></span></tt> function.</p>
    1532. 

  1532. 

  1533.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1828" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1534. 

  1534. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1828" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1535. 

  1535. 

  1536.   </dd>
    1537. 

  1537. </div>
    1538. 

  1538. <div id="sendTo,Socket,string,Port,pointer,int,Domain,int32">
    1539. 

  1539.   <dt><pre><span class="Keyword">proc</span> <a href="#sendTo%2CSocket%2Cstring%2CPort%2Cpointer%2Cint%2CDomain%2Cint32"><span class="Identifier">sendTo</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</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">data</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">;</span>
    1540. 

  1540.             <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">af</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="Identifier">flags</span> <span class="Other">=</span> <span class="DecNumber">0'i32</span><span class="Other">)</span> {.
    1541. 

  1541.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#WriteIOEffect"><span class="Identifier">WriteIOEffect</span></a><span class="Other">]</span><span class="Other">,</span> <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">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1542. 

  1542.   <dd>
    1543. 

  1543.     
    1544. 

  1544.     <p>This proc sends <tt class="docutils literal"><span class="pre"><span class="Identifier">data</span></span></tt> to the specified <tt class="docutils literal"><span class="pre"><span class="Identifier">address</span></span></tt>, which may be an IP address or a hostname, if a hostname is specified this function will try each IP of that hostname. This function should normally be used with connection-less sockets (UDP sockets).</p>
    1545. 

  1545. <p>If an error occurs an OSError exception will be raised.</p>
    1546. 

  1546. <p><strong>Note:</strong> You may wish to use the high-level version of this function which is defined below.</p>
    1547. 

  1547. <p><strong>Note:</strong> This proc is not available for SSL sockets.</p>
    1548. 

  1548. 

  1549.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1780" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1550. 

  1550. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1780" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1551. 

  1551. 

  1552.   </dd>
    1553. 

  1553. </div>
    1554. 

  1554. <div id="sendTo,Socket,string,Port,string">
    1555. 

  1555.   <dt><pre><span class="Keyword">proc</span> <a href="#sendTo%2CSocket%2Cstring%2CPort%2Cstring"><span class="Identifier">sendTo</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</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">data</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.
    1556. 

  1556.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#WriteIOEffect"><span class="Identifier">WriteIOEffect</span></a><span class="Other">]</span><span class="Other">,</span> <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">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1557. 

  1557.   <dd>
    1558. 

  1558.     
    1559. 

  1559.     <p>This proc sends <tt class="docutils literal"><span class="pre"><span class="Identifier">data</span></span></tt> to the specified <tt class="docutils literal"><span class="pre"><span class="Identifier">address</span></span></tt>, which may be an IP address or a hostname, if a hostname is specified this function will try each IP of that hostname.</p>
    1560. 

  1560. <p>Generally for use with connection-less (UDP) sockets.</p>
    1561. 

  1561. <p>If an error occurs an OSError exception will be raised.</p>
    1562. 

  1562. <p>This is the high-level version of the above <tt class="docutils literal"><span class="pre"><span class="Identifier">sendTo</span></span></tt> function.</p>
    1563. 

  1563. 

  1564.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1815" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1565. 

  1565. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1815" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1566. 

  1566. 

  1567.   </dd>
    1568. 

  1568. </div>
    1569. 

  1569. 

  1570. </div>
    1571. 

  1571. <div id="serverGetPskFunc-procs-all">
    1572. 

  1572.   <div id="serverGetPskFunc,SslContext">
    1573. 

  1573.   <dt><pre><span class="Keyword">proc</span> <a href="#serverGetPskFunc%2CSslContext"><span class="Identifier">serverGetPskFunc</span></a><span class="Other">(</span><span class="Identifier">ctx</span><span class="Other">:</span> <a href="net.html#SslContext"><span class="Identifier">SslContext</span></a><span class="Other">)</span><span class="Other">:</span> <a href="net.html#SslServerGetPskFunc"><span class="Identifier">SslServerGetPskFunc</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>
    1574. 

  1574.     <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>
    1575. 

  1575.   <dd>
    1576. 

  1576.     
    1577. 

  1577.     
    1578. 

  1578.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L783" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1579. 

  1579. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L783" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1580. 

  1580. 

  1581.   </dd>
    1582. 

  1582. </div>
    1583. 

  1583. 

  1584. </div>
    1585. 

  1585. <div id="serverGetPskFunc=-procs-all">
    1586. 

  1586.   <div id="serverGetPskFunc=,SslContext,SslServerGetPskFunc">
    1587. 

  1587.   <dt><pre><span class="Keyword">proc</span> <a href="#serverGetPskFunc%3D%2CSslContext%2CSslServerGetPskFunc"><span class="Identifier">serverGetPskFunc=</span></a><span class="Other">(</span><span class="Identifier">ctx</span><span class="Other">:</span> <a href="net.html#SslContext"><span class="Identifier">SslContext</span></a><span class="Other">;</span> <span class="Identifier">fun</span><span class="Other">:</span> <a href="net.html#SslServerGetPskFunc"><span class="Identifier">SslServerGetPskFunc</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>
    1588. 

  1588.     <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>
    1589. 

  1589.   <dd>
    1590. 

  1590.     
    1591. 

  1591.     <p>Sets function that returns PSK based on the client identity.</p>
    1592. 

  1592. <p>Only used in PSK ciphersuites.</p>
    1593. 

  1593. 

  1594.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L796" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1595. 

  1595. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L796" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1596. 

  1596. 

  1597.   </dd>
    1598. 

  1598. </div>
    1599. 

  1599. 

  1600. </div>
    1601. 

  1601. <div id="sessionIdContext=-procs-all">
    1602. 

  1602.   <div id="sessionIdContext=,SslContext,string">
    1603. 

  1603.   <dt><pre><span class="Keyword">proc</span> <a href="#sessionIdContext%3D%2CSslContext%2Cstring"><span class="Identifier">sessionIdContext=</span></a><span class="Other">(</span><span class="Identifier">ctx</span><span class="Other">:</span> <a href="net.html#SslContext"><span class="Identifier">SslContext</span></a><span class="Other">;</span> <span class="Identifier">sidCtx</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</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">SslError</span><span class="Other">]</span><span class="Other">,</span>
    1604. 

  1604.     <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>
    1605. 

  1605.   <dd>
    1606. 

  1606.     
    1607. 

  1607.     <p>Sets the session id context in which a session can be reused. Used for permitting clients to reuse a session id instead of doing a new handshake.</p>
    1608. 

  1608. <p>TLS clients might attempt to resume a session using the session id context, thus it must be set if verifyMode is set to CVerifyPeer or CVerifyPeerUseEnvVars, otherwise the connection will fail and SslError will be raised if resumption occurs.</p>
    1609. 

  1609. <ul class="simple"><li>Only useful if set server-side.</li>
    1610. 

  1610. <li>Should be unique per-application to prevent clients from malfunctioning.</li>
    1611. 

  1611. <li>sidCtx must be at most 32 characters in length.</li>
    1612. 

  1612. </ul>
    1613. 

  1613. 

  1614.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L919" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1615. 

  1615. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L919" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1616. 

  1616. 

  1617.   </dd>
    1618. 

  1618. </div>
    1619. 

  1619. 

  1620. </div>
    1621. 

  1621. <div id="setExtraData-procs-all">
    1622. 

  1622.   <div id="setExtraData,SslContext,int,RootRef">
    1623. 

  1623.   <dt><pre><span class="Keyword">proc</span> <a href="#setExtraData%2CSslContext%2Cint%2CRootRef"><span class="Identifier">setExtraData</span></a><span class="Other">(</span><span class="Identifier">ctx</span><span class="Other">:</span> <a href="net.html#SslContext"><span class="Identifier">SslContext</span></a><span class="Other">;</span> <span class="Identifier">index</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <a href="system.html#RootRef"><span class="Identifier">RootRef</span></a><span class="Other">)</span> {.
    1624. 

  1624.     <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">SslError</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>
    1625. 

  1625.   <dd>
    1626. 

  1626.     
    1627. 

  1627.     Stores arbitrary data inside SslContext. The unique <tt class="docutils literal"><span class="pre"><span class="Identifier">index</span></span></tt> should be retrieved using getSslContextExtraDataIndex.
    1628. 

  1628.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L589" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1629. 

  1629. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L589" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1630. 

  1630. 

  1631.   </dd>
    1632. 

  1632. </div>
    1633. 

  1633. 

  1634. </div>
    1635. 

  1635. <div id="setSockOpt-procs-all">
    1636. 

  1636.   <div id="setSockOpt,Socket,SOBool,bool">
    1637. 

  1637.   <dt><pre><span class="Keyword">proc</span> <a href="#setSockOpt%2CSocket%2CSOBool%2Cbool"><span class="Identifier">setSockOpt</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</span></a><span class="Other">;</span> <span class="Identifier">opt</span><span class="Other">:</span> <a href="net.html#SOBool"><span class="Identifier">SOBool</span></a><span class="Other">;</span> <span class="Identifier">value</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">;</span> <span class="Identifier">level</span> <span class="Other">=</span> <span class="Identifier">SOL_SOCKET</span><span class="Other">)</span> {.
    1638. 

  1638.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#WriteIOEffect"><span class="Identifier">WriteIOEffect</span></a><span class="Other">]</span><span class="Other">,</span> <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">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1639. 

  1639.   <dd>
    1640. 

  1640.     
    1641. 

  1641.     Sets option <tt class="docutils literal"><span class="pre"><span class="Identifier">opt</span></span></tt> to a boolean value specified by <tt class="docutils literal"><span class="pre"><span class="Identifier">value</span></span></tt>.
    1642. 

  1642. <p><strong class="examples_text">Example: cmd: -r:off</strong></p>
    1643. 

  1643. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">socket</span> <span class="Operator">=</span> <span class="Identifier">newSocket</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1644. 

  1644. <span class="Identifier">socket</span><span class="Operator">.</span><span class="Identifier">setSockOpt</span><span class="Punctuation">(</span><span class="Identifier">OptReusePort</span><span class="Punctuation">,</span> <span class="Identifier">true</span><span class="Punctuation">)</span>
    1645. 

  1645. <span class="Identifier">socket</span><span class="Operator">.</span><span class="Identifier">setSockOpt</span><span class="Punctuation">(</span><span class="Identifier">OptNoDelay</span><span class="Punctuation">,</span> <span class="Identifier">true</span><span class="Punctuation">,</span> <span class="Identifier">level</span> <span class="Operator">=</span> <span class="Identifier">IPPROTO_TCP</span><span class="Operator">.</span><span class="Identifier">cint</span><span class="Punctuation">)</span></pre>
    1646. 

  1646.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1308" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1647. 

  1647. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1308" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1648. 

  1648. 

  1649.   </dd>
    1650. 

  1650. </div>
    1651. 

  1651. 

  1652. </div>
    1653. 

  1653. <div id="skip-procs-all">
    1654. 

  1654.   <div id="skip,Socket,int,int">
    1655. 

  1655.   <dt><pre><span class="Keyword">proc</span> <a href="#skip%2CSocket%2Cint%2Cint"><span class="Identifier">skip</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</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">timeout</span> <span class="Other">=</span> <span class="DecNumber">-1</span><span class="Other">)</span> {.
    1656. 

  1656.     <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">TimeoutError</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="Identifier">TimeEffect</span><span class="Other">,</span> <span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span>
    1657. 

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

  1658.   <dd>
    1659. 

  1659.     
    1660. 

  1660.     <p>Skips <tt class="docutils literal"><span class="pre"><span class="Identifier">size</span></span></tt> amount of bytes.</p>
    1661. 

  1661. <p>An optional timeout can be specified in milliseconds, if skipping the bytes takes longer than specified a TimeoutError exception will be raised.</p>
    1662. 

  1662. <p>Returns the number of skipped bytes.</p>
    1663. 

  1663. 

  1664.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1705" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1665. 

  1665. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1705" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1666. 

  1666. 

  1667.   </dd>
    1668. 

  1668. </div>
    1669. 

  1669. 

  1670. </div>
    1671. 

  1671. <div id="socketError-procs-all">
    1672. 

  1672.   <div id="socketError,Socket,int,set[SocketFlag]">
    1673. 

  1673.   <dt><pre><span class="Keyword">proc</span> <a href="#socketError%2CSocket%2Cint%2Cset%5BSocketFlag%5D"><span class="Identifier">socketError</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</span></a><span class="Other">;</span> <span class="Identifier">err</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Other">=</span> <span class="DecNumber">-1</span><span class="Other">;</span> <span class="Identifier">async</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">;</span>
    1674. 

  1674.                  <span class="Identifier">lastError</span> <span class="Other">=</span> <span class="DecNumber">-1</span><span class="Other">.</span><span class="Identifier">OSErrorCode</span><span class="Other">;</span> <span class="Identifier">flags</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><a href="net.html#SocketFlag"><span class="Identifier">SocketFlag</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Other">{</span><span class="Other">}</span><span class="Other">)</span> {.
    1675. 

  1675.     <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="Identifier">SslError</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>
    1676. 

  1676.   <dd>
    1677. 

  1677.     
    1678. 

  1678.     
    1679. 

  1679.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L234" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1680. 

  1680. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L234" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1681. 

  1681. 

  1682.   </dd>
    1683. 

  1683. </div>
    1684. 

  1684. 

  1685. </div>
    1686. 

  1686. <div id="sslHandle-procs-all">
    1687. 

  1687.   <div id="sslHandle,Socket">
    1688. 

  1688.   <dt><pre><span class="Keyword">proc</span> <a href="#sslHandle%2CSocket"><span class="Identifier">sslHandle</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</span></a><span class="Other">)</span><span class="Other">:</span> <a href="openssl.html#SslPtr"><span class="Identifier">SslPtr</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>
    1689. 

  1689.   <dd>
    1690. 

  1690.     
    1691. 

  1691.     Retrieve the ssl pointer of <tt class="docutils literal"><span class="pre"><span class="Identifier">socket</span></span></tt>. Useful for interfacing with <tt class="docutils literal"><span class="pre"><span class="Identifier">openssl</span></span></tt>.
    1692. 

  1692.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L559" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1693. 

  1693. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L559" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1694. 

  1694. 

  1695.   </dd>
    1696. 

  1696. </div>
    1697. 

  1697. 

  1698. </div>
    1699. 

  1699. <div id="toCInt-procs-all">
    1700. 

  1700.   <div id="toCInt,SOBool">
    1701. 

  1701.   <dt><pre><span class="Keyword">proc</span> <a href="#toCInt%2CSOBool"><span class="Identifier">toCInt</span></a><span class="Other">(</span><span class="Identifier">opt</span><span class="Other">:</span> <a href="net.html#SOBool"><span class="Identifier">SOBool</span></a><span class="Other">)</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</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>
    1702. 

  1702.   <dd>
    1703. 

  1703.     
    1704. 

  1704.     Converts a <tt class="docutils literal"><span class="pre"><span class="Identifier">SOBool</span></span></tt> into its Socket Option cint representation.
    1705. 

  1705.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1276" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1706. 

  1706. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1276" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1707. 

  1707. 

  1708.   </dd>
    1709. 

  1709. </div>
    1710. 

  1710. 

  1711. </div>
    1712. 

  1712. <div id="toOSFlags-procs-all">
    1713. 

  1713.   <div id="toOSFlags,set[SocketFlag]">
    1714. 

  1714.   <dt><pre><span class="Keyword">proc</span> <a href="#toOSFlags%2Cset%5BSocketFlag%5D"><span class="Identifier">toOSFlags</span></a><span class="Other">(</span><span class="Identifier">socketFlags</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><a href="net.html#SocketFlag"><span class="Identifier">SocketFlag</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</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>
    1715. 

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

  1716.   <dd>
    1717. 

  1717.     
    1718. 

  1718.     Converts the flags into the underlying OS representation.
    1719. 

  1719.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L256" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1720. 

  1720. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L256" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1721. 

  1721. 

  1722.   </dd>
    1723. 

  1723. </div>
    1724. 

  1724. 

  1725. </div>
    1726. 

  1726. <div id="toSockAddr-procs-all">
    1727. 

  1727.   <div id="toSockAddr,IpAddress,Port,Sockaddr_storage,SockLen">
    1728. 

  1728.   <dt><pre><span class="Keyword">proc</span> <a href="#toSockAddr%2CIpAddress%2CPort%2CSockaddr_storage%2CSockLen"><span class="Identifier">toSockAddr</span></a><span class="Other">(</span><span class="Identifier">address</span><span class="Other">:</span> <a href="net.html#IpAddress"><span class="Identifier">IpAddress</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">sa</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="winlean.html#Sockaddr_storage"><span class="Identifier">Sockaddr_storage</span></a><span class="Other">;</span>
    1729. 

  1729.                 <span class="Identifier">sl</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="winlean.html#SockLen"><span class="Identifier">SockLen</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>
    1730. 

  1730.   <dd>
    1731. 

  1731.     
    1732. 

  1732.     Converts <tt class="docutils literal"><span class="pre"><span class="Identifier">IpAddress</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">Port</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">SockAddr</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">SockLen</span></span></tt>
    1733. 

  1733.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L506" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1734. 

  1734. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L506" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1735. 

  1735. 

  1736.   </dd>
    1737. 

  1737. </div>
    1738. 

  1738. 

  1739. </div>
    1740. 

  1740. <div id="trySend-procs-all">
    1741. 

  1741.   <div id="trySend,Socket,string">
    1742. 

  1742.   <dt><pre><span class="Keyword">proc</span> <a href="#trySend%2CSocket%2Cstring"><span class="Identifier">trySend</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</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="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">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#WriteIOEffect"><span class="Identifier">WriteIOEffect</span></a><span class="Other">]</span><span class="Other">,</span>
    1743. 

  1743.     <span class="Identifier">raises</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>
    1744. 

  1744.   <dd>
    1745. 

  1745.     
    1746. 

  1746.     Safe alternative to <tt class="docutils literal"><span class="pre"><span class="Identifier">send</span></span></tt>. Does not raise an OSError when an error occurs, and instead returns <tt class="docutils literal"><span class="pre"><span class="Identifier">false</span></span></tt> on failure.
    1747. 

  1747.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1775" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1748. 

  1748. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1775" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1749. 

  1749. 

  1750.   </dd>
    1751. 

  1751. </div>
    1752. 

  1752. 

  1753. </div>
    1754. 

  1754. <div id="wrapConnectedSocket-procs-all">
    1755. 

  1755.   <div id="wrapConnectedSocket,SslContext,Socket,SslHandshakeType,string">
    1756. 

  1756.   <dt><pre><span class="Keyword">proc</span> <a href="#wrapConnectedSocket%2CSslContext%2CSocket%2CSslHandshakeType%2Cstring"><span class="Identifier">wrapConnectedSocket</span></a><span class="Other">(</span><span class="Identifier">ctx</span><span class="Other">:</span> <a href="net.html#SslContext"><span class="Identifier">SslContext</span></a><span class="Other">;</span> <span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</span></a><span class="Other">;</span>
    1757. 

  1757.                          <span class="Identifier">handshake</span><span class="Other">:</span> <a href="net.html#SslHandshakeType"><span class="Identifier">SslHandshakeType</span></a><span class="Other">;</span> <span class="Identifier">hostname</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">)</span> {.
    1758. 

  1758.     <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">SslError</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>
    1759. 

  1759.   <dd>
    1760. 

  1760.     
    1761. 

  1761.     <p>Wraps a connected socket in an SSL context. This function effectively turns <tt class="docutils literal"><span class="pre"><span class="Identifier">socket</span></span></tt> into an SSL socket. <tt class="docutils literal"><span class="pre"><span class="Identifier">hostname</span></span></tt> should be specified so that the client knows which hostname the server certificate should be validated against.</p>
    1762. 

  1762. <p>This should be called on a connected socket, and will perform an SSL handshake immediately.</p>
    1763. 

  1763. <p>FIXME: <strong>Disclaimer</strong>: This code is not well tested, may be very unsafe and prone to security vulnerabilities.</p>
    1764. 

  1764. 

  1765.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L856" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1766. 

  1766. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L856" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1767. 

  1767. 

  1768.   </dd>
    1769. 

  1769. </div>
    1770. 

  1770. 

  1771. </div>
    1772. 

  1772. <div id="wrapSocket-procs-all">
    1773. 

  1773.   <div id="wrapSocket,SslContext,Socket">
    1774. 

  1774.   <dt><pre><span class="Keyword">proc</span> <a href="#wrapSocket%2CSslContext%2CSocket"><span class="Identifier">wrapSocket</span></a><span class="Other">(</span><span class="Identifier">ctx</span><span class="Other">:</span> <a href="net.html#SslContext"><span class="Identifier">SslContext</span></a><span class="Other">;</span> <span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</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">SslError</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>
    1775. 

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

  1776.   <dd>
    1777. 

  1777.     
    1778. 

  1778.     <p>Wraps a socket in an SSL context. This function effectively turns <tt class="docutils literal"><span class="pre"><span class="Identifier">socket</span></span></tt> into an SSL socket.</p>
    1779. 

  1779. <p>This must be called on an unconnected socket; an SSL session will be started when the socket is connected.</p>
    1780. 

  1780. <p>FIXME: <strong>Disclaimer</strong>: This code is not well tested, may be very unsafe and prone to security vulnerabilities.</p>
    1781. 

  1781. 

  1782.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L809" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1783. 

  1783. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L809" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1784. 

  1784. 

  1785.   </dd>
    1786. 

  1786. </div>
    1787. 

  1787. 

  1788. </div>
    1789. 

  1789. 

  1790.   </dl>
    1791. 

  1791. </div>
    1792. 

  1792. <div class="section" id="18">
    1793. 

  1793.   <h1><a class="toc-backref" href="#18">Templates</a></h1>
    1794. 

  1794.   <dl class="item">
    1795. 

  1795.     <div id="&amp;=-templates-all">
    1796. 

  1796.   <div id="&=.t,Socket,typed">
    1797. 

  1797.   <dt><pre><span class="Keyword">template</span> <a href="#%26%3D.t%2CSocket%2Ctyped"><span class="Identifier">`&amp;=`</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <a href="system.html#typed"><span class="Identifier">typed</span></a><span class="Other">)</span></pre></dt>
    1798. 

  1798.   <dd>
    1799. 

  1799.     
    1800. 

  1800.     an alias for 'send'.
    1801. 

  1801.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/net.nim#L1771" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1802. 

  1802. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/net.nim#L1771" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1803. 

  1803. 

  1804.   </dd>
    1805. 

  1805. </div>
    1806. 

  1806. 

  1807. </div>
    1808. 

  1808. 

  1809.   </dl>
    1810. 

  1810. </div>
    1811. 

  1811. 

  1812.   </div>
    1813. 

  1813. </div>
    1814. 

  1814. 

  1815.       <div class="twelve-columns footer">
    1816. 

  1816.         <span class="nim-sprite"></span>
    1817. 

  1817.         <br>
    1818. 

  1818.         <small style="color: var(--hint);">Made with Nim. Generated: 2025-01-09 12:00:20 UTC</small>
    1819. 

  1819.       </div>
    1820. 

  1820.     </div>
    1821. 

  1821.   </div>
    1822. 

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

  1823.     
    1824. 

  1824. </body>
    1825. 

  1825. </html>
    1826. 

  1826.