Repository: mesos-site Updated Branches: refs/heads/asf-site cfbae8336 -> 978cf3e94
http://git-wip-us.apache.org/repos/asf/mesos-site/blob/978cf3e9/content/api/latest/c++/windows_2kill_8hpp_source.html ---------------------------------------------------------------------- diff --git a/content/api/latest/c++/windows_2kill_8hpp_source.html b/content/api/latest/c++/windows_2kill_8hpp_source.html index d598df7..d5614bc 100644 --- a/content/api/latest/c++/windows_2kill_8hpp_source.html +++ b/content/api/latest/c++/windows_2kill_8hpp_source.html @@ -52,19 +52,19 @@ <div class="title">kill.hpp</div> </div> </div><!--header--> <div class="contents"> -<a href="windows_2kill_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> <span class="comment">// Licensed under the Apache License, Version 2.0 (the "License");</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <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> <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> <span class="comment">//</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <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> <span class="comment">// </span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <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> <span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <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> <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> <span class="comment">// limitations under the License.</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div clas s="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#ifndef __STOUT_OS_WINDOWS_KILL_HPP__</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#define __STOUT_OS_WINDOWS_KILL_HPP__</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <glog/logging.h></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <<a class="code" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html">stout/windows.hpp</a>></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <<a class="code" href="windows_2 os_8hpp.html">stout/windows/os.hpp</a>></span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">namespace </span><a class="code" href="namespaceos.html">os</a> {</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="namespaceos.html#a52197f498586dcbf1ae906c00477cb74"> 24</a></span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="namespaceos.html#a52197f498586dcbf1ae906c00477cb74">KILL_PASS</a> = 0; <span class="comment">// Success return for `kill` function.</span></div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="namespaceos.html#a7c6ff3b30f89d6ebf44d32d8f 49db7fc"> 25</a></span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="namespaceos.html#a7c6ff3b30f89d6ebf44d32d8f49db7fc">KILL_FAIL</a> = -1; <span class="comment">// Error return for `kill` function.</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">namespace </span><a class="code" href="namespaceinternal.html">internal</a> {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="namespaceos_1_1internal.html#a6005d1ec14b82771a0a67f853231bcc9"> 29</a></span> <span class="keyword">inline</span> <span class="keywordtype">int</span> <a class="code" href="namespaceos_1_1internal.html#a6005d1ec14b82771a0a67f853231bcc9">kill_process</a>(<a class="code" href="3rdparty_2st out_2include_2stout_2windows_8hpp.html#ab03ced250ed239bc3b50b669493997f9">pid_t</a> pid)</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <a class="code" href="namespacerouting_1_1queueing_1_1ingress.html#a934208b6017d0a9aed90b6594bb8292f">HANDLE</a> process_handle = ::OpenProcess(PROCESS_TERMINATE, FALSE, pid);</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordflow">if</span> (process_handle == <span class="keyword">nullptr</span>) {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  LOG(ERROR) << <span class="stringliteral">"os::kill_process(): Failed call to OpenProcess"</span>;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span cla ss="keywordflow">return</span> <a class="code" href="namespaceos.html#a7c6ff3b30f89d6ebf44d32d8f49db7fc">KILL_FAIL</a>;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  }</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <a class="code" href="classSharedHandle.html">SharedHandle</a> safe_process_handle(process_handle, ::CloseHandle);</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordflow">if</span> (::TerminateProcess(safe_process_handle.<a class="code" href="classSharedHandle.html#a800385e17e17cb826147968e748fd8fa">get_handle</a>(), 1) == 0) {</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  LOG(ERROR) << <span class="stringliteral">"os::kill_pr ocess(): Failed call to TerminateProcess"</span>;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">return</span> <a class="code" href="namespaceos.html#a7c6ff3b30f89d6ebf44d32d8f49db7fc">KILL_FAIL</a>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  }</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordflow">return</span> <a class="code" href="namespaceos.html#a52197f498586dcbf1ae906c00477cb74">KILL_PASS</a>;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> }</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> } <sp an class="comment">// namespace internal {</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">inline</span> <span class="keywordtype">int</span> <a class="code" href="namespaceos.html#a45423d28aabced8c82165ee906930732">kill</a>(<a class="code" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#ab03ced250ed239bc3b50b669493997f9">pid_t</a> pid, <span class="keywordtype">int</span> sig)</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> {</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">// SIGCONT and SIGSTOP are not supported.</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">// SIGKILL calls TerminateP rocess.</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="comment">// SIGTERM has the same behaviour as SIGKILL.</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordflow">if</span> (sig == <a class="code" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#a1c2b5693161bbc9d516ef5d16c7b54f5">SIGKILL</a> || sig == SIGTERM) {</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordflow">return</span> <a class="code" href="namespaceos_1_1internal.html#a6005d1ec14b82771a0a67f853231bcc9">os::internal::kill_process</a>(pid);</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  }</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><sp an class="lineno"> 62</span>  LOG(ERROR) << <span class="stringliteral">"Failed call to os::kill(): "</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  << <span class="stringliteral">"Signal value: '"</span> << sig << <span class="stringliteral">"' is not handled. "</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  << <span class="stringliteral">"Valid Signal values for Windows os::kill() are "</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  << <span class="stringliteral">"'SIGTERM' and 'SIGKILL'"</span>;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordflow">return</span > <a class="code" > href="namespaceos.html#a7c6ff3b30f89d6ebf44d32d8f49db7fc">KILL_FAIL</a>;</div><div > class="line"><a name="l00068"></a><span class="lineno"> > 68</span> }</div><div class="line"><a name="l00069"></a><span > class="lineno"> 69</span> </div><div class="line"><a > name="l00070"></a><span class="lineno"> 70</span> } <span > class="comment">// namespace os {</span></div><div class="line"><a > name="l00071"></a><span class="lineno"> 71</span> </div><div > class="line"><a name="l00072"></a><span class="lineno"> > 72</span> <span class="preprocessor">#endif // > __STOUT_OS_WINDOWS_KILL_HPP__</span></div><div class="ttc" > id="classSharedHandle_html_a800385e17e17cb826147968e748fd8fa"><div > class="ttname"><a > href="classSharedHandle.html#a800385e17e17cb826147968e748fd8fa">SharedHandle::get_handle</a></div><div > class="ttdeci">HANDLE get_handle() const </div><div > class="ttdef"><b>Definition:</b> windows.hpp:90</div></div> +<a href="windows_2kill_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> <span class="comment">// Licensed under the Apache License, Version 2.0 (the "License");</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <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> <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> <span class="comment">//</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <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> <span class="comment">// </span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <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> <span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <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> <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> <span class="comment">// limitations under the License.</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div clas s="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#ifndef __STOUT_OS_WINDOWS_KILL_HPP__</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#define __STOUT_OS_WINDOWS_KILL_HPP__</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <glog/logging.h></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <<a class="code" href="os_8hpp.html">stout/os.hpp</a>></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <<a class="code" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html"> stout/windows.hpp</a>></span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">namespace </span><a class="code" href="namespaceos.html">os</a> {</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="namespaceos.html#a52197f498586dcbf1ae906c00477cb74"> 23</a></span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="namespaceos.html#a52197f498586dcbf1ae906c00477cb74">KILL_PASS</a> = 0; <span class="comment">// Success return for `kill` function.</span></div><div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="namespaceos.html#a7c6ff3b30f89d6ebf44d32d8f49db7fc"> 24</a></span> <span class="keyword">const</span> <span class="keywordtype">int</span > <a class="code" > href="namespaceos.html#a7c6ff3b30f89d6ebf44d32d8f49db7fc">KILL_FAIL</a> = > -1; <span class="comment">// Error return for `kill` > function.</span></div><div class="line"><a name="l00025"></a><span > class="lineno"> 25</span> </div><div class="line"><a > name="l00026"></a><span class="lineno"> 26</span> <span > class="keyword">namespace </span><a class="code" > href="namespaceinternal.html">internal</a> {</div><div class="line"><a > name="l00027"></a><span class="lineno"> 27</span> </div><div > class="line"><a name="l00028"></a><span class="lineno"><a class="line" > href="namespaceos_1_1internal.html#a6005d1ec14b82771a0a67f853231bcc9"> > 28</a></span> <span class="keyword">inline</span> <span > class="keywordtype">int</span> <a class="code" > href="namespaceos_1_1internal.html#a6005d1ec14b82771a0a67f853231bcc9">kill_process</a>(<a > class="code" > href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#ab03ced250ed239bc3b50b669493997f9">pid_t</a> > pid)</div><div cl ass="line"><a name="l00029"></a><span class="lineno"> 29</span> {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <a class="code" href="namespacerouting_1_1queueing_1_1ingress.html#a934208b6017d0a9aed90b6594bb8292f">HANDLE</a> process_handle = ::OpenProcess(PROCESS_TERMINATE, FALSE, pid);</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordflow">if</span> (process_handle == <span class="keyword">nullptr</span>) {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  LOG(ERROR) << <span class="stringliteral">"os::kill_process(): Failed call to OpenProcess"</span>;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordflow">return</span> <a class="code" href="namespaceos.html#a7c6ff3b30f89d6ebf44d32d8f49db7 fc">KILL_FAIL</a>;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  }</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <a class="code" href="classSharedHandle.html">SharedHandle</a> safe_process_handle(process_handle, ::CloseHandle);</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordflow">if</span> (::TerminateProcess(safe_process_handle.<a class="code" href="classSharedHandle.html#a800385e17e17cb826147968e748fd8fa">get_handle</a>(), 1) == 0) {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  LOG(ERROR) << <span class="stringliteral">"os::kill_process(): Failed call to TerminateProcess"</span>;</div><div class="line"><a name="l00041"></a><s pan class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordflow">return</span> <a class="code" href="namespaceos.html#a7c6ff3b30f89d6ebf44d32d8f49db7fc">KILL_FAIL</a>;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  }</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordflow">return</span> <a class="code" href="namespaceos.html#a52197f498586dcbf1ae906c00477cb74">KILL_PASS</a>;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> }</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> } <span class="comment">// namespace internal {</span></div><div class="line"><a name="l00049"></a><span c lass="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">inline</span> <span class="keywordtype">int</span> <a class="code" href="namespaceos.html#a45423d28aabced8c82165ee906930732">kill</a>(<a class="code" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#ab03ced250ed239bc3b50b669493997f9">pid_t</a> pid, <span class="keywordtype">int</span> sig)</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> {</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="comment">// SIGCONT and SIGSTOP are not supported.</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">// SIGKILL calls TerminateProcess.</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  < span class="comment">// SIGTERM has the same behaviour as SIGKILL.</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordflow">if</span> (sig == <a class="code" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#a1c2b5693161bbc9d516ef5d16c7b54f5">SIGKILL</a> || sig == SIGTERM) {</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordflow">return</span> <a class="code" href="namespaceos_1_1internal.html#a6005d1ec14b82771a0a67f853231bcc9">os::internal::kill_process</a>(pid);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  }</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  LOG(ERROR) << <span class="stringliteral">"Failed ca ll to os::kill(): "</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  << <span class="stringliteral">"Signal value: '"</span> << sig << <span class="stringliteral">"' is not handled. "</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  << <span class="stringliteral">"Valid Signal values for Windows os::kill() are "</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  << <span class="stringliteral">"'SIGTERM' and 'SIGKILL'"</span>;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordflow">return</span> <a class="code" href="namespaceos.html#a7c6ff3b30f89d6ebf44d32d8f49db7fc">KILL_FAIL</a>;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> }</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> } <span class="comment">// namespace os {</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#endif // __STOUT_OS_WINDOWS_KILL_HPP__</span></div><div class="ttc" id="classSharedHandle_html_a800385e17e17cb826147968e748fd8fa"><div class="ttname"><a href="classSharedHandle.html#a800385e17e17cb826147968e748fd8fa">SharedHandle::get_handle</a></div><div class="ttdeci">HANDLE get_handle() const </div><div class="ttdef"><b>Definition:</b> windows.hpp:90</div></div> <div class="ttc" id="classSharedHandle_html"><div class="ttname"><a href="classSharedHandle.html">SharedHandle</a></div><div class="ttdef"><b>Definition:</b> windows.hpp:72</div></div> <div class="ttc" id="3rdparty_2stout_2include_2stout_2windows_8hpp_html_a1c2b5693161bbc9d516ef5d16c7b54f5"><div class="ttname"><a href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#a1c2b5693161bbc9d516ef5d16c7b54f5">SIGKILL</a></div><div class="ttdeci">const mode_t SIGKILL</div><div class="ttdef"><b>Definition:</b> windows.hpp:335</div></div> -<div class="ttc" id="namespaceos_html_a52197f498586dcbf1ae906c00477cb74"><div class="ttname"><a href="namespaceos.html#a52197f498586dcbf1ae906c00477cb74">os::KILL_PASS</a></div><div class="ttdeci">const int KILL_PASS</div><div class="ttdef"><b>Definition:</b> kill.hpp:24</div></div> -<div class="ttc" id="namespaceos_html_a7c6ff3b30f89d6ebf44d32d8f49db7fc"><div class="ttname"><a href="namespaceos.html#a7c6ff3b30f89d6ebf44d32d8f49db7fc">os::KILL_FAIL</a></div><div class="ttdeci">const int KILL_FAIL</div><div class="ttdef"><b>Definition:</b> kill.hpp:25</div></div> +<div class="ttc" id="namespaceos_html_a52197f498586dcbf1ae906c00477cb74"><div class="ttname"><a href="namespaceos.html#a52197f498586dcbf1ae906c00477cb74">os::KILL_PASS</a></div><div class="ttdeci">const int KILL_PASS</div><div class="ttdef"><b>Definition:</b> kill.hpp:23</div></div> +<div class="ttc" id="os_8hpp_html"><div class="ttname"><a href="os_8hpp.html">os.hpp</a></div></div> +<div class="ttc" id="namespaceos_html_a7c6ff3b30f89d6ebf44d32d8f49db7fc"><div class="ttname"><a href="namespaceos.html#a7c6ff3b30f89d6ebf44d32d8f49db7fc">os::KILL_FAIL</a></div><div class="ttdeci">const int KILL_FAIL</div><div class="ttdef"><b>Definition:</b> kill.hpp:24</div></div> <div class="ttc" id="namespaceos_html"><div class="ttname"><a href="namespaceos.html">os</a></div><div class="ttdef"><b>Definition:</b> posix_signalhandler.hpp:23</div></div> <div class="ttc" id="3rdparty_2stout_2include_2stout_2windows_8hpp_html"><div class="ttname"><a href="3rdparty_2stout_2include_2stout_2windows_8hpp.html">windows.hpp</a></div></div> <div class="ttc" id="3rdparty_2stout_2include_2stout_2windows_8hpp_html_ab03ced250ed239bc3b50b669493997f9"><div class="ttname"><a href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#ab03ced250ed239bc3b50b669493997f9">pid_t</a></div><div class="ttdeci">DWORD pid_t</div><div class="ttdef"><b>Definition:</b> windows.hpp:181</div></div> <div class="ttc" id="namespacerouting_1_1queueing_1_1ingress_html_a934208b6017d0a9aed90b6594bb8292f"><div class="ttname"><a href="namespacerouting_1_1queueing_1_1ingress.html#a934208b6017d0a9aed90b6594bb8292f">routing::queueing::ingress::HANDLE</a></div><div class="ttdeci">constexpr Handle HANDLE</div><div class="ttdef"><b>Definition:</b> ingress.hpp:37</div></div> -<div class="ttc" id="namespaceos_1_1internal_html_a6005d1ec14b82771a0a67f853231bcc9"><div class="ttname"><a href="namespaceos_1_1internal.html#a6005d1ec14b82771a0a67f853231bcc9">os::internal::kill_process</a></div><div class="ttdeci">int kill_process(pid_t pid)</div><div class="ttdef"><b>Definition:</b> kill.hpp:29</div></div> +<div class="ttc" id="namespaceos_1_1internal_html_a6005d1ec14b82771a0a67f853231bcc9"><div class="ttname"><a href="namespaceos_1_1internal.html#a6005d1ec14b82771a0a67f853231bcc9">os::internal::kill_process</a></div><div class="ttdeci">int kill_process(pid_t pid)</div><div class="ttdef"><b>Definition:</b> kill.hpp:28</div></div> <div class="ttc" id="namespaceos_html_a45423d28aabced8c82165ee906930732"><div class="ttname"><a href="namespaceos.html#a45423d28aabced8c82165ee906930732">os::kill</a></div><div class="ttdeci">int kill(pid_t pid, int sig)</div><div class="ttdef"><b>Definition:</b> kill.hpp:21</div></div> <div class="ttc" id="namespaceinternal_html"><div class="ttname"><a href="namespaceinternal.html">internal</a></div><div class="ttdef"><b>Definition:</b> attributes.hpp:24</div></div> -<div class="ttc" id="windows_2os_8hpp_html"><div class="ttname"><a href="windows_2os_8hpp.html">os.hpp</a></div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> http://git-wip-us.apache.org/repos/asf/mesos-site/blob/978cf3e9/content/api/latest/c++/windows_2rm_8hpp.html ---------------------------------------------------------------------- diff --git a/content/api/latest/c++/windows_2rm_8hpp.html b/content/api/latest/c++/windows_2rm_8hpp.html index a8b5696..7a6c803 100644 --- a/content/api/latest/c++/windows_2rm_8hpp.html +++ b/content/api/latest/c++/windows_2rm_8hpp.html @@ -62,7 +62,6 @@ <code>#include <<a class="el" href="try_8hpp_source.html">stout/try.hpp</a>></code><br /> <code>#include <<a class="el" href="3rdparty_2stout_2include_2stout_2windows_8hpp_source.html">stout/windows.hpp</a>></code><br /> <code>#include <<a class="el" href="stat_8hpp_source.html">stout/os/stat.hpp</a>></code><br /> -<code>#include <<a class="el" href="windows_2os_8hpp_source.html">stout/windows/os.hpp</a>></code><br /> <code>#include <<a class="el" href="longpath_8hpp_source.html">stout/internal/windows/longpath.hpp</a>></code><br /> </div> <p><a href="windows_2rm_8hpp_source.html">Go to the source code of this file.</a></p> http://git-wip-us.apache.org/repos/asf/mesos-site/blob/978cf3e9/content/api/latest/c++/windows_2rm_8hpp_source.html ---------------------------------------------------------------------- diff --git a/content/api/latest/c++/windows_2rm_8hpp_source.html b/content/api/latest/c++/windows_2rm_8hpp_source.html index a10ab82..14c1be0 100644 --- a/content/api/latest/c++/windows_2rm_8hpp_source.html +++ b/content/api/latest/c++/windows_2rm_8hpp_source.html @@ -52,7 +52,7 @@ <div class="title">rm.hpp</div> </div> </div><!--header--> <div class="contents"> -<a href="windows_2rm_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> <span class="comment">// Licensed under the Apache License, Version 2.0 (the "License");</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <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> <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> <span class="comment">//</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <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> <span class="comment">//</ span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <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> <span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <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> <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> <span class="comment">// limitations under the License.</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="prep rocessor">#ifndef __STOUT_OS_WINDOWS_RM_HPP__</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#define __STOUT_OS_WINDOWS_RM_HPP__</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <stdio.h></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <<a class="code" href="error_8hpp.html">stout/error.hpp</a>></span></div><div class="line"><a name="l00020"></a><span class="lineno "> 20</span> <span class="preprocessor">#include <<a class="code" href="nothing_8hpp.html">stout/nothing.hpp</a>></span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <<a class="code" href="try_8hpp.html">stout/try.hpp</a>></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <<a class="code" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html">stout/windows.hpp</a>></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <<a class="code" href="stat_8hpp.html">stout/os/stat.hpp</a>></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <<a class="code" href="windows_2os_8hpp.html ">stout/windows/os.hpp</a>></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <<a class="code" href="longpath_8hpp.html">stout/internal/windows/longpath.hpp</a>></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">namespace </span><a class="code" href="namespaceinternal.html">internal</a> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span>windows {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span cla ss="comment">// NOTE: File and directory deletion on Windows is an asynchronous operation,</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// and there is no built-in way to "wait" on the deletion. So we wait by</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// checking for the path's existence until there is a "file not found" error.</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// Until the file is actually deleted, this will loop on an access denied error</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">// (the file exists but has been marked for deletion).</span></div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="namespaceinternal_1_1windows.html#ac9fbbbc8bb9b553f3ad 1abac7c9a81c3"> 38</a></span> <span class="keyword">inline</span> <a class="code" href="classTry.html">Try<Nothing></a> <a class="code" href="namespaceinternal_1_1windows.html#ac9fbbbc8bb9b553f3ad1abac7c9a81c3">wait_on_delete</a>(<span class="keyword">const</span> std::string& <a class="code" href="namespacepath.html">path</a>)</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="comment">// Try for 1 second in 10 intervals of 100 ms.</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < 10; ++i) {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="comment">// This should always fail if the file has been marked for deletion.</span></div><div class="line"><a name="l0 0043"></a><span class="lineno"> 43</span>  <span class="keyword">const</span> DWORD attributes =</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  ::GetFileAttributesW(::<a class="code" href="namespaceinternal_1_1windows.html#abd7dbdbc8d95626d0c66455078380aa1">internal::windows::longpath</a>(path).data());</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  CHECK_EQ(attributes, INVALID_FILE_ATTRIBUTES);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">const</span> DWORD <a class="code" href="namespacemesos_1_1internal_1_1slave_1_1cni_1_1spec.html#ae58e703656ab4a1bd5d9870441236727">error</a> = ::GetLastError();</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordflow">if</span> (error == ERROR_ACCESS_DENIE D) {</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  LOG(WARNING) << <span class="stringliteral">"Waiting for file "</span> << path << <span class="stringliteral">" to be deleted"</span>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="code" href="namespaceos.html#ab2b826c68a25af9e9ef47c570c36e137">os::sleep</a>(<a class="code" href="classMilliseconds.html">Milliseconds</a>(100));</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (error == ERROR_FILE_NOT_FOUND) {</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="comment">// The file is truly gone, stop waiting.</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordflow">return</span > <a class="code" href="structNothing.html">Nothing</a>();</div><div > class="line"><a name="l00054"></a><span class="lineno"> 54</span>  > } <span class="keywordflow">else</span> {</div><div class="line"><a > name="l00055"></a><span class="lineno"> 55</span>  <span > class="keywordflow">return</span> <a class="code" > href="classWindowsError.html">WindowsError</a>(error);</div><div > class="line"><a name="l00056"></a><span class="lineno"> 56</span>  > }</div><div class="line"><a name="l00057"></a><span class="lineno"> > 57</span>  }</div><div class="line"><a name="l00058"></a><span > class="lineno"> 58</span> </div><div class="line"><a > name="l00059"></a><span class="lineno"> 59</span>  <span > class="keywordflow">return</span> <a class="code" > href="classError.html">Error</a>(<span class="stringliteral">"Timed out > when waiting for file "</span> + path + <span > class="stringliteral">" to be deleted"</span>);</div><div > class="line" ><a name="l00060"></a><span class="lineno"> 60</span> }</div><div >class="line"><a name="l00061"></a><span class="lineno"> >61</span> </div><div class="line"><a name="l00062"></a><span >class="lineno"> 62</span> } <span class="comment">// namespace windows >{</span></div><div class="line"><a name="l00063"></a><span class="lineno"> >63</span> } <span class="comment">// namespace internal >{</span></div><div class="line"><a name="l00064"></a><span class="lineno"> >64</span> </div><div class="line"><a name="l00065"></a><span >class="lineno"> 65</span> <span class="keyword">namespace </span><a >class="code" href="namespaceos.html">os</a> {</div><div class="line"><a >name="l00066"></a><span class="lineno"> 66</span> </div><div >class="line"><a name="l00067"></a><span class="lineno"> >67</span> <span class="keyword">inline</span> <a class="code" >href="classTry.html">Try<Nothing></a> <a class="code" >href="namespaceos.html#ac1c8ce3595084d782 91f98c2be9f62ba">rm</a>(<span class="keyword">const</span> std::string& <a class="code" href="namespacepath.html">path</a>)</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> {</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="comment">// This function uses either `RemoveDirectory` or `DeleteFile` to remove the</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// actual filesystem entry. These WinAPI functions are being used instead of</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="comment">// the POSIX `remove` because their behavior when it comes to symbolic links</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="comment">// is well documented in MSDN[1][2]. Whenever called on a symbolic link, both</span></div><div class="li ne"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="comment">// `RemoveDirectory` and `DeleteFile` act on the symlink itself, rather than</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="comment">// its target.</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="comment">//</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="comment">// Because `RemoveDirectory` fails if the specified path is not an empty</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="comment">// directory, its behavior is consistent with the POSIX[3] `remove`[3] (which</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="comment">// uses `rmdir`[4]).</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="comment">//</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="comment">// [1] https://msdn.microsoft.com/en-us/library/windows/desktop/aa365488(v=vs.85).aspx</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="comment">// [2] https://msdn.microsoft.com/en-us/library/windows/desktop/aa365682(v=vs.85).aspx#deletefile_and_deletefiletransacted</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="comment">// [3] http://pubs.opengroup.org/onlinepubs/009695399/functions/remove.html</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="comment">// [4] http://pubs.opengroup.org/onlinepubs/009695399/functions/rmdir.html</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keyword">const</span> std::wst ring <a class="code" href="namespaceinternal_1_1windows.html#abd7dbdbc8d95626d0c66455078380aa1">longpath</a> = <a class="code" href="namespaceinternal_1_1windows.html#abd7dbdbc8d95626d0c66455078380aa1">::internal::windows::longpath</a>(path);</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">const</span> BOOL result = <a class="code" href="namespaceos_1_1stat.html#aa86aaa21fefc0e9cab89050b60aeca40">os::stat::isdir</a>(path)</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  ? ::RemoveDirectoryW(longpath.data())</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  : ::DeleteFileW(longpath.data());</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordflow">if</span> (!result) {</div><div class="line"><a name="l00090"></a>< span class="lineno"> 90</span>  <span class="keywordflow">return</span> <a class="code" href="classWindowsError.html">WindowsError</a>();</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  }</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="comment">// This wait is necessary because the `RemoveDirectory` API does not know to</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="comment">// wait for pending deletions of files in the directory, and can otherwise</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="comment">// immediately fail with "directory not empty" if there still exists a marked</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class ="comment">// for deletion but not yet deleted file. By making waiting synchronously, we</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="comment">// gain the behavior of the POSIX API.</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <a class="code" href="classTry.html">Try<Nothing></a> deleted = <a class="code" href="namespaceinternal_1_1windows.html#ac9fbbbc8bb9b553f3ad1abac7c9a81c3">::internal::windows::wait_on_delete</a>(path);</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordflow">if</span> (deleted.<a class="code" href="classTry.html#a0b98f95163b8a38daafd1651b043a276">isError</a>()) {</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordflow">return</span> <a class="code" href="classError.html">Error</a>(<span class="stringliteral">"wait_on_delete failed " ;</span> + deleted.<a class="code" href="classTry.html#aec4a11ddd3c036e889d90b7eb6258ba7">error</a>());</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  }</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordflow">return</span> <a class="code" href="structNothing.html">Nothing</a>();</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> }</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> } <span class="comment">// namespace os {</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="preprocessor">#endif // __STOUT_OS_WINDOWS_RM_HPP__</span>< /div><div class="ttc" id="namespacepath_html"><div class="ttname"><a href="namespacepath.html">path</a></div><div class="ttdef"><b>Definition:</b> path.hpp:26</div></div> +<a href="windows_2rm_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> <span class="comment">// Licensed under the Apache License, Version 2.0 (the "License");</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <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> <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> <span class="comment">//</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <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> <span class="comment">//</ span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <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> <span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <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> <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> <span class="comment">// limitations under the License.</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="prep rocessor">#ifndef __STOUT_OS_WINDOWS_RM_HPP__</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#define __STOUT_OS_WINDOWS_RM_HPP__</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <stdio.h></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <<a class="code" href="error_8hpp.html">stout/error.hpp</a>></span></div><div class="line"><a name="l00020"></a><span class="lineno "> 20</span> <span class="preprocessor">#include <<a class="code" href="nothing_8hpp.html">stout/nothing.hpp</a>></span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <<a class="code" href="try_8hpp.html">stout/try.hpp</a>></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <<a class="code" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html">stout/windows.hpp</a>></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <<a class="code" href="stat_8hpp.html">stout/os/stat.hpp</a>></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  ;<span class="preprocessor">#include <<a class="code" href="longpath_8hpp.html">stout/internal/windows/longpath.hpp</a>></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span><a class="code" href="namespaceinternal.html">internal</a> {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span>windows {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// NOTE: File and directory deletion on Windows is an asynchronous operation,</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// and there is no built-in way to "wait" on the deletion. So we wait by</s pan></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// checking for the path's existence until there is a "file not found" error.</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// Until the file is actually deleted, this will loop on an access denied error</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// (the file exists but has been marked for deletion).</span></div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="namespaceinternal_1_1windows.html#ac9fbbbc8bb9b553f3ad1abac7c9a81c3"> 36</a></span> <span class="keyword">inline</span> <a class="code" href="classTry.html">Try<Nothing></a> <a class="code" href="namespaceinternal_1_1windows.html#ac9fbbbc8bb9b553f3ad1abac7c9a81c3">wait_on_delete</a>(<span class="keyword">const</span> std::strin g& <a class="code" href="namespacepath.html">path</a>)</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="comment">// Try for 1 second in 10 intervals of 100 ms.</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < 10; ++i) {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="comment">// This should always fail if the file has been marked for deletion.</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">const</span> DWORD attributes =</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  ::GetFileAttributesW(::<a class="code" href="namespaceinternal_1_1windows.html#abd7dbdbc8d95 626d0c66455078380aa1">internal::windows::longpath</a>(path).data());</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  CHECK_EQ(attributes, INVALID_FILE_ATTRIBUTES);</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">const</span> DWORD <a class="code" href="namespacemesos_1_1internal_1_1slave_1_1cni_1_1spec.html#ae58e703656ab4a1bd5d9870441236727">error</a> = ::GetLastError();</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordflow">if</span> (error == ERROR_ACCESS_DENIED) {</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  LOG(WARNING) << <span class="stringliteral">"Waiting for file "</span> << path << <span class="stringliteral">" to be deleted"</span>;</div><div class="line "><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="namespaceos.html#ab2b826c68a25af9e9ef47c570c36e137">os::sleep</a>(<a class="code" href="classMilliseconds.html">Milliseconds</a>(100));</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (error == ERROR_FILE_NOT_FOUND) {</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="comment">// The file is truly gone, stop waiting.</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordflow">return</span> <a class="code" href="structNothing.html">Nothing</a>();</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class ="keywordflow">return</span> <a class="code" href="classWindowsError.html">WindowsError</a>(error);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  }</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  }</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordflow">return</span> <a class="code" href="classError.html">Error</a>(<span class="stringliteral">"Timed out when waiting for file "</span> + path + <span class="stringliteral">" to be deleted"</span>);</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> }</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> } <span class="comment">// namespace windows {</span></div ><div class="line"><a name="l00061"></a><span class="lineno"> >61</span> } <span class="comment">// namespace internal >{</span></div><div class="line"><a name="l00062"></a><span class="lineno"> >62</span> </div><div class="line"><a name="l00063"></a><span >class="lineno"> 63</span> <span class="keyword">namespace </span><a >class="code" href="namespaceos.html">os</a> {</div><div class="line"><a >name="l00064"></a><span class="lineno"> 64</span> </div><div >class="line"><a name="l00065"></a><span class="lineno"> >65</span> <span class="keyword">inline</span> <a class="code" >href="classTry.html">Try<Nothing></a> <a class="code" >href="namespaceos.html#ac1c8ce3595084d78291f98c2be9f62ba">rm</a>(<span >class="keyword">const</span> std::string& <a class="code" >href="namespacepath.html">path</a>)</div><div class="line"><a >name="l00066"></a><span class="lineno"> 66</span> {</div><div >class="line"><a name="l00067"></a><span class="lineno"> 67</spa n>  <span class="comment">// This function uses either `RemoveDirectory` or `DeleteFile` to remove the</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="comment">// actual filesystem entry. These WinAPI functions are being used instead of</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="comment">// the POSIX `remove` because their behavior when it comes to symbolic links</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// is well documented in MSDN[1][2]. Whenever called on a symbolic link, both</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="comment">// `RemoveDirectory` and `DeleteFile` act on the symlink itself, rather than</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="comment">// its ta rget.</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="comment">//</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="comment">// Because `RemoveDirectory` fails if the specified path is not an empty</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="comment">// directory, its behavior is consistent with the POSIX[3] `remove`[3] (which</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="comment">// uses `rmdir`[4]).</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="comment">//</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="comment">// [1] https://msdn.microsoft.com/en-us/library/windows/desktop/aa365488(v=vs.85).aspx</span></div><div class="line"><a name="l00 079"></a><span class="lineno"> 79</span>  <span class="comment">// [2] https://msdn.microsoft.com/en-us/library/windows/desktop/aa365682(v=vs.85).aspx#deletefile_and_deletefiletransacted</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="comment">// [3] http://pubs.opengroup.org/onlinepubs/009695399/functions/remove.html</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="comment">// [4] http://pubs.opengroup.org/onlinepubs/009695399/functions/rmdir.html</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">const</span> std::wstring <a class="code" href="namespaceinternal_1_1windows.html#abd7dbdbc8d95626d0c66455078380aa1">longpath</a> = <a class="code" href="namespaceinternal_1_1windows.html#abd7dbdbc8d95626d0c66455078380aa1">::internal::windows::longpath</a>(path);</div><div class="line"><a name="l00083"></a>< span class="lineno"> 83</span>  <span class="keyword">const</span> BOOL result = <a class="code" href="namespaceos_1_1stat.html#aa86aaa21fefc0e9cab89050b60aeca40">os::stat::isdir</a>(path)</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  ? ::RemoveDirectoryW(longpath.data())</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  : ::DeleteFileW(longpath.data());</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordflow">if</span> (!result) {</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordflow">return</span> <a class="code" href="classWindowsError.html">WindowsError</a>();</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  }</div><div class="line"><a name="l00090"></a><span cla ss="lineno"> 90</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="comment">// This wait is necessary because the `RemoveDirectory` API does not know to</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="comment">// wait for pending deletions of files in the directory, and can otherwise</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="comment">// immediately fail with "directory not empty" if there still exists a marked</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="comment">// for deletion but not yet deleted file. By making waiting synchronously, we</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="comment">// gain the behavior of the POSIX API.</span></div><div class="line"><a name="l00096" ></a><span class="lineno"> 96</span>  <a class="code" >href="classTry.html">Try<Nothing></a> deleted = <a class="code" >href="namespaceinternal_1_1windows.html#ac9fbbbc8bb9b553f3ad1abac7c9a81c3">::internal::windows::wait_on_delete</a>(path);</div><div > class="line"><a name="l00097"></a><span class="lineno"> 97</span>  ><span class="keywordflow">if</span> (deleted.<a class="code" >href="classTry.html#a0b98f95163b8a38daafd1651b043a276">isError</a>()) >{</div><div class="line"><a name="l00098"></a><span class="lineno"> >98</span>  <span class="keywordflow">return</span> <a class="code" >href="classError.html">Error</a>(<span >class="stringliteral">"wait_on_delete failed "</span> + deleted.<a >class="code" >href="classTry.html#aec4a11ddd3c036e889d90b7eb6258ba7">error</a>());</div><div > class="line"><a name="l00099"></a><span class="lineno"> 99</span>  >}</div><div class="line"><a name="l00100"></a><span class="lineno"> >100</span> </div><div cla ss="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordflow">return</span> <a class="code" href="structNothing.html">Nothing</a>();</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> }</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> } <span class="comment">// namespace os {</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="preprocessor">#endif // __STOUT_OS_WINDOWS_RM_HPP__</span></div><div class="ttc" id="namespacepath_html"><div class="ttname"><a href="namespacepath.html">path</a></div><div class="ttdef"><b>Definition:</b> path.hpp:26</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="classError_html"><div class="ttname"><a href="classError.html">Error</a></div><div class="ttdef"><b>Definition:</b> errorbase.hpp:36</div></div> <div class="ttc" id="namespaceos_html_ac1c8ce3595084d78291f98c2be9f62ba"><div class="ttname"><a href="namespaceos.html#ac1c8ce3595084d78291f98c2be9f62ba">os::rm</a></div><div class="ttdeci">Try< Nothing > rm(const std::string &path)</div><div class="ttdef"><b>Definition:</b> rm.hpp:26</div></div> @@ -60,7 +60,7 @@ <div class="ttc" id="namespaceos_html_ab2b826c68a25af9e9ef47c570c36e137"><div class="ttname"><a href="namespaceos.html#ab2b826c68a25af9e9ef47c570c36e137">os::sleep</a></div><div class="ttdeci">Try< Nothing > sleep(const Duration &duration)</div><div class="ttdef"><b>Definition:</b> os.hpp:240</div></div> <div class="ttc" id="classWindowsError_html"><div class="ttname"><a href="classWindowsError.html">WindowsError</a></div><div class="ttdef"><b>Definition:</b> error.hpp:108</div></div> <div class="ttc" id="namespaceos_html"><div class="ttname"><a href="namespaceos.html">os</a></div><div class="ttdef"><b>Definition:</b> posix_signalhandler.hpp:23</div></div> -<div class="ttc" id="namespaceinternal_1_1windows_html_ac9fbbbc8bb9b553f3ad1abac7c9a81c3"><div class="ttname"><a href="namespaceinternal_1_1windows.html#ac9fbbbc8bb9b553f3ad1abac7c9a81c3">internal::windows::wait_on_delete</a></div><div class="ttdeci">Try< Nothing > wait_on_delete(const std::string &path)</div><div class="ttdef"><b>Definition:</b> rm.hpp:38</div></div> +<div class="ttc" id="namespaceinternal_1_1windows_html_ac9fbbbc8bb9b553f3ad1abac7c9a81c3"><div class="ttname"><a href="namespaceinternal_1_1windows.html#ac9fbbbc8bb9b553f3ad1abac7c9a81c3">internal::windows::wait_on_delete</a></div><div class="ttdeci">Try< Nothing > wait_on_delete(const std::string &path)</div><div class="ttdef"><b>Definition:</b> rm.hpp:36</div></div> <div class="ttc" id="3rdparty_2stout_2include_2stout_2windows_8hpp_html"><div class="ttname"><a href="3rdparty_2stout_2include_2stout_2windows_8hpp.html">windows.hpp</a></div></div> <div class="ttc" id="classMilliseconds_html"><div class="ttname"><a href="classMilliseconds.html">Milliseconds</a></div><div class="ttdef"><b>Definition:</b> duration.hpp:193</div></div> <div class="ttc" id="nothing_8hpp_html"><div class="ttname"><a href="nothing_8hpp.html">nothing.hpp</a></div></div> @@ -73,7 +73,6 @@ <div class="ttc" id="try_8hpp_html"><div class="ttname"><a href="try_8hpp.html">try.hpp</a></div></div> <div class="ttc" id="stat_8hpp_html"><div class="ttname"><a href="stat_8hpp.html">stat.hpp</a></div></div> <div class="ttc" id="namespaceos_1_1stat_html_aa86aaa21fefc0e9cab89050b60aeca40"><div class="ttname"><a href="namespaceos_1_1stat.html#aa86aaa21fefc0e9cab89050b60aeca40">os::stat::isdir</a></div><div class="ttdeci">bool isdir(const std::string &path, const FollowSymlink follow=FollowSymlink::FOLLOW_SYMLINK)</div><div class="ttdef"><b>Definition:</b> stat.hpp:91</div></div> -<div class="ttc" id="windows_2os_8hpp_html"><div class="ttname"><a href="windows_2os_8hpp.html">os.hpp</a></div></div> <div class="ttc" id="namespaceinternal_1_1windows_html_abd7dbdbc8d95626d0c66455078380aa1"><div class="ttname"><a href="namespaceinternal_1_1windows.html#abd7dbdbc8d95626d0c66455078380aa1">internal::windows::longpath</a></div><div class="ttdeci">std::wstring longpath(const std::string &path)</div><div class="ttdef"><b>Definition:</b> longpath.hpp:38</div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part -->
