blob: 6bc63a8457e60271af9585f7fe4ca237aba7036f [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.5"/>
<title>Apache Mesos: 3rdparty/stout/include/stout/os/posix/socket.hpp 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="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">Apache Mesos
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></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>File&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_8cab8f464681f7cc51cee77e79a434cd.html">3rdparty</a></li><li class="navelem"><a class="el" href="dir_aa547de1d719d14adccfca1dfb1735b3.html">stout</a></li><li class="navelem"><a class="el" href="dir_1a1b923d951dd999d43396870333fc33.html">include</a></li><li class="navelem"><a class="el" href="dir_dbd52553d038069c1ed93e3477ea333d.html">stout</a></li><li class="navelem"><a class="el" href="dir_27832e6c74c2ee170d1dd05a196f816c.html">os</a></li><li class="navelem"><a class="el" href="dir_9a6d2c82450779b96177e4cabddb051e.html">posix</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">socket.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="stout_2include_2stout_2os_2posix_2socket_8hpp.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">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// you may not use this file except in compliance with the License.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// limitations under the License.</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#ifndef __STOUT_OS_POSIX_SOCKET_HPP__</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define __STOUT_OS_POSIX_SOCKET_HPP__</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &lt;errno.h&gt;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &lt;unistd.h&gt;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &lt;sys/socket.h&gt;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;sys/stat.h&gt;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="keyword">namespace </span>net {</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment">// Import `socket` functions into `net::` namespace.</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<a class="code" href="namespaceprocess_1_1network.html#aa05dd9eea0c1e4d3d49e2fc049c1a446">using ::accept</a>;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<a class="code" href="namespaceprocess_1_1network.html#ad067110a4b38cc83785a43f49bf6c8e2">using ::bind</a>;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<a class="code" href="namespaceprocess_1_1http.html#a54e53c8006298fe99e3fb5f55c0e8c41">using ::connect</a>;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<a class="code" href="namespacenet.html#a5b5c23ac2d0fa4ccaedff024f2d9a32c">using ::recv</a>;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<a class="code" href="namespacenet.html#a69f77aa4677f1dd1c69169589b30a31b">using ::send</a>;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment">// The error indicates the last socket operation has been</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment">// interupted, the operation can be restarted imediately.</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="namespacenet.html#a190d273d305decda6696ed04b3adbd59"> 33</a></span>&#160;<span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="namespacenet.html#a190d273d305decda6696ed04b3adbd59">is_restartable_error</a>(<span class="keywordtype">int</span> <a class="code" href="namespacemesos_1_1internal_1_1slave_1_1cni_1_1spec.html#ae58e703656ab4a1bd5d9870441236727">error</a>)</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;{</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordflow">return</span> (error == EINTR);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;}</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment">// The error indicates the last socket function on a non-blocking socket</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment">// cannot be completed. This is a temporary condition and the caller can</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="comment">// retry the operation later.</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="namespacenet.html#a750f9463500ec714c5d5db550340a772"> 42</a></span>&#160;<span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="namespacenet.html#a750f9463500ec714c5d5db550340a772">is_retryable_error</a>(<span class="keywordtype">int</span> <a class="code" href="namespacemesos_1_1internal_1_1slave_1_1cni_1_1spec.html#ae58e703656ab4a1bd5d9870441236727">error</a>)</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="keywordflow">return</span> (error == EWOULDBLOCK || error == EAGAIN);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;}</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;</div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="namespacenet.html#a6d996e15b39630257af8d8a0379c7f7a"> 48</a></span>&#160;<span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="namespacenet.html#a6d996e15b39630257af8d8a0379c7f7a">is_inprogress_error</a>(<span class="keywordtype">int</span> <a class="code" href="namespacemesos_1_1internal_1_1slave_1_1cni_1_1spec.html#ae58e703656ab4a1bd5d9870441236727">error</a>)</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="keywordflow">return</span> (error == EINPROGRESS);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;}</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;</div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="namespacenet.html#a55b1d2f6617c801b8c5c54dfc8ad2036"> 54</a></span>&#160;<span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="namespacenet.html#a55b1d2f6617c801b8c5c54dfc8ad2036">is_socket</a>(<span class="keywordtype">int</span> fd)</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="keyword">struct </span><a class="code" href="namespacecgroups.html#a78e3c7ca2e422779908eec45f859d757">stat</a> statbuf;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordflow">if</span> (::fstat(fd, &amp;statbuf) &lt; 0) {</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; }</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keywordflow">return</span> <a class="code" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#a953b4d8769906f7afe486c0ee0955fd3">S_ISSOCK</a>(statbuf.st_mode) != 0;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;}</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;} <span class="comment">// namespace net {</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="preprocessor">#endif // __STOUT_OS_POSIX_SOCKET_HPP__</span></div>
<div class="ttc" id="namespacenet_html_a55b1d2f6617c801b8c5c54dfc8ad2036"><div class="ttname"><a href="namespacenet.html#a55b1d2f6617c801b8c5c54dfc8ad2036">net::is_socket</a></div><div class="ttdeci">bool is_socket(int fd)</div><div class="ttdef"><b>Definition:</b> socket.hpp:54</div></div>
<div class="ttc" id="namespacenet_html_a6d996e15b39630257af8d8a0379c7f7a"><div class="ttname"><a href="namespacenet.html#a6d996e15b39630257af8d8a0379c7f7a">net::is_inprogress_error</a></div><div class="ttdeci">bool is_inprogress_error(int error)</div><div class="ttdef"><b>Definition:</b> socket.hpp:48</div></div>
<div class="ttc" id="3rdparty_2stout_2include_2stout_2windows_8hpp_html_a953b4d8769906f7afe486c0ee0955fd3"><div class="ttname"><a href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#a953b4d8769906f7afe486c0ee0955fd3">S_ISSOCK</a></div><div class="ttdeci">bool S_ISSOCK(const int mode)</div><div class="ttdef"><b>Definition:</b> windows.hpp:215</div></div>
<div class="ttc" id="namespacenet_html_a69f77aa4677f1dd1c69169589b30a31b"><div class="ttname"><a href="namespacenet.html#a69f77aa4677f1dd1c69169589b30a31b">net::send</a></div><div class="ttdeci">ssize_t send(const os::WindowsFD &amp;fd, const void *buf, size_t len, int flags)</div><div class="ttdef"><b>Definition:</b> socket.hpp:132</div></div>
<div class="ttc" id="namespacenet_html_a190d273d305decda6696ed04b3adbd59"><div class="ttname"><a href="namespacenet.html#a190d273d305decda6696ed04b3adbd59">net::is_restartable_error</a></div><div class="ttdeci">bool is_restartable_error(int error)</div><div class="ttdef"><b>Definition:</b> socket.hpp:33</div></div>
<div class="ttc" id="namespacenet_html_a5b5c23ac2d0fa4ccaedff024f2d9a32c"><div class="ttname"><a href="namespacenet.html#a5b5c23ac2d0fa4ccaedff024f2d9a32c">net::recv</a></div><div class="ttdeci">ssize_t recv(const os::WindowsFD &amp;fd, void *buf, size_t len, int flags)</div><div class="ttdef"><b>Definition:</b> socket.hpp:140</div></div>
<div class="ttc" id="namespaceprocess_1_1http_html_a54e53c8006298fe99e3fb5f55c0e8c41"><div class="ttname"><a href="namespaceprocess_1_1http.html#a54e53c8006298fe99e3fb5f55c0e8c41">process::http::connect</a></div><div class="ttdeci">Future&lt; Connection &gt; connect(const network::Address &amp;address, Scheme scheme)</div></div>
<div class="ttc" id="namespaceprocess_1_1network_html_aa05dd9eea0c1e4d3d49e2fc049c1a446"><div class="ttname"><a href="namespaceprocess_1_1network.html#aa05dd9eea0c1e4d3d49e2fc049c1a446">process::network::accept</a></div><div class="ttdeci">Try&lt; int_fd &gt; accept(int_fd s)</div><div class="ttdef"><b>Definition:</b> network.hpp:31</div></div>
<div class="ttc" id="namespacecgroups_html_a78e3c7ca2e422779908eec45f859d757"><div class="ttname"><a href="namespacecgroups.html#a78e3c7ca2e422779908eec45f859d757">cgroups::stat</a></div><div class="ttdeci">Try&lt; hashmap&lt; std::string, uint64_t &gt; &gt; stat(const std::string &amp;hierarchy, const std::string &amp;cgroup, const std::string &amp;file)</div></div>
<div class="ttc" id="namespacemesos_1_1internal_1_1slave_1_1cni_1_1spec_html_ae58e703656ab4a1bd5d9870441236727"><div class="ttname"><a href="namespacemesos_1_1internal_1_1slave_1_1cni_1_1spec.html#ae58e703656ab4a1bd5d9870441236727">mesos::internal::slave::cni::spec::error</a></div><div class="ttdeci">std::string error(const std::string &amp;msg, uint32_t code)</div></div>
<div class="ttc" id="namespaceprocess_1_1network_html_ad067110a4b38cc83785a43f49bf6c8e2"><div class="ttname"><a href="namespaceprocess_1_1network.html#ad067110a4b38cc83785a43f49bf6c8e2">process::network::bind</a></div><div class="ttdeci">Try&lt; Nothing &gt; bind(int_fd s, const Address &amp;address)</div><div class="ttdef"><b>Definition:</b> network.hpp:46</div></div>
<div class="ttc" id="namespacenet_html_a750f9463500ec714c5d5db550340a772"><div class="ttname"><a href="namespacenet.html#a750f9463500ec714c5d5db550340a772">net::is_retryable_error</a></div><div class="ttdeci">bool is_retryable_error(int error)</div><div class="ttdef"><b>Definition:</b> socket.hpp:42</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>