<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
<meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara">
<title>Nine Nines: ranch_tcp(3)</title>
<link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'>
<link href="/css/99s.css?r=7" rel="stylesheet">
<link rel="shortcut icon" href="/img/ico/favicon.ico">
<link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png">
<link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png">
<link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png">
</head>
<body class="">
<header id="page-head">
<div id="topbar" class="container">
<div class="row">
<div class="span2">
<h1 id="logo"><a href="/" title="99s">99s</a></h1>
</div>
<div class="span10">
<div id="side-header">
<nav>
<ul>
<li><a title="Hear my thoughts" href="/articles">Articles</a></li>
<li><a title="Watch my talks" href="/talks">Talks</a></li>
<li class="active"><a title="Read the docs" href="/docs">Documentation</a></li>
<li><a title="Request my services" href="/services">Consulting & Training</a></li>
</ul>
</nav>
<ul id="social">
<li>
<a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a>
</li>
<li>
<a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a>
</li>
</ul>
</div>
</div>
</div>
</div>
</header>
<div id="contents" class="two_col">
<div class="container">
<div class="row">
<div id="docs" class="span9 maincol">
<h1 class="lined-header"><span>ranch_tcp(3)</span></h1>
<h2 id="_name">Name</h2>
<p>ranch_tcp - TCP transport</p>
<h2 id="_description">Description</h2>
<p>The module <code>ranch_tcp</code> implements a TCP Ranch transport.</p>
<p>The function <code>sendfile</code> may not work correctly when used against files stored in a VirtualBox shared folder.</p>
<h2 id="_exports">Exports</h2>
<p>The module <code>ranch_tcp</code> implements the interface defined by <a href="../ranch_transport">ranch_transport(3)</a>.</p>
<h2 id="_types">Types</h2>
<h3 id="_opt">opt()</h3>
<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><b><font color="#000000">opt</font></b>() <font color="#990000">=</font> {<font color="#FF6600">backlog</font>, <b><font color="#000000">non_neg_integer</font></b>()}
| {<font color="#FF6600">buffer</font>, <b><font color="#000000">non_neg_integer</font></b>()}
| {<font color="#FF6600">delay_send</font>, <b><font color="#000000">boolean</font></b>()}
| {<font color="#FF6600">dontroute</font>, <b><font color="#000000">boolean</font></b>()}
| {<font color="#FF6600">exit_on_close</font>, <b><font color="#000000">boolean</font></b>()}
| {<font color="#FF6600">fd</font>, <b><font color="#000000">non_neg_integer</font></b>()}
| {<font color="#FF6600">high_msgq_watermark</font>, <b><font color="#000000">non_neg_integer</font></b>()}
| {<font color="#FF6600">high_watermark</font>, <b><font color="#000000">non_neg_integer</font></b>()}
| <font color="#FF6600">inet</font>
| <font color="#FF6600">inet6</font>
| {<font color="#FF6600">ip</font>, <b><font color="#000000">inet:ip_address</font></b>() | <b><font color="#000000">inet:local_address</font></b>()}
| {<font color="#FF6600">ipv6_v6only</font>, <b><font color="#000000">boolean</font></b>()}
| {<font color="#FF6600">keepalive</font>, <b><font color="#000000">boolean</font></b>()}
| {<font color="#FF6600">linger</font>, {<b><font color="#000000">boolean</font></b>(), <b><font color="#000000">non_neg_integer</font></b>()}}
| {<font color="#FF6600">low_msgq_watermark</font>, <b><font color="#000000">non_neg_integer</font></b>()}
| {<font color="#FF6600">low_watermark</font>, <b><font color="#000000">non_neg_integer</font></b>()}
| {<font color="#FF6600">nodelay</font>, <b><font color="#000000">boolean</font></b>()}
| {<font color="#FF6600">port</font>, <b><font color="#000000">inet:port_number</font></b>()}
| {<b><font color="#000080">priority</font></b>, <b><font color="#000080">integer</font></b>()}
| {<font color="#FF6600">raw</font>, <b><font color="#000000">non_neg_integer</font></b>(), <b><font color="#000000">non_neg_integer</font></b>(), <b><font color="#000080">binary</font></b>()}
| {<font color="#FF6600">recbuf</font>, <b><font color="#000000">non_neg_integer</font></b>()}
| {<font color="#FF6600">send_timeout</font>, <b><font color="#000000">timeout</font></b>()}
| {<font color="#FF6600">send_timeout_close</font>, <b><font color="#000000">boolean</font></b>()}
| {<font color="#FF6600">sndbuf</font>, <b><font color="#000000">non_neg_integer</font></b>()}
| {<font color="#FF6600">tos</font>, <b><font color="#000080">integer</font></b>()}</tt></pre>
</div></div>
<p>Listen options.</p>
<p>Note that additional options may be set by the protocol module using <code>Transport:setopts/2</code>.</p>
<p>None of the options are required.</p>
<p>Please consult the <code>gen_tcp</code> and <code>inet</code> manuals for a more thorough description of these options. This manual only aims to provide a short description along with what the defaults are. Defaults may be different in Ranch compared to <code>gen_tcp</code>. Defaults are given next to the option name:</p>
<dl><dt>backlog (1024)</dt>
<dd><p>Max length of the queue of pending connections.</p>
</dd>
<dt>buffer</dt>
<dd><p>Size of the buffer used by the Erlang driver. Default is system-dependent.</p>
</dd>
<dt>delay_send (false)</dt>
<dd><p>Always queue data before sending, to send fewer, larger packets over the network.</p>
</dd>
<dt>dontroute (false)</dt>
<dd><p>Don't send via a gateway, only send to directly connected hosts.</p>
</dd>
<dt>exit_on_close (true)</dt>
<dd><p>Disable to allow sending data after a close has been detected.</p>
</dd>
<dt>fd</dt>
<dd><p>File descriptor of the socket, if it was opened externally.</p>
</dd>
<dt>high_msgq_watermark (8192)</dt>
<dd><p>Limit in the amount of data in the socket message queue before the queue becomes busy.</p>
</dd>
<dt>high_watermark (8192)</dt>
<dd><p>Limit in the amount of data in the ERTS socket implementation's queue before the socket becomes busy.</p>
</dd>
<dt>inet</dt>
<dd><p>Set up the socket for IPv4.</p>
</dd>
<dt>inet6</dt>
<dd><p>Set up the socket for IPv6.</p>
</dd>
<dt>ip</dt>
<dd><p>Interface to listen on. Listen on all network interfaces by default.</p>
</dd>
</dl>
<p>On UNIX systems, it is also possible to use a UNIX Domain socket file by specifying <code>{local, SocketFile}</code>.</p>
<dl><dt>ipv6_v6only (false)</dt>
<dd><p>Listen on IPv4 and IPv6 (false) or only on IPv6 (true). Use with inet6.</p>
</dd>
<dt>keepalive (false)</dt>
<dd><p>Enable sending of keep-alive messages.</p>
</dd>
<dt>linger ({false, 0})</dt>
<dd><p>Whether to wait and how long to flush data sent before closing the socket.</p>
</dd>
<dt>low_msgq_watermark (4096)</dt>
<dd><p>Amount of data in the socket message queue before the queue leaves busy state.</p>
</dd>
<dt>low_watermark (4096)</dt>
<dd><p>Amount of data in the ERTS socket implementation's queue before the socket leaves busy state.</p>
</dd>
<dt>nodelay (true)</dt>
<dd><p>Whether to enable TCP_NODELAY.</p>
</dd>
<dt>port (0)</dt>
<dd><p>TCP port number to listen on. 0 means a random port will be used.</p>
</dd>
<dt>priority (0)</dt>
<dd><p>Priority value for all packets to be sent on this socket.</p>
</dd>
<dt>recbuf</dt>
<dd><p>Minimum size of the socket's receive buffer. Default is system-dependent.</p>
</dd>
<dt>send_timeout (30000)</dt>
<dd><p>How long the send call may wait for confirmation before returning.</p>
</dd>
<dt>send_timeout_close (true)</dt>
<dd><p>Whether to close the socket when the confirmation wasn't received.</p>
</dd>
<dt>sndbuf</dt>
<dd><p>Minimum size of the socket's send buffer. Default is system-dependent.</p>
</dd>
<dt>tos</dt>
<dd><p>Value for the IP_TOS IP level option. Use with caution.</p>
</dd>
</dl>
<p>In addition, the <code>raw</code> option can be used to set system-specific options by specifying the protocol level, the option number and the actual option value specified as a binary. This option is not portable. Use with caution.</p>
<h3 id="_opts">opts()</h3>
<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><b><font color="#000000">opts</font></b>() <font color="#990000">::</font> [<b><font color="#000000">opt</font></b>()]</tt></pre>
</div></div>
<p>List of listen options.</p>
<h2 id="_see_also">See also</h2>
<p><a href="..">ranch(7)</a>, <a href="../ranch_transport">ranch_transport(3)</a>, <a href="../ranch_ssl">ranch_ssl(3)</a>, gen_tcp(3), inet(3)</p>
</div>
<div class="span3 sidecol">
<h3>
Ranch
2.0
Function Reference
</h3>
<ul>
<li><a href="/docs/en/ranch/2.0/guide">User Guide</a></li>
<li><a href="/docs/en/ranch/2.0/manual">Function Reference</a></li>
</ul>
<h4 id="docs-nav">Navigation</h4>
<h4>Version select</h4>
<ul>
<li><a href="/docs/en/ranch/2.0/manual">2.0</a></li>
<li><a href="/docs/en/ranch/1.8/manual">1.8</a></li>
<li><a href="/docs/en/ranch/1.7/manual">1.7</a></li>
<li><a href="/docs/en/ranch/1.6/manual">1.6</a></li>
<li><a href="/docs/en/ranch/1.5/manual">1.5</a></li>
</ul>
<h3 id="_like_my_work__donate">Like my work? Donate!</h3>
<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p>
<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline">
<input type="hidden" name="cmd" value="_donations">
<input type="hidden" name="business" value="[email protected]">
<input type="hidden" name="lc" value="FR">
<input type="hidden" name="item_name" value="Loic Hoguin">
<input type="hidden" name="item_number" value="99s">
<input type="hidden" name="currency_code" value="EUR">
<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted">
<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!">
<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1">
</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="container">
<div class="row">
<div class="span6">
<p id="scroll-top"><a href="#">↑ Scroll to top</a></p>
<nav>
<ul>
<li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li>
</ul>
</nav>
</div>
<div class="span6 credits">
<p><img src="/img/footer_logo.png"></p>
<p>Copyright © Loïc Hoguin 2012-2018</p>
</div>
</div>
</div>
</footer>
<script src="/js/custom.js"></script>
</body>
</html>
