nativesockets.html 94 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <!-- This file is generated by Nim. -->
  4. <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
  5. <head>
  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  8. <title>std/nativesockets</title>
  9. <!-- Google fonts -->
  10. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
  11. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
  12. <!-- Favicon -->
  13. <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=="/>
  14. <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=">
  15. <!-- CSS -->
  16. <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
  17. <!-- JS -->
  18. <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
  19. </head>
  20. <body>
  21. <div class="document" id="documentId">
  22. <div class="container">
  23. <h1 class="title">std/nativesockets</h1>
  24. <div class="row">
  25. <div class="three columns">
  26. <div class="theme-select-wrapper">
  27. <label for="theme-select">Theme:&nbsp;</label>
  28. <select id="theme-select" onchange="setTheme(this.value)">
  29. <option value="auto">🌗 Match OS</option>
  30. <option value="dark">🌑 Dark</option>
  31. <option value="light">🌕 Light</option>
  32. </select>
  33. </div>
  34. <div id="global-links">
  35. <ul class="simple-boot">
  36. <li><a href="manual.html">Manual</a></li>
  37. <li><a href="lib.html">Standard library</a></li>
  38. <li> <a id="indexLink" href="theindex.html">Index</a></li>
  39. <li><a href="compiler/theindex.html">Compiler docs</a></li>
  40. <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
  41. <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
  42. </ul>
  43. </div>
  44. <div id="searchInputDiv">
  45. Search: <input type="search" id="searchInput"
  46. oninput="search()" />
  47. </div>
  48. <ul class="simple simple-toc" id="toc-list">
  49. <li>
  50. <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
  51. </li>
  52. <li>
  53. <details open>
  54. <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
  55. <ul class="simple simple-toc-section">
  56. <li><a class="reference" href="#Domain" title="Domain = enum
  57. AF_UNSPEC = 0, ## unspecified domain (can be detected automatically by
  58. ## some procedures, such as getaddrinfo)
  59. AF_UNIX = 1, ## for local socket (using a file). Unsupported on Windows.
  60. AF_INET = 2, ## for network protocol IPv4 or
  61. AF_INET6 = 10">Domain</a></li>
  62. <li><a class="reference" href="#Hostent" title="Hostent = object
  63. name*: string
  64. aliases*: seq[string]
  65. addrtype*: Domain
  66. length*: int
  67. addrList*: seq[string]">Hostent</a></li>
  68. <li><a class="reference" href="#Port" title="Port = distinct uint16">Port</a></li>
  69. <li><a class="reference" href="#Protocol" title="Protocol = enum
  70. IPPROTO_TCP = 6, ## Transmission control protocol.
  71. IPPROTO_UDP = 17, ## User datagram protocol.
  72. IPPROTO_IP, ## Internet protocol.
  73. IPPROTO_IPV6, ## Internet Protocol Version 6.
  74. IPPROTO_RAW, ## Raw IP Packets Protocol. Unsupported on Windows.
  75. IPPROTO_ICMP, ## Internet Control message protocol.
  76. IPPROTO_ICMPV6 ## Internet Control message protocol for IPv6.">Protocol</a></li>
  77. <li><a class="reference" href="#Servent" title="Servent = object
  78. name*: string
  79. aliases*: seq[string]
  80. port*: Port
  81. proto*: string">Servent</a></li>
  82. <li><a class="reference" href="#SockType" title="SockType = enum
  83. SOCK_STREAM = 1, ## reliable stream-oriented service or Stream Sockets
  84. SOCK_DGRAM = 2, ## datagram service or Datagram Sockets
  85. SOCK_RAW = 3, ## raw protocols atop the network layer.
  86. SOCK_SEQPACKET = 5 ## reliable sequenced packet service">SockType</a></li>
  87. </ul>
  88. </details>
  89. </li>
  90. <li>
  91. <details open>
  92. <summary><a class="reference reference-toplevel" href="#9" id="59">Lets</a></summary>
  93. <ul class="simple simple-toc-section">
  94. <li><a class="reference" href="#osInvalidSocket" title="osInvalidSocket = INVALID_SOCKET">osInvalidSocket</a></li>
  95. </ul>
  96. </details>
  97. </li>
  98. <li>
  99. <details open>
  100. <summary><a class="reference reference-toplevel" href="#10" id="60">Consts</a></summary>
  101. <ul class="simple simple-toc-section">
  102. <li><a class="reference" href="#FIONBIO" title="FIONBIO = -2147195266'i32">FIONBIO</a></li>
  103. <li><a class="reference" href="#IOC_IN" title="IOC_IN = -2147483648">IOC_IN</a></li>
  104. <li><a class="reference" href="#IOCPARM_MASK" title="IOCPARM_MASK = 127">IOCPARM_MASK</a></li>
  105. <li><a class="reference" href="#IPPROTO_NONE" title="IPPROTO_NONE = IPPROTO_IP">IPPROTO_NONE</a></li>
  106. </ul>
  107. </details>
  108. </li>
  109. <li>
  110. <details open>
  111. <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
  112. <ul class="simple simple-toc-section">
  113. <ul class="simple nested-toc-section">$
  114. <li><a class="reference" href="#%24%2CPort" title="`$`(p: Port): string">`$`(p: Port): string</a></li>
  115. </ul>
  116. <ul class="simple nested-toc-section">==
  117. <li><a class="reference" href="#%3D%3D%2CPort%2CPort" title="`==`(a, b: Port): bool">`==`(a, b: Port): bool</a></li>
  118. </ul>
  119. <ul class="simple nested-toc-section">accept
  120. <li><a class="reference" href="#accept%2CSocketHandle" title="accept(fd: SocketHandle; inheritable = defined(nimInheritHandles)): (
  121. SocketHandle, string)">accept(fd: SocketHandle; inheritable = defined(nimInheritHandles)): (
  122. SocketHandle, string)</a></li>
  123. </ul>
  124. <ul class="simple nested-toc-section">bindAddr
  125. <li><a class="reference" href="#bindAddr%2CSocketHandle%2Cptr.SockAddr%2CSockLen" title="bindAddr(socket: SocketHandle; name: ptr SockAddr; namelen: SockLen): cint">bindAddr(socket: SocketHandle; name: ptr SockAddr; namelen: SockLen): cint</a></li>
  126. </ul>
  127. <ul class="simple nested-toc-section">close
  128. <li><a class="reference" href="#close%2CSocketHandle" title="close(socket: SocketHandle)">close(socket: SocketHandle)</a></li>
  129. </ul>
  130. <ul class="simple nested-toc-section">createNativeSocket
  131. <li><a class="reference" href="#createNativeSocket%2Ccint%2Ccint%2Ccint%2Cbool" title="createNativeSocket(domain: cint; sockType: cint; protocol: cint;
  132. inheritable: bool = defined(nimInheritHandles)): SocketHandle">createNativeSocket(domain: cint; sockType: cint; protocol: cint;
  133. inheritable: bool = defined(nimInheritHandles)): SocketHandle</a></li>
  134. <li><a class="reference" href="#createNativeSocket%2CDomain%2CSockType%2CProtocol%2Cbool" title="createNativeSocket(domain: Domain = AF_INET; sockType: SockType = SOCK_STREAM;
  135. protocol: Protocol = IPPROTO_TCP;
  136. inheritable: bool = defined(nimInheritHandles)): SocketHandle">createNativeSocket(domain: Domain = AF_INET; sockType: SockType = SOCK_STREAM;
  137. protocol: Protocol = IPPROTO_TCP;
  138. inheritable: bool = defined(nimInheritHandles)): SocketHandle</a></li>
  139. </ul>
  140. <ul class="simple nested-toc-section">getAddrInfo
  141. <li><a class="reference" href="#getAddrInfo%2Cstring%2CPort%2CDomain%2CSockType%2CProtocol" title="getAddrInfo(address: string; port: Port; domain: Domain = AF_INET;
  142. sockType: SockType = SOCK_STREAM; protocol: Protocol = IPPROTO_TCP): ptr AddrInfo">getAddrInfo(address: string; port: Port; domain: Domain = AF_INET;
  143. sockType: SockType = SOCK_STREAM; protocol: Protocol = IPPROTO_TCP): ptr AddrInfo</a></li>
  144. </ul>
  145. <ul class="simple nested-toc-section">getAddrString
  146. <li><a class="reference" href="#getAddrString%2Cptr.SockAddr" title="getAddrString(sockAddr: ptr SockAddr): string">getAddrString(sockAddr: ptr SockAddr): string</a></li>
  147. <li><a class="reference" href="#getAddrString%2Cptr.SockAddr%2Cstring" title="getAddrString(sockAddr: ptr SockAddr; strAddress: var string)">getAddrString(sockAddr: ptr SockAddr; strAddress: var string)</a></li>
  148. </ul>
  149. <ul class="simple nested-toc-section">getHostByAddr
  150. <li><a class="reference" href="#getHostByAddr%2Cstring" title="getHostByAddr(ip: string): Hostent">getHostByAddr(ip: string): Hostent</a></li>
  151. </ul>
  152. <ul class="simple nested-toc-section">getHostByName
  153. <li><a class="reference" href="#getHostByName%2Cstring" title="getHostByName(name: string): Hostent">getHostByName(name: string): Hostent</a></li>
  154. </ul>
  155. <ul class="simple nested-toc-section">getHostname
  156. <li><a class="reference" href="#getHostname" title="getHostname(): string">getHostname(): string</a></li>
  157. </ul>
  158. <ul class="simple nested-toc-section">getLocalAddr
  159. <li><a class="reference" href="#getLocalAddr%2CSocketHandle%2CDomain" title="getLocalAddr(socket: SocketHandle; domain: Domain): (string, Port)">getLocalAddr(socket: SocketHandle; domain: Domain): (string, Port)</a></li>
  160. </ul>
  161. <ul class="simple nested-toc-section">getPeerAddr
  162. <li><a class="reference" href="#getPeerAddr%2CSocketHandle%2CDomain" title="getPeerAddr(socket: SocketHandle; domain: Domain): (string, Port)">getPeerAddr(socket: SocketHandle; domain: Domain): (string, Port)</a></li>
  163. </ul>
  164. <ul class="simple nested-toc-section">getProtoByName
  165. <li><a class="reference" href="#getProtoByName%2Cstring" title="getProtoByName(name: string): int">getProtoByName(name: string): int</a></li>
  166. </ul>
  167. <ul class="simple nested-toc-section">getServByName
  168. <li><a class="reference" href="#getServByName%2Cstring%2Cstring" title="getServByName(name, proto: string): Servent">getServByName(name, proto: string): Servent</a></li>
  169. </ul>
  170. <ul class="simple nested-toc-section">getServByPort
  171. <li><a class="reference" href="#getServByPort%2CPort%2Cstring" title="getServByPort(port: Port; proto: string): Servent">getServByPort(port: Port; proto: string): Servent</a></li>
  172. </ul>
  173. <ul class="simple nested-toc-section">getSockDomain
  174. <li><a class="reference" href="#getSockDomain%2CSocketHandle" title="getSockDomain(socket: SocketHandle): Domain">getSockDomain(socket: SocketHandle): Domain</a></li>
  175. </ul>
  176. <ul class="simple nested-toc-section">getSockName
  177. <li><a class="reference" href="#getSockName%2CSocketHandle" title="getSockName(socket: SocketHandle): Port">getSockName(socket: SocketHandle): Port</a></li>
  178. </ul>
  179. <ul class="simple nested-toc-section">getSockOptInt
  180. <li><a class="reference" href="#getSockOptInt%2CSocketHandle%2Cint%2Cint" title="getSockOptInt(socket: SocketHandle; level, optname: int): int">getSockOptInt(socket: SocketHandle; level, optname: int): int</a></li>
  181. </ul>
  182. <ul class="simple nested-toc-section">ioctlsocket
  183. <li><a class="reference" href="#ioctlsocket%2CSocketHandle%2Cclong%2Cptr.clong" title="ioctlsocket(s: SocketHandle; cmd: clong; argptr: ptr clong): cint">ioctlsocket(s: SocketHandle; cmd: clong; argptr: ptr clong): cint</a></li>
  184. </ul>
  185. <ul class="simple nested-toc-section">listen
  186. <li><a class="reference" href="#listen%2CSocketHandle" title="listen(socket: SocketHandle; backlog = SOMAXCONN): cint">listen(socket: SocketHandle; backlog = SOMAXCONN): cint</a></li>
  187. </ul>
  188. <ul class="simple nested-toc-section">ntohl
  189. <li><a class="reference" href="#ntohl%2Cuint32" title="ntohl(x: uint32): uint32">ntohl(x: uint32): uint32</a></li>
  190. </ul>
  191. <ul class="simple nested-toc-section">ntohs
  192. <li><a class="reference" href="#ntohs%2Cuint16" title="ntohs(x: uint16): uint16">ntohs(x: uint16): uint16</a></li>
  193. </ul>
  194. <ul class="simple nested-toc-section">selectRead
  195. <li><a class="reference" href="#selectRead%2Cseq%5BSocketHandle%5D%2Cint" title="selectRead(readfds: var seq[SocketHandle]; timeout = 500): int">selectRead(readfds: var seq[SocketHandle]; timeout = 500): int</a></li>
  196. </ul>
  197. <ul class="simple nested-toc-section">selectWrite
  198. <li><a class="reference" href="#selectWrite%2Cseq%5BSocketHandle%5D%2Cint" title="selectWrite(writefds: var seq[SocketHandle]; timeout = 500): int">selectWrite(writefds: var seq[SocketHandle]; timeout = 500): int</a></li>
  199. </ul>
  200. <ul class="simple nested-toc-section">setBlocking
  201. <li><a class="reference" href="#setBlocking%2CSocketHandle%2Cbool" title="setBlocking(s: SocketHandle; blocking: bool)">setBlocking(s: SocketHandle; blocking: bool)</a></li>
  202. </ul>
  203. <ul class="simple nested-toc-section">setInheritable
  204. <li><a class="reference" href="#setInheritable%2CSocketHandle%2Cbool" title="setInheritable(s: SocketHandle; inheritable: bool): bool">setInheritable(s: SocketHandle; inheritable: bool): bool</a></li>
  205. </ul>
  206. <ul class="simple nested-toc-section">setSockOptInt
  207. <li><a class="reference" href="#setSockOptInt%2CSocketHandle%2Cint%2Cint%2Cint" title="setSockOptInt(socket: SocketHandle; level, optname, optval: int)">setSockOptInt(socket: SocketHandle; level, optname, optval: int)</a></li>
  208. </ul>
  209. <ul class="simple nested-toc-section">toInt
  210. <li><a class="reference" href="#toInt%2CDomain" title="toInt(domain: Domain): cint">toInt(domain: Domain): cint</a></li>
  211. <li><a class="reference" href="#toInt%2CProtocol" title="toInt(p: Protocol): cint">toInt(p: Protocol): cint</a></li>
  212. <li><a class="reference" href="#toInt%2CSockType" title="toInt(typ: SockType): cint">toInt(typ: SockType): cint</a></li>
  213. </ul>
  214. <ul class="simple nested-toc-section">toKnownDomain
  215. <li><a class="reference" href="#toKnownDomain%2Ccint" title="toKnownDomain(family: cint): Option[Domain]">toKnownDomain(family: cint): Option[Domain]</a></li>
  216. </ul>
  217. <ul class="simple nested-toc-section">toSockType
  218. <li><a class="reference" href="#toSockType%2CProtocol" title="toSockType(protocol: Protocol): SockType">toSockType(protocol: Protocol): SockType</a></li>
  219. </ul>
  220. </ul>
  221. </details>
  222. </li>
  223. <li>
  224. <details open>
  225. <summary><a class="reference reference-toplevel" href="#18" id="68">Templates</a></summary>
  226. <ul class="simple simple-toc-section">
  227. <ul class="simple nested-toc-section">htonl
  228. <li><a class="reference" href="#htonl.t%2Cuint32" title="htonl(x: uint32): untyped">htonl(x: uint32): untyped</a></li>
  229. </ul>
  230. <ul class="simple nested-toc-section">htons
  231. <li><a class="reference" href="#htons.t%2Cuint16" title="htons(x: uint16): untyped">htons(x: uint16): untyped</a></li>
  232. </ul>
  233. </ul>
  234. </details>
  235. </li>
  236. </ul>
  237. </div>
  238. <div class="nine columns" id="content">
  239. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  240. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  241. <div id="tocRoot"></div>
  242. <p class="module-desc">This module implements a low-level cross-platform sockets interface. Look at the <tt class="docutils literal"><span class="pre"><span class="Identifier">net</span></span></tt> module for the higher-level version.</p>
  243. <div class="section" id="6">
  244. <h1><a class="toc-backref" href="#6">Imports</a></h1>
  245. <dl class="item">
  246. <a class="reference external" href="os.html">os</a>, <a class="reference external" href="options.html">options</a>, <a class="reference external" href="since.html">since</a>, <a class="reference external" href="strbasics.html">strbasics</a>, <a class="reference external" href="assertions.html">assertions</a>, <a class="reference external" href="syncio.html">syncio</a>, <a class="reference external" href="winlean.html">winlean</a>
  247. </dl>
  248. </div>
  249. <div class="section" id="7">
  250. <h1><a class="toc-backref" href="#7">Types</a></h1>
  251. <dl class="item">
  252. <div id="Domain">
  253. <dt><pre><a href="nativesockets.html#Domain"><span class="Identifier">Domain</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
  254. <span class="Identifier">AF_UNSPEC</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">,</span> <span class="Comment">## unspecified domain (can be detected automatically by</span>
  255. <span class="Comment">## some procedures, such as getaddrinfo)</span>
  256. <span class="Identifier">AF_UNIX</span> <span class="Other">=</span> <span class="DecNumber">1</span><span class="Other">,</span> <span class="Comment">## for local socket (using a file). Unsupported on Windows.</span>
  257. <span class="Identifier">AF_INET</span> <span class="Other">=</span> <span class="DecNumber">2</span><span class="Other">,</span> <span class="Comment">## for network protocol IPv4 or</span>
  258. <span class="Identifier">AF_INET6</span> <span class="Other">=</span> <span class="DecNumber">10</span></pre></dt>
  259. <dd>
  260. domain, which specifies the protocol family of the created socket. Other domains than those that are listed here are unsupported.
  261. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L62" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  262. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L62" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  263. </dd>
  264. </div>
  265. <div id="Hostent">
  266. <dt><pre><a href="nativesockets.html#Hostent"><span class="Identifier">Hostent</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
  267. <span class="Identifier">name</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a>
  268. <span class="Identifier">aliases</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span>
  269. <span class="Identifier">addrtype</span><span class="Operator">*</span><span class="Other">:</span> <a href="nativesockets.html#Domain"><span class="Identifier">Domain</span></a>
  270. <span class="Identifier">length</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a>
  271. <span class="Identifier">addrList</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span></pre></dt>
  272. <dd>
  273. information about a given host
  274. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L93" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  275. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L93" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  276. </dd>
  277. </div>
  278. <div id="Port">
  279. <dt><pre><a href="nativesockets.html#Port"><span class="Identifier">Port</span></a> <span class="Other">=</span> <span class="Keyword">distinct</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a></pre></dt>
  280. <dd>
  281. port type
  282. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L60" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  283. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L60" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  284. </dd>
  285. </div>
  286. <div id="Protocol">
  287. <dt><pre><a href="nativesockets.html#Protocol"><span class="Identifier">Protocol</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
  288. <span class="Identifier">IPPROTO_TCP</span> <span class="Other">=</span> <span class="DecNumber">6</span><span class="Other">,</span> <span class="Comment">## Transmission control protocol.</span>
  289. <span class="Identifier">IPPROTO_UDP</span> <span class="Other">=</span> <span class="DecNumber">17</span><span class="Other">,</span> <span class="Comment">## User datagram protocol.</span>
  290. <span class="Identifier">IPPROTO_IP</span><span class="Other">,</span> <span class="Comment">## Internet protocol.</span>
  291. <span class="Identifier">IPPROTO_IPV6</span><span class="Other">,</span> <span class="Comment">## Internet Protocol Version 6.</span>
  292. <span class="Identifier">IPPROTO_RAW</span><span class="Other">,</span> <span class="Comment">## Raw IP Packets Protocol. Unsupported on Windows.</span>
  293. <span class="Identifier">IPPROTO_ICMP</span><span class="Other">,</span> <span class="Comment">## Internet Control message protocol.</span>
  294. <span class="Identifier">IPPROTO_ICMPV6</span> <span class="Comment">## Internet Control message protocol for IPv6.</span></pre></dt>
  295. <dd>
  296. third argument to <tt class="docutils literal"><span class="pre"><span class="Identifier">socket</span></span></tt> proc
  297. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L78" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  298. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L78" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  299. </dd>
  300. </div>
  301. <div id="Servent">
  302. <dt><pre><a href="nativesockets.html#Servent"><span class="Identifier">Servent</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
  303. <span class="Identifier">name</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a>
  304. <span class="Identifier">aliases</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span>
  305. <span class="Identifier">port</span><span class="Operator">*</span><span class="Other">:</span> <a href="nativesockets.html#Port"><span class="Identifier">Port</span></a>
  306. <span class="Identifier">proto</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
  307. <dd>
  308. information about a service
  309. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L87" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  310. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L87" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  311. </dd>
  312. </div>
  313. <div id="SockType">
  314. <dt><pre><a href="nativesockets.html#SockType"><span class="Identifier">SockType</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
  315. <span class="Identifier">SOCK_STREAM</span> <span class="Other">=</span> <span class="DecNumber">1</span><span class="Other">,</span> <span class="Comment">## reliable stream-oriented service or Stream Sockets</span>
  316. <span class="Identifier">SOCK_DGRAM</span> <span class="Other">=</span> <span class="DecNumber">2</span><span class="Other">,</span> <span class="Comment">## datagram service or Datagram Sockets</span>
  317. <span class="Identifier">SOCK_RAW</span> <span class="Other">=</span> <span class="DecNumber">3</span><span class="Other">,</span> <span class="Comment">## raw protocols atop the network layer.</span>
  318. <span class="Identifier">SOCK_SEQPACKET</span> <span class="Other">=</span> <span class="DecNumber">5</span> <span class="Comment">## reliable sequenced packet service</span></pre></dt>
  319. <dd>
  320. second argument to <tt class="docutils literal"><span class="pre"><span class="Identifier">socket</span></span></tt> proc
  321. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L72" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  322. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L72" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  323. </dd>
  324. </div>
  325. </dl>
  326. </div>
  327. <div class="section" id="9">
  328. <h1><a class="toc-backref" href="#9">Lets</a></h1>
  329. <dl class="item">
  330. <div id="osInvalidSocket">
  331. <dt><pre><a href="nativesockets.html#osInvalidSocket"><span class="Identifier">osInvalidSocket</span></a> <span class="Other">=</span> <a href="winlean.html#INVALID_SOCKET"><span class="Identifier">INVALID_SOCKET</span></a></pre></dt>
  332. <dd>
  333. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L104" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  334. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L104" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  335. </dd>
  336. </div>
  337. </dl>
  338. </div>
  339. <div class="section" id="10">
  340. <h1><a class="toc-backref" href="#10">Consts</a></h1>
  341. <dl class="item">
  342. <div id="FIONBIO">
  343. <dt><pre><a href="nativesockets.html#FIONBIO"><span class="Identifier">FIONBIO</span></a> <span class="Other">=</span> <span class="DecNumber">-2147195266'i32</span></pre></dt>
  344. <dd>
  345. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L109" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  346. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L109" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  347. </dd>
  348. </div>
  349. <div id="IOC_IN">
  350. <dt><pre><a href="nativesockets.html#IOC_IN"><span class="Identifier">IOC_IN</span></a> <span class="Other">=</span> <span class="DecNumber">-2147483648</span></pre></dt>
  351. <dd>
  352. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L108" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  353. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L108" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  354. </dd>
  355. </div>
  356. <div id="IOCPARM_MASK">
  357. <dt><pre><a href="nativesockets.html#IOCPARM_MASK"><span class="Identifier">IOCPARM_MASK</span></a> <span class="Other">=</span> <span class="DecNumber">127</span></pre></dt>
  358. <dd>
  359. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L107" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  360. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L107" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  361. </dd>
  362. </div>
  363. <div id="IPPROTO_NONE">
  364. <dt><pre><a href="nativesockets.html#IPPROTO_NONE"><span class="Identifier">IPPROTO_NONE</span></a> <span class="Other">=</span> <span class="DecNumber">IPPROTO_IP</span></pre></dt>
  365. <dd>
  366. Use this if your socket type requires a protocol value of zero (e.g. Unix sockets).
  367. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L100" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  368. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L100" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  369. </dd>
  370. </div>
  371. </dl>
  372. </div>
  373. <div class="section" id="12">
  374. <h1><a class="toc-backref" href="#12">Procs</a></h1>
  375. <dl class="item">
  376. <div id="$-procs-all">
  377. <div id="$,Port">
  378. <dt><pre><span class="Keyword">proc</span> <a href="#%24%2CPort"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="nativesockets.html#Port"><span class="Identifier">Port</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">borrow</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  379. <dd>
  380. Returns the port number as a string
  381. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L127" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  382. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L127" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  383. </dd>
  384. </div>
  385. </div>
  386. <div id="==-procs-all">
  387. <div id="==,Port,Port">
  388. <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2CPort%2CPort"><span class="Identifier">`==`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="nativesockets.html#Port"><span class="Identifier">Port</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">borrow</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  389. <dd>
  390. <tt class="docutils literal"><span class="pre"><span class="Operator">==</span></span></tt> for ports.
  391. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L124" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  392. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L124" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  393. </dd>
  394. </div>
  395. </div>
  396. <div id="accept-procs-all">
  397. <div id="accept,SocketHandle">
  398. <dt><pre><span class="Keyword">proc</span> <a href="#accept%2CSocketHandle"><span class="Identifier">accept</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">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="Other">(</span>
  399. <a href="winlean.html#SocketHandle"><span class="Identifier">SocketHandle</span></a><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>
  400. <dd>
  401. <p>Accepts a new client connection.</p>
  402. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">inheritable</span></span></tt> decides if the resulting SocketHandle can be inherited by child processes.</p>
  403. <p>Returns (osInvalidSocket, &quot;&quot;) if an error occurred.</p>
  404. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L853" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  405. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L853" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  406. </dd>
  407. </div>
  408. </div>
  409. <div id="bindAddr-procs-all">
  410. <div id="bindAddr,SocketHandle,ptr.SockAddr,SockLen">
  411. <dt><pre><span class="Keyword">proc</span> <a href="#bindAddr%2CSocketHandle%2Cptr.SockAddr%2CSockLen"><span class="Identifier">bindAddr</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="winlean.html#SocketHandle"><span class="Identifier">SocketHandle</span></a><span class="Other">;</span> <span class="Identifier">name</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="winlean.html#SockAddr"><span class="Identifier">SockAddr</span></a><span class="Other">;</span> <span class="Identifier">namelen</span><span class="Other">:</span> <a href="winlean.html#SockLen"><span class="Identifier">SockLen</span></a><span class="Other">)</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a> {.
  412. <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>
  413. <dd>
  414. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L274" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  415. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L274" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  416. </dd>
  417. </div>
  418. </div>
  419. <div id="close-procs-all">
  420. <div id="close,SocketHandle">
  421. <dt><pre><span class="Keyword">proc</span> <a href="#close%2CSocketHandle"><span class="Identifier">close</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="winlean.html#SocketHandle"><span class="Identifier">SocketHandle</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>
  422. <dd>
  423. Closes a socket.
  424. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L226" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  425. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L226" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  426. </dd>
  427. </div>
  428. </div>
  429. <div id="createNativeSocket-procs-all">
  430. <div id="createNativeSocket,cint,cint,cint,bool">
  431. <dt><pre><span class="Keyword">proc</span> <a href="#createNativeSocket%2Ccint%2Ccint%2Ccint%2Cbool"><span class="Identifier">createNativeSocket</span></a><span class="Other">(</span><span class="Identifier">domain</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a><span class="Other">;</span> <span class="Identifier">sockType</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a><span class="Other">;</span> <span class="Identifier">protocol</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a><span class="Other">;</span>
  432. <span class="Identifier">inheritable</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> <span class="Other">=</span> <span class="Identifier">defined</span><span class="Other">(</span><span class="Identifier">nimInheritHandles</span><span class="Other">)</span><span class="Other">)</span><span class="Other">:</span> <a href="winlean.html#SocketHandle"><span class="Identifier">SocketHandle</span></a> {.
  433. <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>
  434. <dd>
  435. <p>Creates a new socket; returns <tt class="docutils literal"><span class="pre"><span class="Identifier">osInvalidSocket</span></span></tt> if an error occurs.</p>
  436. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">inheritable</span></span></tt> decides if the resulting SocketHandle can be inherited by child processes.</p>
  437. <p>Use this overload if one of the enums specified above does not contain what you need.</p>
  438. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L244" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  439. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L244" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  440. </dd>
  441. </div>
  442. <div id="createNativeSocket,Domain,SockType,Protocol,bool">
  443. <dt><pre><span class="Keyword">proc</span> <a href="#createNativeSocket%2CDomain%2CSockType%2CProtocol%2Cbool"><span class="Identifier">createNativeSocket</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>
  444. <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>
  445. <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>
  446. <span class="Identifier">inheritable</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> <span class="Other">=</span> <span class="Identifier">defined</span><span class="Other">(</span><span class="Identifier">nimInheritHandles</span><span class="Other">)</span><span class="Other">)</span><span class="Other">:</span> <a href="winlean.html#SocketHandle"><span class="Identifier">SocketHandle</span></a> {.
  447. <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>
  448. <dd>
  449. <p>Creates a new socket; returns <tt class="docutils literal"><span class="pre"><span class="Identifier">osInvalidSocket</span></span></tt> if an error occurs.</p>
  450. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">inheritable</span></span></tt> decides if the resulting SocketHandle can be inherited by child processes.</p>
  451. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L264" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  452. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L264" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  453. </dd>
  454. </div>
  455. </div>
  456. <div id="getAddrInfo-procs-all">
  457. <div id="getAddrInfo,string,Port,Domain,SockType,Protocol">
  458. <dt><pre><span class="Keyword">proc</span> <a href="#getAddrInfo%2Cstring%2CPort%2CDomain%2CSockType%2CProtocol"><span class="Identifier">getAddrInfo</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">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>
  459. <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>
  460. <span class="Identifier">protocol</span><span class="Other">:</span> <a href="nativesockets.html#Protocol"><span class="Identifier">Protocol</span></a> <span class="Other">=</span> <span class="Identifier">IPPROTO_TCP</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="winlean.html#AddrInfo"><span class="Identifier">AddrInfo</span></a> {.
  461. <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>
  462. <dd>
  463. <div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
  464. The resulting <tt class="docutils literal"><span class="pre"><span class="Keyword">ptr</span> <span class="Identifier">AddrInfo</span></span></tt> must be freed using <tt class="docutils literal"><span class="pre"><span class="Identifier">freeAddrInfo</span></span></tt>!</div>
  465. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L288" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  466. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L288" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  467. </dd>
  468. </div>
  469. </div>
  470. <div id="getAddrString-procs-all">
  471. <div id="getAddrString,ptr.SockAddr">
  472. <dt><pre><span class="Keyword">proc</span> <a href="#getAddrString%2Cptr.SockAddr"><span class="Identifier">getAddrString</span></a><span class="Other">(</span><span class="Identifier">sockAddr</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="winlean.html#SockAddr"><span class="Identifier">SockAddr</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.
  473. <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="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">IOError</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>
  474. <dd>
  475. Returns the string representation of address within sockAddr
  476. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L515" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  477. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L515" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  478. </dd>
  479. </div>
  480. <div id="getAddrString,ptr.SockAddr,string">
  481. <dt><pre><span class="Keyword">proc</span> <a href="#getAddrString%2Cptr.SockAddr%2Cstring"><span class="Identifier">getAddrString</span></a><span class="Other">(</span><span class="Identifier">sockAddr</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="winlean.html#SockAddr"><span class="Identifier">SockAddr</span></a><span class="Other">;</span> <span class="Identifier">strAddress</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> {.
  482. <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="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">IOError</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>
  483. <dd>
  484. <p>Stores in <tt class="docutils literal"><span class="pre"><span class="Identifier">strAddress</span></span></tt> the string representation of the address inside <tt class="docutils literal"><span class="pre"><span class="Identifier">sockAddr</span></span></tt></p>
  485. <p><strong>Note</strong></p>
  486. <ul class="simple"><li><tt class="docutils literal"><span class="pre"><span class="Identifier">strAddress</span></span></tt> must be initialized to 46 in length.</li>
  487. </ul>
  488. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L541" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  489. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L541" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  490. </dd>
  491. </div>
  492. </div>
  493. <div id="getHostByAddr-procs-all">
  494. <div id="getHostByAddr,string">
  495. <dt><pre><span class="Keyword">proc</span> <a href="#getHostByAddr%2Cstring"><span class="Identifier">getHostByAddr</span></a><span class="Other">(</span><span class="Identifier">ip</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="nativesockets.html#Hostent"><span class="Identifier">Hostent</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>
  496. <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">Exception</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>
  497. <dd>
  498. This function will lookup the hostname of an IP Address.
  499. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L395" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  500. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L395" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  501. </dd>
  502. </div>
  503. </div>
  504. <div id="getHostByName-procs-all">
  505. <div id="getHostByName,string">
  506. <dt><pre><span class="Keyword">proc</span> <a href="#getHostByName%2Cstring"><span class="Identifier">getHostByName</span></a><span class="Other">(</span><span class="Identifier">name</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="nativesockets.html#Hostent"><span class="Identifier">Hostent</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>
  507. <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>
  508. <dd>
  509. This function will lookup the IP address of a hostname.
  510. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L468" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  511. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L468" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  512. </dd>
  513. </div>
  514. </div>
  515. <div id="getHostname-procs-all">
  516. <div id="getHostname">
  517. <dt><pre><span class="Keyword">proc</span> <a href="#getHostname"><span class="Identifier">getHostname</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><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>
  518. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  519. <dd>
  520. Returns the local hostname (not the FQDN)
  521. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L499" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  522. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L499" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  523. </dd>
  524. </div>
  525. </div>
  526. <div id="getLocalAddr-procs-all">
  527. <div id="getLocalAddr,SocketHandle,Domain">
  528. <dt><pre><span class="Keyword">proc</span> <a href="#getLocalAddr%2CSocketHandle%2CDomain"><span class="Identifier">getLocalAddr</span></a><span class="Other">(</span><span class="Identifier">socket</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="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> {.
  529. <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>
  530. <dd>
  531. <p>Returns the socket's local address and port number.</p>
  532. <p>Similar to POSIX's <span id="getsockname_1">getsockname</span>.</p>
  533. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L598" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  534. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L598" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  535. </dd>
  536. </div>
  537. </div>
  538. <div id="getPeerAddr-procs-all">
  539. <div id="getPeerAddr,SocketHandle,Domain">
  540. <dt><pre><span class="Keyword">proc</span> <a href="#getPeerAddr%2CSocketHandle%2CDomain"><span class="Identifier">getPeerAddr</span></a><span class="Other">(</span><span class="Identifier">socket</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="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> {.
  541. <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>
  542. <dd>
  543. <p>Returns the socket's peer address and port number.</p>
  544. <p>Similar to POSIX's <span id="getpeername_1">getpeername</span></p>
  545. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L636" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  546. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L636" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  547. </dd>
  548. </div>
  549. </div>
  550. <div id="getProtoByName-procs-all">
  551. <div id="getProtoByName,string">
  552. <dt><pre><span class="Keyword">proc</span> <a href="#getProtoByName%2Cstring"><span class="Identifier">getProtoByName</span></a><span class="Other">(</span><span class="Identifier">name</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#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">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>
  553. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  554. <dd>
  555. Returns a protocol code from the database that matches the protocol <tt class="docutils literal"><span class="pre"><span class="Identifier">name</span></span></tt>.
  556. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L214" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  557. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L214" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  558. </dd>
  559. </div>
  560. </div>
  561. <div id="getServByName-procs-all">
  562. <div id="getServByName,string,string">
  563. <dt><pre><span class="Keyword">proc</span> <a href="#getServByName%2Cstring%2Cstring"><span class="Identifier">getServByName</span></a><span class="Other">(</span><span class="Identifier">name</span><span class="Other">,</span> <span class="Identifier">proto</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="nativesockets.html#Servent"><span class="Identifier">Servent</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>
  564. <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>
  565. <dd>
  566. <p>Searches the database from the beginning and finds the first entry for which the service name specified by <tt class="docutils literal"><span class="pre"><span class="Identifier">name</span></span></tt> matches the s_name member and the protocol name specified by <tt class="docutils literal"><span class="pre"><span class="Identifier">proto</span></span></tt> matches the s_proto member.</p>
  567. <p>On posix this will search through the <tt class="docutils literal"><span class="pre"><span class="Operator">/</span><span class="Identifier">etc</span><span class="Operator">/</span><span class="Identifier">services</span></span></tt> file.</p>
  568. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L359" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  569. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L359" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  570. </dd>
  571. </div>
  572. </div>
  573. <div id="getServByPort-procs-all">
  574. <div id="getServByPort,Port,string">
  575. <dt><pre><span class="Keyword">proc</span> <a href="#getServByPort%2CPort%2Cstring"><span class="Identifier">getServByPort</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">proto</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="nativesockets.html#Servent"><span class="Identifier">Servent</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>
  576. <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>
  577. <dd>
  578. <p>Searches the database from the beginning and finds the first entry for which the port specified by <tt class="docutils literal"><span class="pre"><span class="Identifier">port</span></span></tt> matches the s_port member and the protocol name specified by <tt class="docutils literal"><span class="pre"><span class="Identifier">proto</span></span></tt> matches the s_proto member.</p>
  579. <p>On posix this will search through the <tt class="docutils literal"><span class="pre"><span class="Operator">/</span><span class="Identifier">etc</span><span class="Operator">/</span><span class="Identifier">services</span></span></tt> file.</p>
  580. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L377" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  581. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L377" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  582. </dd>
  583. </div>
  584. </div>
  585. <div id="getSockDomain-procs-all">
  586. <div id="getSockDomain,SocketHandle">
  587. <dt><pre><span class="Keyword">proc</span> <a href="#getSockDomain%2CSocketHandle"><span class="Identifier">getSockDomain</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="winlean.html#SocketHandle"><span class="Identifier">SocketHandle</span></a><span class="Other">)</span><span class="Other">:</span> <a href="nativesockets.html#Domain"><span class="Identifier">Domain</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="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span>
  588. <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>
  589. <dd>
  590. Returns the socket's domain (AF_INET or AF_INET6).
  591. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L345" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  592. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L345" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  593. </dd>
  594. </div>
  595. </div>
  596. <div id="getSockName-procs-all">
  597. <div id="getSockName,SocketHandle">
  598. <dt><pre><span class="Keyword">proc</span> <a href="#getSockName%2CSocketHandle"><span class="Identifier">getSockName</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="winlean.html#SocketHandle"><span class="Identifier">SocketHandle</span></a><span class="Other">)</span><span class="Other">:</span> <a href="nativesockets.html#Port"><span class="Identifier">Port</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>
  599. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  600. <dd>
  601. Returns the socket's associated port number.
  602. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L583" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  603. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L583" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  604. </dd>
  605. </div>
  606. </div>
  607. <div id="getSockOptInt-procs-all">
  608. <div id="getSockOptInt,SocketHandle,int,int">
  609. <dt><pre><span class="Keyword">proc</span> <a href="#getSockOptInt%2CSocketHandle%2Cint%2Cint"><span class="Identifier">getSockOptInt</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="winlean.html#SocketHandle"><span class="Identifier">SocketHandle</span></a><span class="Other">;</span> <span class="Identifier">level</span><span class="Other">,</span> <span class="Identifier">optname</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> {.
  610. <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>
  611. <dd>
  612. getsockopt for integer options.
  613. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L746" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  614. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L746" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  615. </dd>
  616. </div>
  617. </div>
  618. <div id="ioctlsocket-procs-all">
  619. <div id="ioctlsocket,SocketHandle,clong,ptr.clong">
  620. <dt><pre><span class="Keyword">proc</span> <a href="#ioctlsocket%2CSocketHandle%2Cclong%2Cptr.clong"><span class="Identifier">ioctlsocket</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="winlean.html#SocketHandle"><span class="Identifier">SocketHandle</span></a><span class="Other">;</span> <span class="Identifier">cmd</span><span class="Other">:</span> <a href="ctypes.html#clong"><span class="Identifier">clong</span></a><span class="Other">;</span> <span class="Identifier">argptr</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="ctypes.html#clong"><span class="Identifier">clong</span></a><span class="Other">)</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a> {.
  621. <span class="Identifier">stdcall</span><span class="Other">,</span> <span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;ioctlsocket&quot;</span><span class="Other">,</span> <span class="Identifier">dynlib</span><span class="Other">:</span> <span class="StringLit">&quot;ws2_32.dll&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><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>
  622. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  623. <dd>
  624. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L114" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  625. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L114" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  626. </dd>
  627. </div>
  628. </div>
  629. <div id="listen-procs-all">
  630. <div id="listen,SocketHandle">
  631. <dt><pre><span class="Keyword">proc</span> <a href="#listen%2CSocketHandle"><span class="Identifier">listen</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="winlean.html#SocketHandle"><span class="Identifier">SocketHandle</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 class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a> {.
  632. <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="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>
  633. <dd>
  634. 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.
  635. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L278" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  636. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L278" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  637. </dd>
  638. </div>
  639. </div>
  640. <div id="ntohl-procs-all">
  641. <div id="ntohl,uint32">
  642. <dt><pre><span class="Keyword">proc</span> <a href="#ntohl%2Cuint32"><span class="Identifier">ntohl</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</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>
  643. <dd>
  644. Converts 32-bit unsigned integers from network to host byte order. On machines where the host byte order is the same as network byte order, this is a no-op; otherwise, it performs a 4-byte swap operation.
  645. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L316" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  646. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L316" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  647. </dd>
  648. </div>
  649. </div>
  650. <div id="ntohs-procs-all">
  651. <div id="ntohs,uint16">
  652. <dt><pre><span class="Keyword">proc</span> <a href="#ntohs%2Cuint16"><span class="Identifier">ntohs</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</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>
  653. <dd>
  654. Converts 16-bit unsigned integers from network to host byte order. On machines where the host byte order is the same as network byte order, this is a no-op; otherwise, it performs a 2-byte swap operation.
  655. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L326" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  656. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L326" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  657. </dd>
  658. </div>
  659. </div>
  660. <div id="selectRead-procs-all">
  661. <div id="selectRead,seq[SocketHandle],int">
  662. <dt><pre><span class="Keyword">proc</span> <a href="#selectRead%2Cseq%5BSocketHandle%5D%2Cint"><span class="Identifier">selectRead</span></a><span class="Other">(</span><span class="Identifier">readfds</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="winlean.html#SocketHandle"><span class="Identifier">SocketHandle</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">timeout</span> <span class="Other">=</span> <span class="DecNumber">500</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.
  663. <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>
  664. <dd>
  665. <p>When a socket in <tt class="docutils literal"><span class="pre"><span class="Identifier">readfds</span></span></tt> is ready to be read from then a non-zero value will be returned specifying the count of the sockets which can be read from. The sockets which cannot be read from will also be removed from <tt class="docutils literal"><span class="pre"><span class="Identifier">readfds</span></span></tt>.</p>
  666. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">timeout</span></span></tt> is specified in milliseconds and <tt class="docutils literal"><span class="pre"><span class="Operator">-</span><span class="DecNumber">1</span></span></tt> can be specified for an unlimited time.</p>
  667. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L810" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  668. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L810" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  669. </dd>
  670. </div>
  671. </div>
  672. <div id="selectWrite-procs-all">
  673. <div id="selectWrite,seq[SocketHandle],int">
  674. <dt><pre><span class="Keyword">proc</span> <a href="#selectWrite%2Cseq%5BSocketHandle%5D%2Cint"><span class="Identifier">selectWrite</span></a><span class="Other">(</span><span class="Identifier">writefds</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="winlean.html#SocketHandle"><span class="Identifier">SocketHandle</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">timeout</span> <span class="Other">=</span> <span class="DecNumber">500</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.
  675. <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="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>
  676. <dd>
  677. <p>When a socket in <tt class="docutils literal"><span class="pre"><span class="Identifier">writefds</span></span></tt> is ready to be written to then a non-zero value will be returned specifying the count of the sockets which can be written to. The sockets which cannot be written to will also be removed from <tt class="docutils literal"><span class="pre"><span class="Identifier">writefds</span></span></tt>.</p>
  678. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">timeout</span></span></tt> is specified in milliseconds and <tt class="docutils literal"><span class="pre"><span class="Operator">-</span><span class="DecNumber">1</span></span></tt> can be specified for an unlimited time.</p>
  679. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L831" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  680. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L831" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  681. </dd>
  682. </div>
  683. </div>
  684. <div id="setBlocking-procs-all">
  685. <div id="setBlocking,SocketHandle,bool">
  686. <dt><pre><span class="Keyword">proc</span> <a href="#setBlocking%2CSocketHandle%2Cbool"><span class="Identifier">setBlocking</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="winlean.html#SocketHandle"><span class="Identifier">SocketHandle</span></a><span class="Other">;</span> <span class="Identifier">blocking</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
  687. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  688. <dd>
  689. <p>Sets blocking mode on socket.</p>
  690. <p>Raises OSError on error.</p>
  691. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L764" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  692. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L764" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  693. </dd>
  694. </div>
  695. </div>
  696. <div id="setInheritable-procs-all">
  697. <div id="setInheritable,SocketHandle,bool">
  698. <dt><pre><span class="Keyword">proc</span> <a href="#setInheritable%2CSocketHandle%2Cbool"><span class="Identifier">setInheritable</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="winlean.html#SocketHandle"><span class="Identifier">SocketHandle</span></a><span class="Other">;</span> <span class="Identifier">inheritable</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span>
  699. <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>
  700. <dd>
  701. <p>Set whether a socket is inheritable by child processes. Returns <tt class="docutils literal"><span class="pre"><span class="Identifier">true</span></span></tt> on success.</p>
  702. <p>This function is not implemented on all platform, test for availability with <tt class="docutils literal"><span class="pre"><span class="Identifier">declared</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">&lt;</span><span class="Identifier">system</span><span class="Operator">.</span><span class="Identifier">html</span><span class="Comment">#declared,untyped&gt;</span></span></tt>.</p>
  703. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L236" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  704. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L236" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  705. </dd>
  706. </div>
  707. </div>
  708. <div id="setSockOptInt-procs-all">
  709. <div id="setSockOptInt,SocketHandle,int,int,int">
  710. <dt><pre><span class="Keyword">proc</span> <a href="#setSockOptInt%2CSocketHandle%2Cint%2Cint%2Cint"><span class="Identifier">setSockOptInt</span></a><span class="Other">(</span><span class="Identifier">socket</span><span class="Other">:</span> <a href="winlean.html#SocketHandle"><span class="Identifier">SocketHandle</span></a><span class="Other">;</span> <span class="Identifier">level</span><span class="Other">,</span> <span class="Identifier">optname</span><span class="Other">,</span> <span class="Identifier">optval</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span> {.
  711. <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>
  712. <dd>
  713. setsockopt for integer options.
  714. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L756" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  715. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L756" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  716. </dd>
  717. </div>
  718. </div>
  719. <div id="toInt-procs-all">
  720. <div id="toInt,Domain">
  721. <dt><pre><span class="Keyword">proc</span> <a href="#toInt%2CDomain"><span class="Identifier">toInt</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="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>
  722. <dd>
  723. Converts the Domain enum to a platform-dependent <tt class="docutils literal"><span class="pre"><span class="Identifier">cint</span></span></tt>.
  724. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L130" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  725. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L130" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  726. </dd>
  727. </div>
  728. <div id="toInt,Protocol">
  729. <dt><pre><span class="Keyword">proc</span> <a href="#toInt%2CProtocol"><span class="Identifier">toInt</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="nativesockets.html#Protocol"><span class="Identifier">Protocol</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>
  730. <dd>
  731. Converts the Protocol enum to a platform-dependent <tt class="docutils literal"><span class="pre"><span class="Identifier">cint</span></span></tt>.
  732. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L136" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  733. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L136" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  734. </dd>
  735. </div>
  736. <div id="toInt,SockType">
  737. <dt><pre><span class="Keyword">proc</span> <a href="#toInt%2CSockType"><span class="Identifier">toInt</span></a><span class="Other">(</span><span class="Identifier">typ</span><span class="Other">:</span> <a href="nativesockets.html#SockType"><span class="Identifier">SockType</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>
  738. <dd>
  739. Converts the SockType enum to a platform-dependent <tt class="docutils literal"><span class="pre"><span class="Identifier">cint</span></span></tt>.
  740. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L133" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  741. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L133" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  742. </dd>
  743. </div>
  744. </div>
  745. <div id="toKnownDomain-procs-all">
  746. <div id="toKnownDomain,cint">
  747. <dt><pre><span class="Keyword">proc</span> <a href="#toKnownDomain%2Ccint"><span class="Identifier">toKnownDomain</span></a><span class="Other">(</span><span class="Identifier">family</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a><span class="Other">)</span><span class="Other">:</span> <a href="options.html#Option"><span class="Identifier">Option</span></a><span class="Other">[</span><a href="nativesockets.html#Domain"><span class="Identifier">Domain</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>
  748. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  749. <dd>
  750. Converts the platform-dependent <tt class="docutils literal"><span class="pre"><span class="Identifier">cint</span></span></tt> to the Domain or none(), if the <tt class="docutils literal"><span class="pre"><span class="Identifier">cint</span></span></tt> is not known.
  751. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L177" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  752. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L177" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  753. </dd>
  754. </div>
  755. </div>
  756. <div id="toSockType-procs-all">
  757. <div id="toSockType,Protocol">
  758. <dt><pre><span class="Keyword">proc</span> <a href="#toSockType%2CProtocol"><span class="Identifier">toSockType</span></a><span class="Other">(</span><span class="Identifier">protocol</span><span class="Other">:</span> <a href="nativesockets.html#Protocol"><span class="Identifier">Protocol</span></a><span class="Other">)</span><span class="Other">:</span> <a href="nativesockets.html#SockType"><span class="Identifier">SockType</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>
  759. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  760. <dd>
  761. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L205" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  762. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L205" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  763. </dd>
  764. </div>
  765. </div>
  766. </dl>
  767. </div>
  768. <div class="section" id="18">
  769. <h1><a class="toc-backref" href="#18">Templates</a></h1>
  770. <dl class="item">
  771. <div id="htonl-templates-all">
  772. <div id="htonl.t,uint32">
  773. <dt><pre><span class="Keyword">template</span> <a href="#htonl.t%2Cuint32"><span class="Identifier">htonl</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a></pre></dt>
  774. <dd>
  775. Converts 32-bit unsigned integers from host to network byte order. On machines where the host byte order is the same as network byte order, this is a no-op; otherwise, it performs a 4-byte swap operation.
  776. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L333" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  777. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L333" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  778. </dd>
  779. </div>
  780. </div>
  781. <div id="htons-templates-all">
  782. <div id="htons.t,uint16">
  783. <dt><pre><span class="Keyword">template</span> <a href="#htons.t%2Cuint16"><span class="Identifier">htons</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a></pre></dt>
  784. <dd>
  785. Converts 16-bit unsigned integers from host to network byte order. On machines where the host byte order is the same as network byte order, this is a no-op; otherwise, it performs a 2-byte swap operation.
  786. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L339" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  787. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L339" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  788. </dd>
  789. </div>
  790. </div>
  791. </dl>
  792. </div>
  793. </div>
  794. </div>
  795. <div class="twelve-columns footer">
  796. <span class="nim-sprite"></span>
  797. <br>
  798. <small style="color: var(--hint);">Made with Nim. Generated: 2025-03-15 14:13:20 UTC</small>
  799. </div>
  800. </div>
  801. </div>
  802. <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
  803. </body>
  804. </html>