12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010 |
- <?xml version="1.0" encoding="utf-8" ?>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <!-- This file is generated by Nim. -->
- <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>std/nativesockets</title>
- <!-- Google fonts -->
- <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
- <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
- <!-- Favicon -->
- <link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
- <link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
- <!-- CSS -->
- <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
- <!-- JS -->
- <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
- </head>
- <body>
- <div class="document" id="documentId">
- <div class="container">
- <h1 class="title">std/nativesockets</h1>
- <div class="row">
- <div class="three columns">
- <div class="theme-select-wrapper">
- <label for="theme-select">Theme: </label>
- <select id="theme-select" onchange="setTheme(this.value)">
- <option value="auto">🌗 Match OS</option>
- <option value="dark">🌑 Dark</option>
- <option value="light">🌕 Light</option>
- </select>
- </div>
- <div id="global-links">
- <ul class="simple-boot">
- <li><a href="manual.html">Manual</a></li>
- <li><a href="lib.html">Standard library</a></li>
- <li> <a id="indexLink" href="theindex.html">Index</a></li>
- <li><a href="compiler/theindex.html">Compiler docs</a></li>
- <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
- <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
- </ul>
- </div>
- <div id="searchInputDiv">
- Search: <input type="search" id="searchInput"
- oninput="search()" />
- </div>
-
- <ul class="simple simple-toc" id="toc-list">
- <li>
- <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
- </li>
- <li>
- <details open>
- <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
- <ul class="simple simple-toc-section">
- <li><a class="reference" href="#Domain" title="Domain = enum
- AF_UNSPEC = 0, ## unspecified domain (can be detected automatically by
- ## some procedures, such as getaddrinfo)
- AF_UNIX = 1, ## for local socket (using a file). Unsupported on Windows.
- AF_INET = 2, ## for network protocol IPv4 or
- AF_INET6 = 10">Domain</a></li>
- <li><a class="reference" href="#Hostent" title="Hostent = object
- name*: string
- aliases*: seq[string]
- addrtype*: Domain
- length*: int
- addrList*: seq[string]">Hostent</a></li>
- <li><a class="reference" href="#Port" title="Port = distinct uint16">Port</a></li>
- <li><a class="reference" href="#Protocol" title="Protocol = enum
- IPPROTO_TCP = 6, ## Transmission control protocol.
- IPPROTO_UDP = 17, ## User datagram protocol.
- IPPROTO_IP, ## Internet protocol.
- IPPROTO_IPV6, ## Internet Protocol Version 6.
- IPPROTO_RAW, ## Raw IP Packets Protocol. Unsupported on Windows.
- IPPROTO_ICMP, ## Internet Control message protocol.
- IPPROTO_ICMPV6 ## Internet Control message protocol for IPv6.">Protocol</a></li>
- <li><a class="reference" href="#Servent" title="Servent = object
- name*: string
- aliases*: seq[string]
- port*: Port
- proto*: string">Servent</a></li>
- <li><a class="reference" href="#SockType" title="SockType = enum
- SOCK_STREAM = 1, ## reliable stream-oriented service or Stream Sockets
- SOCK_DGRAM = 2, ## datagram service or Datagram Sockets
- SOCK_RAW = 3, ## raw protocols atop the network layer.
- SOCK_SEQPACKET = 5 ## reliable sequenced packet service">SockType</a></li>
- </ul>
- </details>
- </li>
- <li>
- <details open>
- <summary><a class="reference reference-toplevel" href="#9" id="59">Lets</a></summary>
- <ul class="simple simple-toc-section">
- <li><a class="reference" href="#osInvalidSocket" title="osInvalidSocket = INVALID_SOCKET">osInvalidSocket</a></li>
- </ul>
- </details>
- </li>
- <li>
- <details open>
- <summary><a class="reference reference-toplevel" href="#10" id="60">Consts</a></summary>
- <ul class="simple simple-toc-section">
- <li><a class="reference" href="#FIONBIO" title="FIONBIO = -2147195266'i32">FIONBIO</a></li>
- <li><a class="reference" href="#IOC_IN" title="IOC_IN = -2147483648">IOC_IN</a></li>
- <li><a class="reference" href="#IOCPARM_MASK" title="IOCPARM_MASK = 127">IOCPARM_MASK</a></li>
- <li><a class="reference" href="#IPPROTO_NONE" title="IPPROTO_NONE = IPPROTO_IP">IPPROTO_NONE</a></li>
- </ul>
- </details>
- </li>
- <li>
- <details open>
- <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
- <ul class="simple simple-toc-section">
- <ul class="simple nested-toc-section">$
- <li><a class="reference" href="#%24%2CPort" title="`$`(p: Port): string">`$`(p: Port): string</a></li>
- </ul>
- <ul class="simple nested-toc-section">==
- <li><a class="reference" href="#%3D%3D%2CPort%2CPort" title="`==`(a, b: Port): bool">`==`(a, b: Port): bool</a></li>
- </ul>
- <ul class="simple nested-toc-section">accept
- <li><a class="reference" href="#accept%2CSocketHandle" title="accept(fd: SocketHandle; inheritable = defined(nimInheritHandles)): (
- SocketHandle, string)">accept(fd: SocketHandle; inheritable = defined(nimInheritHandles)): (
- SocketHandle, string)</a></li>
- </ul>
- <ul class="simple nested-toc-section">bindAddr
- <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>
- </ul>
- <ul class="simple nested-toc-section">close
- <li><a class="reference" href="#close%2CSocketHandle" title="close(socket: SocketHandle)">close(socket: SocketHandle)</a></li>
- </ul>
- <ul class="simple nested-toc-section">createNativeSocket
- <li><a class="reference" href="#createNativeSocket%2Ccint%2Ccint%2Ccint%2Cbool" title="createNativeSocket(domain: cint; sockType: cint; protocol: cint;
- inheritable: bool = defined(nimInheritHandles)): SocketHandle">createNativeSocket(domain: cint; sockType: cint; protocol: cint;
- inheritable: bool = defined(nimInheritHandles)): SocketHandle</a></li>
- <li><a class="reference" href="#createNativeSocket%2CDomain%2CSockType%2CProtocol%2Cbool" title="createNativeSocket(domain: Domain = AF_INET; sockType: SockType = SOCK_STREAM;
- protocol: Protocol = IPPROTO_TCP;
- inheritable: bool = defined(nimInheritHandles)): SocketHandle">createNativeSocket(domain: Domain = AF_INET; sockType: SockType = SOCK_STREAM;
- protocol: Protocol = IPPROTO_TCP;
- inheritable: bool = defined(nimInheritHandles)): SocketHandle</a></li>
- </ul>
- <ul class="simple nested-toc-section">getAddrInfo
- <li><a class="reference" href="#getAddrInfo%2Cstring%2CPort%2CDomain%2CSockType%2CProtocol" title="getAddrInfo(address: string; port: Port; domain: Domain = AF_INET;
- sockType: SockType = SOCK_STREAM; protocol: Protocol = IPPROTO_TCP): ptr AddrInfo">getAddrInfo(address: string; port: Port; domain: Domain = AF_INET;
- sockType: SockType = SOCK_STREAM; protocol: Protocol = IPPROTO_TCP): ptr AddrInfo</a></li>
- </ul>
- <ul class="simple nested-toc-section">getAddrString
- <li><a class="reference" href="#getAddrString%2Cptr.SockAddr" title="getAddrString(sockAddr: ptr SockAddr): string">getAddrString(sockAddr: ptr SockAddr): string</a></li>
- <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>
- </ul>
- <ul class="simple nested-toc-section">getHostByAddr
- <li><a class="reference" href="#getHostByAddr%2Cstring" title="getHostByAddr(ip: string): Hostent">getHostByAddr(ip: string): Hostent</a></li>
- </ul>
- <ul class="simple nested-toc-section">getHostByName
- <li><a class="reference" href="#getHostByName%2Cstring" title="getHostByName(name: string): Hostent">getHostByName(name: string): Hostent</a></li>
- </ul>
- <ul class="simple nested-toc-section">getHostname
- <li><a class="reference" href="#getHostname" title="getHostname(): string">getHostname(): string</a></li>
- </ul>
- <ul class="simple nested-toc-section">getLocalAddr
- <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>
- </ul>
- <ul class="simple nested-toc-section">getPeerAddr
- <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>
- </ul>
- <ul class="simple nested-toc-section">getProtoByName
- <li><a class="reference" href="#getProtoByName%2Cstring" title="getProtoByName(name: string): int">getProtoByName(name: string): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">getServByName
- <li><a class="reference" href="#getServByName%2Cstring%2Cstring" title="getServByName(name, proto: string): Servent">getServByName(name, proto: string): Servent</a></li>
- </ul>
- <ul class="simple nested-toc-section">getServByPort
- <li><a class="reference" href="#getServByPort%2CPort%2Cstring" title="getServByPort(port: Port; proto: string): Servent">getServByPort(port: Port; proto: string): Servent</a></li>
- </ul>
- <ul class="simple nested-toc-section">getSockDomain
- <li><a class="reference" href="#getSockDomain%2CSocketHandle" title="getSockDomain(socket: SocketHandle): Domain">getSockDomain(socket: SocketHandle): Domain</a></li>
- </ul>
- <ul class="simple nested-toc-section">getSockName
- <li><a class="reference" href="#getSockName%2CSocketHandle" title="getSockName(socket: SocketHandle): Port">getSockName(socket: SocketHandle): Port</a></li>
- </ul>
- <ul class="simple nested-toc-section">getSockOptInt
- <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>
- </ul>
- <ul class="simple nested-toc-section">ioctlsocket
- <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>
- </ul>
- <ul class="simple nested-toc-section">listen
- <li><a class="reference" href="#listen%2CSocketHandle" title="listen(socket: SocketHandle; backlog = SOMAXCONN): cint">listen(socket: SocketHandle; backlog = SOMAXCONN): cint</a></li>
- </ul>
- <ul class="simple nested-toc-section">ntohl
- <li><a class="reference" href="#ntohl%2Cuint32" title="ntohl(x: uint32): uint32">ntohl(x: uint32): uint32</a></li>
- </ul>
- <ul class="simple nested-toc-section">ntohs
- <li><a class="reference" href="#ntohs%2Cuint16" title="ntohs(x: uint16): uint16">ntohs(x: uint16): uint16</a></li>
- </ul>
- <ul class="simple nested-toc-section">selectRead
- <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>
- </ul>
- <ul class="simple nested-toc-section">selectWrite
- <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>
- </ul>
- <ul class="simple nested-toc-section">setBlocking
- <li><a class="reference" href="#setBlocking%2CSocketHandle%2Cbool" title="setBlocking(s: SocketHandle; blocking: bool)">setBlocking(s: SocketHandle; blocking: bool)</a></li>
- </ul>
- <ul class="simple nested-toc-section">setInheritable
- <li><a class="reference" href="#setInheritable%2CSocketHandle%2Cbool" title="setInheritable(s: SocketHandle; inheritable: bool): bool">setInheritable(s: SocketHandle; inheritable: bool): bool</a></li>
- </ul>
- <ul class="simple nested-toc-section">setSockOptInt
- <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>
- </ul>
- <ul class="simple nested-toc-section">toInt
- <li><a class="reference" href="#toInt%2CDomain" title="toInt(domain: Domain): cint">toInt(domain: Domain): cint</a></li>
- <li><a class="reference" href="#toInt%2CProtocol" title="toInt(p: Protocol): cint">toInt(p: Protocol): cint</a></li>
- <li><a class="reference" href="#toInt%2CSockType" title="toInt(typ: SockType): cint">toInt(typ: SockType): cint</a></li>
- </ul>
- <ul class="simple nested-toc-section">toKnownDomain
- <li><a class="reference" href="#toKnownDomain%2Ccint" title="toKnownDomain(family: cint): Option[Domain]">toKnownDomain(family: cint): Option[Domain]</a></li>
- </ul>
- <ul class="simple nested-toc-section">toSockType
- <li><a class="reference" href="#toSockType%2CProtocol" title="toSockType(protocol: Protocol): SockType">toSockType(protocol: Protocol): SockType</a></li>
- </ul>
- </ul>
- </details>
- </li>
- <li>
- <details open>
- <summary><a class="reference reference-toplevel" href="#18" id="68">Templates</a></summary>
- <ul class="simple simple-toc-section">
- <ul class="simple nested-toc-section">htonl
- <li><a class="reference" href="#htonl.t%2Cuint32" title="htonl(x: uint32): untyped">htonl(x: uint32): untyped</a></li>
- </ul>
- <ul class="simple nested-toc-section">htons
- <li><a class="reference" href="#htons.t%2Cuint16" title="htons(x: uint16): untyped">htons(x: uint16): untyped</a></li>
- </ul>
- </ul>
- </details>
- </li>
- </ul>
- </div>
- <div class="nine columns" id="content">
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L1" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L1" class="link-seesrc" target="_blank" >Edit</a>
- <div id="tocRoot"></div>
-
- <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>
- <div class="section" id="6">
- <h1><a class="toc-backref" href="#6">Imports</a></h1>
- <dl class="item">
- <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>
- </dl>
- </div>
- <div class="section" id="7">
- <h1><a class="toc-backref" href="#7">Types</a></h1>
- <dl class="item">
- <div id="Domain">
- <dt><pre><a href="nativesockets.html#Domain"><span class="Identifier">Domain</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
- <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>
- <span class="Comment">## some procedures, such as getaddrinfo)</span>
- <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>
- <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>
- <span class="Identifier">AF_INET6</span> <span class="Other">=</span> <span class="DecNumber">10</span></pre></dt>
- <dd>
-
-
- domain, which specifies the protocol family of the created socket. Other domains than those that are listed here are unsupported.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L62" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L62" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="Hostent">
- <dt><pre><a href="nativesockets.html#Hostent"><span class="Identifier">Hostent</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
- <span class="Identifier">name</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a>
- <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>
- <span class="Identifier">addrtype</span><span class="Operator">*</span><span class="Other">:</span> <a href="nativesockets.html#Domain"><span class="Identifier">Domain</span></a>
- <span class="Identifier">length</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a>
- <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>
- <dd>
-
- information about a given host
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L93" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L93" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="Port">
- <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>
- <dd>
-
- port type
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L60" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L60" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="Protocol">
- <dt><pre><a href="nativesockets.html#Protocol"><span class="Identifier">Protocol</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
- <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>
- <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>
- <span class="Identifier">IPPROTO_IP</span><span class="Other">,</span> <span class="Comment">## Internet protocol.</span>
- <span class="Identifier">IPPROTO_IPV6</span><span class="Other">,</span> <span class="Comment">## Internet Protocol Version 6.</span>
- <span class="Identifier">IPPROTO_RAW</span><span class="Other">,</span> <span class="Comment">## Raw IP Packets Protocol. Unsupported on Windows.</span>
- <span class="Identifier">IPPROTO_ICMP</span><span class="Other">,</span> <span class="Comment">## Internet Control message protocol.</span>
- <span class="Identifier">IPPROTO_ICMPV6</span> <span class="Comment">## Internet Control message protocol for IPv6.</span></pre></dt>
- <dd>
-
- third argument to <tt class="docutils literal"><span class="pre"><span class="Identifier">socket</span></span></tt> proc
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L78" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L78" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="Servent">
- <dt><pre><a href="nativesockets.html#Servent"><span class="Identifier">Servent</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
- <span class="Identifier">name</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a>
- <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>
- <span class="Identifier">port</span><span class="Operator">*</span><span class="Other">:</span> <a href="nativesockets.html#Port"><span class="Identifier">Port</span></a>
- <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>
- <dd>
-
- information about a service
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L87" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L87" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="SockType">
- <dt><pre><a href="nativesockets.html#SockType"><span class="Identifier">SockType</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
- <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>
- <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>
- <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>
- <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>
- <dd>
-
- second argument to <tt class="docutils literal"><span class="pre"><span class="Identifier">socket</span></span></tt> proc
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L72" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L72" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </dl>
- </div>
- <div class="section" id="9">
- <h1><a class="toc-backref" href="#9">Lets</a></h1>
- <dl class="item">
- <div id="osInvalidSocket">
- <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>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L104" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L104" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </dl>
- </div>
- <div class="section" id="10">
- <h1><a class="toc-backref" href="#10">Consts</a></h1>
- <dl class="item">
- <div id="FIONBIO">
- <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>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L109" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L109" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="IOC_IN">
- <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>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L108" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L108" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="IOCPARM_MASK">
- <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>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L107" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L107" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="IPPROTO_NONE">
- <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>
- <dd>
-
- Use this if your socket type requires a protocol value of zero (e.g. Unix sockets).
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L100" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L100" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </dl>
- </div>
- <div class="section" id="12">
- <h1><a class="toc-backref" href="#12">Procs</a></h1>
- <dl class="item">
- <div id="$-procs-all">
- <div id="$,Port">
- <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>
- <dd>
-
- Returns the port number as a string
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L127" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L127" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="==-procs-all">
- <div id="==,Port,Port">
- <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>
- <dd>
-
- <tt class="docutils literal"><span class="pre"><span class="Operator">==</span></span></tt> for ports.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L124" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L124" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="accept-procs-all">
- <div id="accept,SocketHandle">
- <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>
- <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>
- <dd>
-
- <p>Accepts a new client connection.</p>
- <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>
- <p>Returns (osInvalidSocket, "") if an error occurred.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L853" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L853" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="bindAddr-procs-all">
- <div id="bindAddr,SocketHandle,ptr.SockAddr,SockLen">
- <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> {.
- <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>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L274" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L274" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="close-procs-all">
- <div id="close,SocketHandle">
- <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>
- <dd>
-
- Closes a socket.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L226" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L226" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="createNativeSocket-procs-all">
- <div id="createNativeSocket,cint,cint,cint,bool">
- <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>
- <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> {.
- <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>
- <dd>
-
- <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>
- <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>
- <p>Use this overload if one of the enums specified above does not contain what you need.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L244" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L244" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="createNativeSocket,Domain,SockType,Protocol,bool">
- <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>
- <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>
- <span class="Identifier">protocol</span><span class="Other">:</span> <a href="nativesockets.html#Protocol"><span class="Identifier">Protocol</span></a> <span class="Other">=</span> <span class="Identifier">IPPROTO_TCP</span><span class="Other">;</span>
- <span class="Identifier">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> {.
- <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>
- <dd>
-
- <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>
- <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>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L264" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L264" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="getAddrInfo-procs-all">
- <div id="getAddrInfo,string,Port,Domain,SockType,Protocol">
- <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>
- <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>
- <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> {.
- <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>
- <dd>
-
- <div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
- 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>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L288" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L288" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="getAddrString-procs-all">
- <div id="getAddrString,ptr.SockAddr">
- <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> {.
- <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>
- <dd>
-
- Returns the string representation of address within sockAddr
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L515" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L515" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="getAddrString,ptr.SockAddr,string">
- <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> {.
- <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>
- <dd>
-
- <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>
- <p><strong>Note</strong></p>
- <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>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L541" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L541" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="getHostByAddr-procs-all">
- <div id="getHostByAddr,string">
- <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>
- <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>
- <dd>
-
- This function will lookup the hostname of an IP Address.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L395" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L395" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="getHostByName-procs-all">
- <div id="getHostByName,string">
- <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>
- <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>
- <dd>
-
- This function will lookup the IP address of a hostname.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L468" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L468" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="getHostname-procs-all">
- <div id="getHostname">
- <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>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Returns the local hostname (not the FQDN)
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L499" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L499" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="getLocalAddr-procs-all">
- <div id="getLocalAddr,SocketHandle,Domain">
- <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> {.
- <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>
- <dd>
-
- <p>Returns the socket's local address and port number.</p>
- <p>Similar to POSIX's <span id="getsockname_1">getsockname</span>.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L598" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L598" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="getPeerAddr-procs-all">
- <div id="getPeerAddr,SocketHandle,Domain">
- <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> {.
- <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>
- <dd>
-
- <p>Returns the socket's peer address and port number.</p>
- <p>Similar to POSIX's <span id="getpeername_1">getpeername</span></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L636" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L636" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="getProtoByName-procs-all">
- <div id="getProtoByName,string">
- <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>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- 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>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L214" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L214" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="getServByName-procs-all">
- <div id="getServByName,string,string">
- <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>
- <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>
- <dd>
-
- <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>
- <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>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L359" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L359" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="getServByPort-procs-all">
- <div id="getServByPort,Port,string">
- <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>
- <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>
- <dd>
-
- <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>
- <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>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L377" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L377" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="getSockDomain-procs-all">
- <div id="getSockDomain,SocketHandle">
- <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>
- <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>
- <dd>
-
- Returns the socket's domain (AF_INET or AF_INET6).
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L345" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L345" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="getSockName-procs-all">
- <div id="getSockName,SocketHandle">
- <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>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Returns the socket's associated port number.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L583" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L583" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="getSockOptInt-procs-all">
- <div id="getSockOptInt,SocketHandle,int,int">
- <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> {.
- <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>
- <dd>
-
- getsockopt for integer options.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L746" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L746" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="ioctlsocket-procs-all">
- <div id="ioctlsocket,SocketHandle,clong,ptr.clong">
- <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> {.
- <span class="Identifier">stdcall</span><span class="Other">,</span> <span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"ioctlsocket"</span><span class="Other">,</span> <span class="Identifier">dynlib</span><span class="Other">:</span> <span class="StringLit">"ws2_32.dll"</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>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L114" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L114" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="listen-procs-all">
- <div id="listen,SocketHandle">
- <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> {.
- <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>
- <dd>
-
- 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.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L278" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L278" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="ntohl-procs-all">
- <div id="ntohl,uint32">
- <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>
- <dd>
-
- 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.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L316" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L316" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="ntohs-procs-all">
- <div id="ntohs,uint16">
- <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>
- <dd>
-
- 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.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L326" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L326" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="selectRead-procs-all">
- <div id="selectRead,seq[SocketHandle],int">
- <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> {.
- <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>
- <dd>
-
- <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>
- <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>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L810" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L810" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="selectWrite-procs-all">
- <div id="selectWrite,seq[SocketHandle],int">
- <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> {.
- <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>
- <dd>
-
- <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>
- <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>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L831" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L831" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="setBlocking-procs-all">
- <div id="setBlocking,SocketHandle,bool">
- <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>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Sets blocking mode on socket.</p>
- <p>Raises OSError on error.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L764" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L764" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="setInheritable-procs-all">
- <div id="setInheritable,SocketHandle,bool">
- <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>
- <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>
- <dd>
-
- <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>
- <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"><</span><span class="Identifier">system</span><span class="Operator">.</span><span class="Identifier">html</span><span class="Comment">#declared,untyped></span></span></tt>.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L236" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L236" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="setSockOptInt-procs-all">
- <div id="setSockOptInt,SocketHandle,int,int,int">
- <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> {.
- <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>
- <dd>
-
- setsockopt for integer options.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L756" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L756" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="toInt-procs-all">
- <div id="toInt,Domain">
- <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>
- <dd>
-
- Converts the Domain enum to a platform-dependent <tt class="docutils literal"><span class="pre"><span class="Identifier">cint</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L130" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L130" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="toInt,Protocol">
- <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>
- <dd>
-
- Converts the Protocol enum to a platform-dependent <tt class="docutils literal"><span class="pre"><span class="Identifier">cint</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L136" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L136" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="toInt,SockType">
- <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>
- <dd>
-
- Converts the SockType enum to a platform-dependent <tt class="docutils literal"><span class="pre"><span class="Identifier">cint</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L133" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L133" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="toKnownDomain-procs-all">
- <div id="toKnownDomain,cint">
- <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>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- 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.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L177" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L177" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="toSockType-procs-all">
- <div id="toSockType,Protocol">
- <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>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L205" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L205" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- </dl>
- </div>
- <div class="section" id="18">
- <h1><a class="toc-backref" href="#18">Templates</a></h1>
- <dl class="item">
- <div id="htonl-templates-all">
- <div id="htonl.t,uint32">
- <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>
- <dd>
-
- 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.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L333" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L333" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="htons-templates-all">
- <div id="htons.t,uint16">
- <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>
- <dd>
-
- 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.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/nativesockets.nim#L339" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/nativesockets.nim#L339" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- </dl>
- </div>
- </div>
- </div>
- <div class="twelve-columns footer">
- <span class="nim-sprite"></span>
- <br>
- <small style="color: var(--hint);">Made with Nim. Generated: 2025-03-15 14:13:20 UTC</small>
- </div>
- </div>
- </div>
- <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
-
- </body>
- </html>
|