blob: d8d38d84361fee8db8274c3dc35b7eb2dfb64b03 [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/windows/close.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_860a59220e758178895904e7f0fb374e.html">windows</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">close.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="windows_2close_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_WINDOWS_CLOSE_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_WINDOWS_CLOSE_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;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="nothing_8hpp.html">stout/nothing.hpp</a>&gt;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="try_8hpp.html">stout/try.hpp</a>&gt;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="windows_2error_8hpp.html">stout/windows/error.hpp</a>&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="preprocessor">#include &lt;<a class="code" href="fd_8hpp.html">stout/os/windows/fd.hpp</a>&gt;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="stout_2include_2stout_2os_2windows_2socket_8hpp.html">stout/os/windows/socket.hpp</a>&gt;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="keyword">namespace </span>os {</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="namespaceos.html#a93223a7ac0f6fdb7cfbd7ce37b4d364c"> 27</a></span>&#160;<span class="keyword">inline</span> <a class="code" href="classTry.html">Try&lt;Nothing&gt;</a> <a class="code" href="namespaceos.html#a8df77ec6d6b8d32d9b287a41bc74cfdc">close</a>(<span class="keyword">const</span> <a class="code" href="classos_1_1WindowsFD.html">WindowsFD</a>&amp; fd)</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;{</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keywordflow">switch</span> (fd.<a class="code" href="classos_1_1WindowsFD.html#a3ce17a730ace5352a1fc6d49f8336d52">type</a>()) {</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keywordflow">case</span> <a class="code" href="classos_1_1WindowsFD.html#ac0377db41e1c167339c97dbd69c79ae5a89172e93673bdea9363778d0b20b6926">WindowsFD::FD_CRT</a>:</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keywordflow">case</span> <a class="code" href="classos_1_1WindowsFD.html#ac0377db41e1c167339c97dbd69c79ae5a450a175cecd05b630d2d3364d89d68c7">WindowsFD::FD_HANDLE</a>: {</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="comment">// We don&#39;t need to call `CloseHandle` on `fd.handle`, because calling</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="comment">// `_close` on the corresponding CRT FD implicitly invokes `CloseHandle`.</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordflow">if</span> (::_close(fd.<a class="code" href="classos_1_1WindowsFD.html#a94b69cae4edb8f3549845fbfa0355b7c">crt</a>()) &lt; 0) {</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classErrnoError.html">ErrnoError</a>();</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; <span class="keywordflow">break</span>;</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="keywordflow">case</span> <a class="code" href="classos_1_1WindowsFD.html#ac0377db41e1c167339c97dbd69c79ae5a2cd82bac02ef9802698fe360bb0f46bd">WindowsFD::FD_SOCKET</a>: {</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="comment">// NOTE: Since closing an unconnected socket is not an error in POSIX,</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="comment">// we simply ignore it here.</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordflow">if</span> (::<a class="code" href="namespacemesos_1_1internal_1_1local.html#a7d7b8de28b47a3753dcd4b094d5e6c6e">shutdown</a>(fd, SD_BOTH) == SOCKET_ERROR &amp;&amp;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; WSAGetLastError() != WSAENOTCONN) {</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classWindowsSocketError.html">WindowsSocketError</a>(<span class="stringliteral">&quot;Failed to shutdown a socket&quot;</span>);</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; <span class="keywordflow">if</span> (::closesocket(fd) == SOCKET_ERROR) {</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classWindowsSocketError.html">WindowsSocketError</a>(<span class="stringliteral">&quot;Failed to close a socket&quot;</span>);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; }</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordflow">break</span>;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; }</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; <span class="keywordflow">return</span> <a class="code" href="structNothing.html">Nothing</a>();</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"> 54</span>&#160;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;} <span class="comment">// namespace os {</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="preprocessor">#endif // __STOUT_OS_WINDOWS_CLOSE_HPP__</span></div>
<div class="ttc" id="classos_1_1WindowsFD_html_ac0377db41e1c167339c97dbd69c79ae5a2cd82bac02ef9802698fe360bb0f46bd"><div class="ttname"><a href="classos_1_1WindowsFD.html#ac0377db41e1c167339c97dbd69c79ae5a2cd82bac02ef9802698fe360bb0f46bd">os::WindowsFD::FD_SOCKET</a></div><div class="ttdef"><b>Definition:</b> fd.hpp:56</div></div>
<div class="ttc" id="structNothing_html"><div class="ttname"><a href="structNothing.html">Nothing</a></div><div class="ttdef"><b>Definition:</b> nothing.hpp:16</div></div>
<div class="ttc" id="classos_1_1WindowsFD_html_ac0377db41e1c167339c97dbd69c79ae5a450a175cecd05b630d2d3364d89d68c7"><div class="ttname"><a href="classos_1_1WindowsFD.html#ac0377db41e1c167339c97dbd69c79ae5a450a175cecd05b630d2d3364d89d68c7">os::WindowsFD::FD_HANDLE</a></div><div class="ttdef"><b>Definition:</b> fd.hpp:55</div></div>
<div class="ttc" id="classos_1_1WindowsFD_html_a3ce17a730ace5352a1fc6d49f8336d52"><div class="ttname"><a href="classos_1_1WindowsFD.html#a3ce17a730ace5352a1fc6d49f8336d52">os::WindowsFD::type</a></div><div class="ttdeci">Type type() const </div><div class="ttdef"><b>Definition:</b> fd.hpp:119</div></div>
<div class="ttc" id="fd_8hpp_html"><div class="ttname"><a href="fd_8hpp.html">fd.hpp</a></div></div>
<div class="ttc" id="classos_1_1WindowsFD_html"><div class="ttname"><a href="classos_1_1WindowsFD.html">os::WindowsFD</a></div><div class="ttdef"><b>Definition:</b> fd.hpp:49</div></div>
<div class="ttc" id="classTry_html"><div class="ttname"><a href="classTry.html">Try</a></div><div class="ttdef"><b>Definition:</b> try.hpp:34</div></div>
<div class="ttc" id="classWindowsSocketError_html"><div class="ttname"><a href="classWindowsSocketError.html">WindowsSocketError</a></div><div class="ttdef"><b>Definition:</b> error.hpp:119</div></div>
<div class="ttc" id="classErrnoError_html"><div class="ttname"><a href="classErrnoError.html">ErrnoError</a></div><div class="ttdef"><b>Definition:</b> errorbase.hpp:44</div></div>
<div class="ttc" id="nothing_8hpp_html"><div class="ttname"><a href="nothing_8hpp.html">nothing.hpp</a></div></div>
<div class="ttc" id="namespaceos_html_a8df77ec6d6b8d32d9b287a41bc74cfdc"><div class="ttname"><a href="namespaceos.html#a8df77ec6d6b8d32d9b287a41bc74cfdc">os::close</a></div><div class="ttdeci">Try&lt; Nothing &gt; close(int fd)</div><div class="ttdef"><b>Definition:</b> close.hpp:24</div></div>
<div class="ttc" id="classos_1_1WindowsFD_html_a94b69cae4edb8f3549845fbfa0355b7c"><div class="ttname"><a href="classos_1_1WindowsFD.html#a94b69cae4edb8f3549845fbfa0355b7c">os::WindowsFD::crt</a></div><div class="ttdeci">int crt() const </div><div class="ttdef"><b>Definition:</b> fd.hpp:94</div></div>
<div class="ttc" id="namespacemesos_1_1internal_1_1local_html_a7d7b8de28b47a3753dcd4b094d5e6c6e"><div class="ttname"><a href="namespacemesos_1_1internal_1_1local.html#a7d7b8de28b47a3753dcd4b094d5e6c6e">mesos::internal::local::shutdown</a></div><div class="ttdeci">void shutdown()</div></div>
<div class="ttc" id="try_8hpp_html"><div class="ttname"><a href="try_8hpp.html">try.hpp</a></div></div>
<div class="ttc" id="windows_2error_8hpp_html"><div class="ttname"><a href="windows_2error_8hpp.html">error.hpp</a></div></div>
<div class="ttc" id="stout_2include_2stout_2os_2windows_2socket_8hpp_html"><div class="ttname"><a href="stout_2include_2stout_2os_2windows_2socket_8hpp.html">socket.hpp</a></div></div>
<div class="ttc" id="classos_1_1WindowsFD_html_ac0377db41e1c167339c97dbd69c79ae5a89172e93673bdea9363778d0b20b6926"><div class="ttname"><a href="classos_1_1WindowsFD.html#ac0377db41e1c167339c97dbd69c79ae5a89172e93673bdea9363778d0b20b6926">os::WindowsFD::FD_CRT</a></div><div class="ttdef"><b>Definition:</b> fd.hpp:54</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>