blob: 262b19c24c6b8c2aa304677ec7849a2bc71ed7c7 [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 Source File</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="headertitle">
<div class="title">socket_utils_posix.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="socket__utils__posix_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * Copyright 2015, Google Inc.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * All rights reserved.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * Redistribution and use in source and binary forms, with or without</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * modification, are permitted provided that the following conditions are</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * met:</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * * Redistributions of source code must retain the above copyright</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * notice, this list of conditions and the following disclaimer.</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * * Redistributions in binary form must reproduce the above</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * copyright notice, this list of conditions and the following disclaimer</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * in the documentation and/or other materials provided with the</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * distribution.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * * Neither the name of Google Inc. nor the names of its</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * contributors may be used to endorse or promote products derived from</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> * this software without specific prior written permission.</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"> * &quot;AS IS&quot; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment"> * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment"> * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment"> * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment"> * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment"> * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment"> * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment"> * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment"> * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment"> * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#ifndef GRPC_INTERNAL_CORE_IOMGR_SOCKET_UTILS_POSIX_H</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define GRPC_INTERNAL_CORE_IOMGR_SOCKET_UTILS_POSIX_H</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#include &lt;unistd.h&gt;</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="preprocessor">#include &lt;sys/socket.h&gt;</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment">/* a wrapper for accept or accept4 */</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="keywordtype">int</span> <a class="code" href="socket__utils__posix_8h.html#a2f6d1c5f46dff8ac86a5e4df24641060">grpc_accept4</a>(<span class="keywordtype">int</span> sockfd, <span class="keyword">struct</span> sockaddr *addr, socklen_t *addrlen,</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordtype">int</span> nonblock, <span class="keywordtype">int</span> cloexec);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="comment">/* set a socket to non blocking mode */</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="keywordtype">int</span> <a class="code" href="socket__utils__posix_8h.html#a8f191a668efd979070217eb455a399d5">grpc_set_socket_nonblocking</a>(<span class="keywordtype">int</span> fd, <span class="keywordtype">int</span> non_blocking);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="comment">/* set a socket to close on exec */</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="keywordtype">int</span> <a class="code" href="socket__utils__posix_8h.html#af2c563af7608d53fa639f9ed9c5f1027">grpc_set_socket_cloexec</a>(<span class="keywordtype">int</span> fd, <span class="keywordtype">int</span> close_on_exec);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="comment">/* set a socket to reuse old addresses */</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="keywordtype">int</span> <a class="code" href="socket__utils__posix_8h.html#afe2ba4baab80f7f0b1aea9bd8718ac79">grpc_set_socket_reuse_addr</a>(<span class="keywordtype">int</span> fd, <span class="keywordtype">int</span> reuse);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="comment">/* disable nagle */</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="keywordtype">int</span> <a class="code" href="socket__utils__posix_8h.html#a4a66ec0552261b5c623b2e7b718fba00">grpc_set_socket_low_latency</a>(<span class="keywordtype">int</span> fd, <span class="keywordtype">int</span> low_latency);</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="comment">/* Returns true if this system can create AF_INET6 sockets bound to ::1.</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="comment"> The value is probed once, and cached for the life of the process.</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="comment"> This is more restrictive than checking for socket(AF_INET6) to succeed,</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="comment"> because Linux with &quot;net.ipv6.conf.all.disable_ipv6 = 1&quot; is able to create</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="comment"> and bind IPv6 sockets, but cannot connect to a getsockname() of [::]:port</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="comment"> without a valid loopback interface. Rather than expose this half-broken</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="comment"> state to library users, we turn off IPv6 sockets. */</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="keywordtype">int</span> <a class="code" href="socket__utils__posix_8h.html#ad76fb0120a38b881723d537d95a51563">grpc_ipv6_loopback_available</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="comment">/* Tries to set SO_NOSIGPIPE if available on this platform.</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;<span class="comment"> Returns 1 on success, 0 on failure.</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="comment"> If SO_NO_SIGPIPE is not available, returns 1. */</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="keywordtype">int</span> <a class="code" href="socket__utils__posix_8h.html#a520ffc5e1545446aea9653814d6c0581">grpc_set_socket_no_sigpipe_if_possible</a>(<span class="keywordtype">int</span> fd);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="comment">/* An enum to keep track of IPv4/IPv6 socket modes.</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="comment"> Currently, this information is only used when a socket is first created, but</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<span class="comment"> in the future we may wish to store it alongside the fd. This would let calls</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;<span class="comment"> like sendto() know which family to use without asking the kernel first. */</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="socket__utils__posix_8h.html#a00b8257ab3e474c4f3d666247d620264"> 76</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code" href="socket__utils__posix_8h.html#a00b8257ab3e474c4f3d666247d620264">grpc_dualstack_mode</a> {</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="comment">/* Uninitialized, or a non-IP socket. */</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="socket__utils__posix_8h.html#a00b8257ab3e474c4f3d666247d620264acd35a16d524d042d1d50f45a8efef858"> 78</a></span>&#160; <a class="code" href="socket__utils__posix_8h.html#a00b8257ab3e474c4f3d666247d620264acd35a16d524d042d1d50f45a8efef858">GRPC_DSMODE_NONE</a>,</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="comment">/* AF_INET only. */</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="socket__utils__posix_8h.html#a00b8257ab3e474c4f3d666247d620264a31d1572a5d2b690fe43d9a6fe31c43a8"> 80</a></span>&#160; <a class="code" href="socket__utils__posix_8h.html#a00b8257ab3e474c4f3d666247d620264a31d1572a5d2b690fe43d9a6fe31c43a8">GRPC_DSMODE_IPV4</a>,</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="comment">/* AF_INET6 only, because IPV6_V6ONLY could not be cleared. */</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="socket__utils__posix_8h.html#a00b8257ab3e474c4f3d666247d620264a036d6fe4d6f305566426a235921e56c3"> 82</a></span>&#160; <a class="code" href="socket__utils__posix_8h.html#a00b8257ab3e474c4f3d666247d620264a036d6fe4d6f305566426a235921e56c3">GRPC_DSMODE_IPV6</a>,</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="comment">/* AF_INET6, which also supports ::ffff-mapped IPv4 addresses. */</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="socket__utils__posix_8h.html#a00b8257ab3e474c4f3d666247d620264a20fcdfb82918427f5e57b463db30c635"> 84</a></span>&#160; <a class="code" href="socket__utils__posix_8h.html#a00b8257ab3e474c4f3d666247d620264a20fcdfb82918427f5e57b463db30c635">GRPC_DSMODE_DUALSTACK</a></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;} <a class="code" href="socket__utils__posix_8h.html#a00b8257ab3e474c4f3d666247d620264">grpc_dualstack_mode</a>;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<span class="comment">/* Only tests should use this flag. */</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="socket__utils__posix_8h.html#a593bec0bced7e30f2c1ac059b5188757">grpc_forbid_dualstack_sockets_for_testing</a>;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;<span class="comment">/* Creates a new socket for connecting to (or listening on) an address.</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;<span class="comment"> If addr is AF_INET6, this creates an IPv6 socket first. If that fails,</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;<span class="comment"> and addr is within ::ffff:0.0.0.0/96, then it automatically falls back to</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;<span class="comment"> an IPv4 socket.</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;<span class="comment"> If addr is AF_INET, AF_UNIX, or anything else, then this is similar to</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;<span class="comment"> calling socket() directly.</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;<span class="comment"> Returns an fd on success, otherwise returns -1 with errno set to the result</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;<span class="comment"> of a failed socket() call.</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;<span class="comment"> The *dsmode output indicates which address family was actually created.</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;<span class="comment"> The recommended way to use this is:</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;<span class="comment"> - First convert to IPv6 using grpc_sockaddr_to_v4mapped().</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;<span class="comment"> - Create the socket.</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;<span class="comment"> - If *dsmode is IPV4, use grpc_sockaddr_is_v4mapped() to convert back to</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;<span class="comment"> IPv4, so that bind() or connect() see the correct family.</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;<span class="comment"> Also, it&#39;s important to distinguish between DUALSTACK and IPV6 when</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;<span class="comment"> listening on the [::] wildcard address. */</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;<span class="keywordtype">int</span> <a class="code" href="socket__utils__posix_8h.html#a76dcb8f351a790f2f3dc6f857f1df6f6">grpc_create_dualstack_socket</a>(<span class="keyword">const</span> <span class="keyword">struct</span> sockaddr *addr, <span class="keywordtype">int</span> type,</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="keywordtype">int</span> protocol, <a class="code" href="socket__utils__posix_8h.html#a00b8257ab3e474c4f3d666247d620264">grpc_dualstack_mode</a> *dsmode);</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* GRPC_INTERNAL_CORE_IOMGR_SOCKET_UTILS_POSIX_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="socket__utils__posix_8h_html_a2f6d1c5f46dff8ac86a5e4df24641060"><div class="ttname"><a href="socket__utils__posix_8h.html#a2f6d1c5f46dff8ac86a5e4df24641060">grpc_accept4</a></div><div class="ttdeci">int grpc_accept4(int sockfd, struct sockaddr *addr, socklen_t *addrlen, int nonblock, int cloexec)</div></div>
<div class="ttc" id="socket__utils__posix_8h_html_a00b8257ab3e474c4f3d666247d620264"><div class="ttname"><a href="socket__utils__posix_8h.html#a00b8257ab3e474c4f3d666247d620264">grpc_dualstack_mode</a></div><div class="ttdeci">grpc_dualstack_mode</div><div class="ttdef"><b>Definition:</b> socket_utils_posix.h:76</div></div>
<div class="ttc" id="socket__utils__posix_8h_html_afe2ba4baab80f7f0b1aea9bd8718ac79"><div class="ttname"><a href="socket__utils__posix_8h.html#afe2ba4baab80f7f0b1aea9bd8718ac79">grpc_set_socket_reuse_addr</a></div><div class="ttdeci">int grpc_set_socket_reuse_addr(int fd, int reuse)</div></div>
<div class="ttc" id="socket__utils__posix_8h_html_ad76fb0120a38b881723d537d95a51563"><div class="ttname"><a href="socket__utils__posix_8h.html#ad76fb0120a38b881723d537d95a51563">grpc_ipv6_loopback_available</a></div><div class="ttdeci">int grpc_ipv6_loopback_available(void)</div></div>
<div class="ttc" id="socket__utils__posix_8h_html_a00b8257ab3e474c4f3d666247d620264a036d6fe4d6f305566426a235921e56c3"><div class="ttname"><a href="socket__utils__posix_8h.html#a00b8257ab3e474c4f3d666247d620264a036d6fe4d6f305566426a235921e56c3">GRPC_DSMODE_IPV6</a></div><div class="ttdef"><b>Definition:</b> socket_utils_posix.h:82</div></div>
<div class="ttc" id="socket__utils__posix_8h_html_a4a66ec0552261b5c623b2e7b718fba00"><div class="ttname"><a href="socket__utils__posix_8h.html#a4a66ec0552261b5c623b2e7b718fba00">grpc_set_socket_low_latency</a></div><div class="ttdeci">int grpc_set_socket_low_latency(int fd, int low_latency)</div></div>
<div class="ttc" id="socket__utils__posix_8h_html_af2c563af7608d53fa639f9ed9c5f1027"><div class="ttname"><a href="socket__utils__posix_8h.html#af2c563af7608d53fa639f9ed9c5f1027">grpc_set_socket_cloexec</a></div><div class="ttdeci">int grpc_set_socket_cloexec(int fd, int close_on_exec)</div></div>
<div class="ttc" id="socket__utils__posix_8h_html_a593bec0bced7e30f2c1ac059b5188757"><div class="ttname"><a href="socket__utils__posix_8h.html#a593bec0bced7e30f2c1ac059b5188757">grpc_forbid_dualstack_sockets_for_testing</a></div><div class="ttdeci">int grpc_forbid_dualstack_sockets_for_testing</div></div>
<div class="ttc" id="socket__utils__posix_8h_html_a00b8257ab3e474c4f3d666247d620264a31d1572a5d2b690fe43d9a6fe31c43a8"><div class="ttname"><a href="socket__utils__posix_8h.html#a00b8257ab3e474c4f3d666247d620264a31d1572a5d2b690fe43d9a6fe31c43a8">GRPC_DSMODE_IPV4</a></div><div class="ttdef"><b>Definition:</b> socket_utils_posix.h:80</div></div>
<div class="ttc" id="socket__utils__posix_8h_html_a520ffc5e1545446aea9653814d6c0581"><div class="ttname"><a href="socket__utils__posix_8h.html#a520ffc5e1545446aea9653814d6c0581">grpc_set_socket_no_sigpipe_if_possible</a></div><div class="ttdeci">int grpc_set_socket_no_sigpipe_if_possible(int fd)</div></div>
<div class="ttc" id="socket__utils__posix_8h_html_a8f191a668efd979070217eb455a399d5"><div class="ttname"><a href="socket__utils__posix_8h.html#a8f191a668efd979070217eb455a399d5">grpc_set_socket_nonblocking</a></div><div class="ttdeci">int grpc_set_socket_nonblocking(int fd, int non_blocking)</div></div>
<div class="ttc" id="socket__utils__posix_8h_html_a00b8257ab3e474c4f3d666247d620264a20fcdfb82918427f5e57b463db30c635"><div class="ttname"><a href="socket__utils__posix_8h.html#a00b8257ab3e474c4f3d666247d620264a20fcdfb82918427f5e57b463db30c635">GRPC_DSMODE_DUALSTACK</a></div><div class="ttdef"><b>Definition:</b> socket_utils_posix.h:84</div></div>
<div class="ttc" id="socket__utils__posix_8h_html_a00b8257ab3e474c4f3d666247d620264acd35a16d524d042d1d50f45a8efef858"><div class="ttname"><a href="socket__utils__posix_8h.html#a00b8257ab3e474c4f3d666247d620264acd35a16d524d042d1d50f45a8efef858">GRPC_DSMODE_NONE</a></div><div class="ttdef"><b>Definition:</b> socket_utils_posix.h:78</div></div>
<div class="ttc" id="socket__utils__posix_8h_html_a76dcb8f351a790f2f3dc6f857f1df6f6"><div class="ttname"><a href="socket__utils__posix_8h.html#a76dcb8f351a790f2f3dc6f857f1df6f6">grpc_create_dualstack_socket</a></div><div class="ttdeci">int grpc_create_dualstack_socket(const struct sockaddr *addr, int type, int protocol, grpc_dualstack_mode *dsmode)</div></div>
</div><!-- fragment --></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>