blob: 88e099bd7d992fe32dc2e57e0e8c9ae24b73faac [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>GRPC Core: src/core/iomgr/socket_utils_posix.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GRPC Core
&#160;<span id="projectnumber">0.10.0.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_aebb8dcc11953d78e620bbef0b9e2183.html">core</a></li><li class="navelem"><a class="el" href="dir_3f1a464cbd6442b4d6b6ee306c9b0460.html">iomgr</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">socket_utils_posix.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;unistd.h&gt;</code><br/>
<code>#include &lt;sys/socket.h&gt;</code><br/>
</div>
<p><a href="socket__utils__posix_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a0d07cbe9b082267d5436905dedf86b91"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="socket__utils__posix_8h.html#a00b8257ab3e474c4f3d666247d620264">grpc_dualstack_mode</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="socket__utils__posix_8h.html#a0d07cbe9b082267d5436905dedf86b91">grpc_dualstack_mode</a></td></tr>
<tr class="separator:a0d07cbe9b082267d5436905dedf86b91"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a00b8257ab3e474c4f3d666247d620264"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="socket__utils__posix_8h.html#a00b8257ab3e474c4f3d666247d620264">grpc_dualstack_mode</a> { <a class="el" href="socket__utils__posix_8h.html#a00b8257ab3e474c4f3d666247d620264acd35a16d524d042d1d50f45a8efef858">GRPC_DSMODE_NONE</a>,
<a class="el" href="socket__utils__posix_8h.html#a00b8257ab3e474c4f3d666247d620264a31d1572a5d2b690fe43d9a6fe31c43a8">GRPC_DSMODE_IPV4</a>,
<a class="el" href="socket__utils__posix_8h.html#a00b8257ab3e474c4f3d666247d620264a036d6fe4d6f305566426a235921e56c3">GRPC_DSMODE_IPV6</a>,
<a class="el" href="socket__utils__posix_8h.html#a00b8257ab3e474c4f3d666247d620264a20fcdfb82918427f5e57b463db30c635">GRPC_DSMODE_DUALSTACK</a>
}</td></tr>
<tr class="separator:a00b8257ab3e474c4f3d666247d620264"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a2f6d1c5f46dff8ac86a5e4df24641060"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="socket__utils__posix_8h.html#a2f6d1c5f46dff8ac86a5e4df24641060">grpc_accept4</a> (int sockfd, struct sockaddr *addr, socklen_t *addrlen, int nonblock, int cloexec)</td></tr>
<tr class="separator:a2f6d1c5f46dff8ac86a5e4df24641060"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f191a668efd979070217eb455a399d5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="socket__utils__posix_8h.html#a8f191a668efd979070217eb455a399d5">grpc_set_socket_nonblocking</a> (int fd, int non_blocking)</td></tr>
<tr class="separator:a8f191a668efd979070217eb455a399d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2c563af7608d53fa639f9ed9c5f1027"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="socket__utils__posix_8h.html#af2c563af7608d53fa639f9ed9c5f1027">grpc_set_socket_cloexec</a> (int fd, int close_on_exec)</td></tr>
<tr class="separator:af2c563af7608d53fa639f9ed9c5f1027"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe2ba4baab80f7f0b1aea9bd8718ac79"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="socket__utils__posix_8h.html#afe2ba4baab80f7f0b1aea9bd8718ac79">grpc_set_socket_reuse_addr</a> (int fd, int reuse)</td></tr>
<tr class="separator:afe2ba4baab80f7f0b1aea9bd8718ac79"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a66ec0552261b5c623b2e7b718fba00"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="socket__utils__posix_8h.html#a4a66ec0552261b5c623b2e7b718fba00">grpc_set_socket_low_latency</a> (int fd, int low_latency)</td></tr>
<tr class="separator:a4a66ec0552261b5c623b2e7b718fba00"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad76fb0120a38b881723d537d95a51563"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="socket__utils__posix_8h.html#ad76fb0120a38b881723d537d95a51563">grpc_ipv6_loopback_available</a> (void)</td></tr>
<tr class="separator:ad76fb0120a38b881723d537d95a51563"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a520ffc5e1545446aea9653814d6c0581"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="socket__utils__posix_8h.html#a520ffc5e1545446aea9653814d6c0581">grpc_set_socket_no_sigpipe_if_possible</a> (int fd)</td></tr>
<tr class="separator:a520ffc5e1545446aea9653814d6c0581"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a76dcb8f351a790f2f3dc6f857f1df6f6"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="socket__utils__posix_8h.html#a76dcb8f351a790f2f3dc6f857f1df6f6">grpc_create_dualstack_socket</a> (const struct sockaddr *addr, int type, int protocol, <a class="el" href="socket__utils__posix_8h.html#a00b8257ab3e474c4f3d666247d620264">grpc_dualstack_mode</a> *dsmode)</td></tr>
<tr class="separator:a76dcb8f351a790f2f3dc6f857f1df6f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a593bec0bced7e30f2c1ac059b5188757"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="socket__utils__posix_8h.html#a593bec0bced7e30f2c1ac059b5188757">grpc_forbid_dualstack_sockets_for_testing</a></td></tr>
<tr class="separator:a593bec0bced7e30f2c1ac059b5188757"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="a0d07cbe9b082267d5436905dedf86b91"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="socket__utils__posix_8h.html#a00b8257ab3e474c4f3d666247d620264">grpc_dualstack_mode</a> <a class="el" href="socket__utils__posix_8h.html#a00b8257ab3e474c4f3d666247d620264">grpc_dualstack_mode</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="a00b8257ab3e474c4f3d666247d620264"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="socket__utils__posix_8h.html#a00b8257ab3e474c4f3d666247d620264">grpc_dualstack_mode</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a00b8257ab3e474c4f3d666247d620264acd35a16d524d042d1d50f45a8efef858"></a>GRPC_DSMODE_NONE</em>&#160;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a00b8257ab3e474c4f3d666247d620264a31d1572a5d2b690fe43d9a6fe31c43a8"></a>GRPC_DSMODE_IPV4</em>&#160;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a00b8257ab3e474c4f3d666247d620264a036d6fe4d6f305566426a235921e56c3"></a>GRPC_DSMODE_IPV6</em>&#160;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a00b8257ab3e474c4f3d666247d620264a20fcdfb82918427f5e57b463db30c635"></a>GRPC_DSMODE_DUALSTACK</em>&#160;</td><td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a2f6d1c5f46dff8ac86a5e4df24641060"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int grpc_accept4 </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>sockfd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct sockaddr *&#160;</td>
<td class="paramname"><em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">socklen_t *&#160;</td>
<td class="paramname"><em>addrlen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>nonblock</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>cloexec</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a76dcb8f351a790f2f3dc6f857f1df6f6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int grpc_create_dualstack_socket </td>
<td>(</td>
<td class="paramtype">const struct sockaddr *&#160;</td>
<td class="paramname"><em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>protocol</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="socket__utils__posix_8h.html#a00b8257ab3e474c4f3d666247d620264">grpc_dualstack_mode</a> *&#160;</td>
<td class="paramname"><em>dsmode</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ad76fb0120a38b881723d537d95a51563"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int grpc_ipv6_loopback_available </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="af2c563af7608d53fa639f9ed9c5f1027"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int grpc_set_socket_cloexec </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>close_on_exec</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a4a66ec0552261b5c623b2e7b718fba00"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int grpc_set_socket_low_latency </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>low_latency</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a520ffc5e1545446aea9653814d6c0581"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int grpc_set_socket_no_sigpipe_if_possible </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>fd</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a8f191a668efd979070217eb455a399d5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int grpc_set_socket_nonblocking </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>non_blocking</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="afe2ba4baab80f7f0b1aea9bd8718ac79"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int grpc_set_socket_reuse_addr </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>reuse</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a class="anchor" id="a593bec0bced7e30f2c1ac059b5188757"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int grpc_forbid_dualstack_sockets_for_testing</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Aug 5 2015 08:17:07 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>