25 lines
5.6 KiB
HTML
25 lines
5.6 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="`socket(domain, type_, protocol)`—Creates a socket."><title>socket in rustix::net - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rustix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustix/index.html">rustix</a><span class="version">0.38.37</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">socket</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#references" title="References">References</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In rustix::<wbr>net</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">rustix</a>::<wbr><a href="index.html">net</a></span><h1>Function <span class="fn">socket</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rustix/net/socket.rs.html#46-52">Source</a> </span></div><pre class="rust item-decl"><code>pub fn socket(
|
||
domain: <a class="struct" href="struct.AddressFamily.html" title="struct rustix::net::AddressFamily">AddressFamily</a>,
|
||
type_: <a class="struct" href="struct.SocketType.html" title="struct rustix::net::SocketType">SocketType</a>,
|
||
protocol: <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.Protocol.html" title="struct rustix::net::Protocol">Protocol</a>>,
|
||
) -> <a class="type" href="../io/type.Result.html" title="type rustix::io::Result">Result</a><<a class="struct" href="../fd/struct.OwnedFd.html" title="struct rustix::fd::OwnedFd">OwnedFd</a>></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>socket(domain, type_, protocol)</code>—Creates a socket.</p>
|
||
<p>POSIX guarantees that <code>socket</code> will use the lowest unused file descriptor,
|
||
however it is not safe in general to rely on this, as file descriptors may
|
||
be unexpectedly allocated on other threads or in libraries.</p>
|
||
<p>To pass extra flags such as <a href="struct.SocketFlags.html#associatedconstant.CLOEXEC" title="associated constant rustix::net::SocketFlags::CLOEXEC"><code>SocketFlags::CLOEXEC</code></a> or
|
||
<a href="struct.SocketFlags.html#associatedconstant.NONBLOCK" title="associated constant rustix::net::SocketFlags::NONBLOCK"><code>SocketFlags::NONBLOCK</code></a>, use <a href="fn.socket_with.html" title="fn rustix::net::socket_with"><code>socket_with</code></a>.</p>
|
||
<h2 id="references"><a class="doc-anchor" href="#references">§</a>References</h2>
|
||
<ul>
|
||
<li><a href="https://beej.us/guide/bgnet/html/split/system-calls-or-bust.html#socket">Beej’s Guide to Network Programming</a></li>
|
||
<li><a href="https://pubs.opengroup.org/onlinepubs/9799919799/functions/socket.html">POSIX</a></li>
|
||
<li><a href="https://man7.org/linux/man-pages/man2/socket.2.html">Linux</a></li>
|
||
<li><a href="https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/socket.2.html">Apple</a></li>
|
||
<li><a href="https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-socket">Winsock</a></li>
|
||
<li><a href="https://man.freebsd.org/cgi/man.cgi?query=socket&sektion=2">FreeBSD</a></li>
|
||
<li><a href="https://man.netbsd.org/socket.2">NetBSD</a></li>
|
||
<li><a href="https://man.openbsd.org/socket.2">OpenBSD</a></li>
|
||
<li><a href="https://man.dragonflybsd.org/?command=socket&section=2">DragonFly BSD</a></li>
|
||
<li><a href="https://illumos.org/man/3SOCKET/socket">illumos</a></li>
|
||
<li><a href="https://www.gnu.org/software/libc/manual/html_node/Creating-a-Socket.html">glibc</a></li>
|
||
</ul>
|
||
</div></details></section></div></main></body></html> |