You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mesos.apache.org by gi...@apache.org on 2018/05/18 09:29:56 UTC
[05/48] mesos-site git commit: Updated the website built from mesos
SHA: c020a13.
http://git-wip-us.apache.org/repos/asf/mesos-site/blob/d7774475/content/api/latest/c++/windows_2error_8hpp_source.html
----------------------------------------------------------------------
diff --git a/content/api/latest/c++/windows_2error_8hpp_source.html b/content/api/latest/c++/windows_2error_8hpp_source.html
index 75a2357..645caea 100644
--- a/content/api/latest/c++/windows_2error_8hpp_source.html
+++ b/content/api/latest/c++/windows_2error_8hpp_source.html
@@ -52,7 +52,7 @@
<div class="title">error.hpp</div> </div>
</div><!--header-->
<div class="contents">
-<a href="windows_2error_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 to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00006"></a><s
pan class="lineno"> 6</span> <span class="comment">// "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// di
stributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// limitations under the License.</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">#ifndef __STOUT_WINDOWS_ERROR_HPP__</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define __STOUT_WINDOWS_ERROR_HPP__</span></div><div
class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <<a class="code" href="error_8hpp.html">stout/error.hpp</a>></span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</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="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <<a class="code" href="stringify_8hpp.html">stout/stringify.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> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">// A useful type that can
be used to represent a Try that has failed. This is a</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// lot like `ErrnoError`, except instead of wrapping an error coming from the C</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// standard libraries, it wraps an error coming from the Windows APIs.</span></div><div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classWindowsErrorBase.html"> 28</a></span> <span class="keyword">class </span><a class="code" href="classWindowsErrorBase.html">WindowsErrorBase</a> : <span class="keyword">public</span> <a class="code" href="classError.html">Error</a></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">public</span>:</div><div class="line"><a
name="l00031"></a><span class="lineno"><a class="line" href="classWindowsErrorBase.html#a0901c393db6d19b248f24faeb638275d"> 31</a></span>  <span class="keyword">const</span> DWORD <a class="code" href="classWindowsErrorBase.html#a0901c393db6d19b248f24faeb638275d">code</a>;</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 class="keyword">protected</span>:</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classWindowsErrorBase.html#a73005906bfdea54ae771e9ee2b8b9bf0"> 34</a></span>  <span class="keyword">explicit</span> <a class="code" href="classWindowsErrorBase.html#a73005906bfdea54ae771e9ee2b8b9bf0">WindowsErrorBase</a>(DWORD _code)</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  : <a class="code" href="classError.html">Error</a>(get_last_error_as_string(_code)), code(_
code) {}</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classWindowsErrorBase.html#a3d4eef2ab51ef4fc46bb2df7c5880fd8"> 37</a></span>  <a class="code" href="classWindowsErrorBase.html#a3d4eef2ab51ef4fc46bb2df7c5880fd8">WindowsErrorBase</a>(DWORD _code, <span class="keyword">const</span> std::string& <a class="code" href="classError.html#a2d13609e80acd2a2a473a26f273b1c4f">message</a>)</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  : <a class="code" href="classError.html">Error</a>(message + <span class="stringliteral">": "</span> + get_last_error_as_string(_code)), code(_code) {}</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="keyword">private</span>:</div><div class="line
"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">static</span> std::string get_last_error_as_string(DWORD errorCode)</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="comment">// Default if no error.</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordflow">if</span> (errorCode == 0) {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordflow">return</span> std::string();</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>  DWORD allocate_message_buffer =</div><div class="line"><a name="l00049
"></a><span class="lineno"> 49</span>  FORMAT_MESSAGE_ALLOCATE_BUFFER |</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  FORMAT_MESSAGE_FROM_SYSTEM |</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  FORMAT_MESSAGE_IGNORE_INSERTS;</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>  DWORD default_language = MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT);</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>  <span class="comment">// This following function `FormatMessage` is a lot like `strerror`, except</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="comment">// it pretty-prints errors from the Windows API ins
tead of from the C</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// standard library. Basically, the semantics are: we pass in `errorCode`,</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="comment">// and it allocates room for a pretty-printed error message at</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="comment">// `message_buffer`, and then dumps said pretty-printed error message at</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="comment">// that address, in our `default_language`.</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="comment">//</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="comment">// The 5th actual parame
ter (namely `(LPWSTR)&message_buffer`), may look</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="comment">// strange to readers of this code. It is copied directly out of the</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">// documentation[1], and is unfortunately required to get the</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="comment">// pretty-printed error message. The short story is:</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="comment">//</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="comment">// * The flag `FORMAT_MESSAGE_ALLOCATE_BUFFER` tells `FormatMessage` to</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span cla
ss="comment">// point `message_buffer` (which is an `LPWSTR` a.k.a. `char*`) at a</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="comment">// string error message. But, `message_buffer` to point a `char*` at a</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// different place, `FormatMessage` would need the address</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="comment">// `&message_buffer` so that it could change where it is pointing.</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="comment">// * So, to solve this problem, the API writers decided that when you</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="comment">// pass that flag in, `FormatMessage` will
treat the 5th parameter not</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="comment">// as `LPWSTR` (which is what the type is in the function signagure),</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="comment">// but as `LPWSTR*` a.k.a. `char**`, which (assuming you've casted the</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="comment">// parameter correctly) allows it to allocate the message on your</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="comment">// behalf, and change `message_buffer` to point at this new error</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="comment">// string.</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</s
pan>  <span class="comment">// * This is why we need this strange cast that you see below.</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="comment">//</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="comment">// Finally, and this is important: it is up to the user to free the memory</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="comment">// with `LocalFree`! The line below where we do this comes directly from</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="comment">// the documentation as well.</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="comment">//</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="comment">// [1] https://m
sdn.microsoft.com/en-us/library/windows/desktop/ms679351(v=vs.85).aspx</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordtype">wchar_t</span> *message_buffer = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">size_t</span> <a class="code" href="namespaceos_1_1stat.html#a7a116891923bc8b5d8c50f78da8657be">size</a> = ::FormatMessageW(</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  allocate_message_buffer,</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keyword">nullptr</span>, <span class="comment">// Ignored.</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  errorCode,</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  de
fault_language,</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  (LPWSTR)&message_buffer, <span class="comment">// See comment above about quirky cast.</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  0, <span class="comment">// Ignored.</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">nullptr</span>); <span class="comment">// Ignored.</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  std::wstring <a class="code" href="classError.html#a2d13609e80acd2a2a473a26f273b1c4f">message</a>(message_buffer, size);</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</s
pan>  <span class="comment">// Required per documentation above.</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  ::LocalFree(message_buffer);</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordflow">return</span> <a class="code" href="namespacens.html#a28116b46e6543597a11733424cd1aa20">stringify</a>(message);</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> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="classWindowsError.html"> 106</a></span> <span class="keywo
rd">class </span><a class="code" href="classWindowsError.html">WindowsError</a> : <span class="keyword">public</span> <a class="code" href="classWindowsErrorBase.html">WindowsErrorBase</a> {</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00108"></a><span class="lineno"><a class="line" href="classWindowsError.html#a1d7a8ec4ccb9e8de1d1174aa39d1e089"> 108</a></span>  <a class="code" href="classWindowsError.html#a1d7a8ec4ccb9e8de1d1174aa39d1e089">WindowsError</a>() : <a class="code" href="classWindowsErrorBase.html">WindowsErrorBase</a>(::GetLastError()) {}</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00110"></a><span class="lineno"><a class="line" href="classWindowsError.html#a82b53dd919106021585a9151cd156604"> 110</a></span>  <span class="keyword">explicit</span> <a class="code" href="classWindow
sError.html#a82b53dd919106021585a9151cd156604">WindowsError</a>(DWORD _code) : <a class="code" href="classWindowsErrorBase.html">WindowsErrorBase</a>(_code) {}</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div><div class="line"><a name="l00112"></a><span class="lineno"><a class="line" href="classWindowsError.html#a95807a4d4619cb117ead04f3303249d6"> 112</a></span>  <a class="code" href="classWindowsError.html#a95807a4d4619cb117ead04f3303249d6">WindowsError</a>(<span class="keyword">const</span> std::string& <a class="code" href="classError.html#a2d13609e80acd2a2a473a26f273b1c4f">message</a>)</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  : <a class="code" href="classWindowsErrorBase.html">WindowsErrorBase</a>(::GetLastError(), message) {}</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div><div class="line"><a name="l00115"></a><span class="lineno"><a class="
line" href="classWindowsError.html#ac5e8aefb564070d6bc43ec1b87272095"> 115</a></span>  <a class="code" href="classWindowsError.html#ac5e8aefb564070d6bc43ec1b87272095">WindowsError</a>(DWORD _code, <span class="keyword">const</span> std::string& <a class="code" href="classError.html#a2d13609e80acd2a2a473a26f273b1c4f">message</a>)</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  : <a class="code" href="classWindowsErrorBase.html">WindowsErrorBase</a>(_code, message) {}</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> };</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div><div class="line"><a name="l00120"></a><span class="lineno"><a class="line" href="classWindowsSocketError.html"> 120</a></span> <span class="keyword">class </span><a class="code" href="classWindowsSocketError.ht
ml">WindowsSocketError</a> : <span class="keyword">public</span> <a class="code" href="classWindowsErrorBase.html">WindowsErrorBase</a> {</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00122"></a><span class="lineno"><a class="line" href="classWindowsSocketError.html#a27bced956a7f2453b2f8deacf836478e"> 122</a></span>  <a class="code" href="classWindowsSocketError.html#a27bced956a7f2453b2f8deacf836478e">WindowsSocketError</a>() : <a class="code" href="classWindowsErrorBase.html">WindowsErrorBase</a>(::WSAGetLastError()) {}</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div><div class="line"><a name="l00124"></a><span class="lineno"><a class="line" href="classWindowsSocketError.html#a4a81a41e85b87bb39141743f6a99b978"> 124</a></span>  <span class="keyword">explicit</span> <a class="code" href="classWindowsSocketError.html#a4a81a41
e85b87bb39141743f6a99b978">WindowsSocketError</a>(DWORD _code) : <a class="code" href="classWindowsErrorBase.html">WindowsErrorBase</a>(_code) {}</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div><div class="line"><a name="l00126"></a><span class="lineno"><a class="line" href="classWindowsSocketError.html#a5e33cba8ac4e338f4066e7bf7e808f95"> 126</a></span>  <a class="code" href="classWindowsSocketError.html#a5e33cba8ac4e338f4066e7bf7e808f95">WindowsSocketError</a>(<span class="keyword">const</span> std::string& <a class="code" href="classError.html#a2d13609e80acd2a2a473a26f273b1c4f">message</a>)</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  : <a class="code" href="classWindowsErrorBase.html">WindowsErrorBase</a>(::WSAGetLastError(), message) {}</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> </div><div class="line"><a name="l00129"></a><span class="lineno"><a
class="line" href="classWindowsSocketError.html#af866e904d4e353613312fc82b24ac5ab"> 129</a></span>  <a class="code" href="classWindowsSocketError.html#af866e904d4e353613312fc82b24ac5ab">WindowsSocketError</a>(DWORD _code, <span class="keyword">const</span> std::string& <a class="code" href="classError.html#a2d13609e80acd2a2a473a26f273b1c4f">message</a>)</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  : <a class="code" href="classWindowsErrorBase.html">WindowsErrorBase</a>(_code, message) {}</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> };</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="preprocessor">#endif // __STOUT_WINDOWS_ERROR_HPP__</span></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:35</div></div>
+<a href="windows_2error_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 to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00006"></a><s
pan class="lineno"> 6</span> <span class="comment">// "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// di
stributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// limitations under the License.</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">#ifndef __STOUT_WINDOWS_ERROR_HPP__</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define __STOUT_WINDOWS_ERROR_HPP__</span></div><div
class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <<a class="code" href="error_8hpp.html">stout/error.hpp</a>></span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</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="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <<a class="code" href="stringify_8hpp.html">stout/stringify.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> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">// A useful type that can
be used to represent a Try that has failed. This is a</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// lot like `ErrnoError`, except instead of wrapping an error coming from the C</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// standard libraries, it wraps an error coming from the Windows APIs.</span></div><div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classWindowsErrorBase.html"> 28</a></span> <span class="keyword">class </span><a class="code" href="classWindowsErrorBase.html">WindowsErrorBase</a> : <span class="keyword">public</span> <a class="code" href="classError.html">Error</a></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">public</span>:</div><div class="line"><a
name="l00031"></a><span class="lineno"><a class="line" href="classWindowsErrorBase.html#a0901c393db6d19b248f24faeb638275d"> 31</a></span>  <span class="keyword">const</span> DWORD <a class="code" href="classWindowsErrorBase.html#a0901c393db6d19b248f24faeb638275d">code</a>;</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 class="keyword">protected</span>:</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classWindowsErrorBase.html#a73005906bfdea54ae771e9ee2b8b9bf0"> 34</a></span>  <span class="keyword">explicit</span> <a class="code" href="classWindowsErrorBase.html#a73005906bfdea54ae771e9ee2b8b9bf0">WindowsErrorBase</a>(DWORD _code)</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  : <a class="code" href="classError.html">Error</a>(get_last_error_as_string(_code)), code(_
code) {}</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classWindowsErrorBase.html#a3d4eef2ab51ef4fc46bb2df7c5880fd8"> 37</a></span>  <a class="code" href="classWindowsErrorBase.html#a3d4eef2ab51ef4fc46bb2df7c5880fd8">WindowsErrorBase</a>(DWORD _code, <span class="keyword">const</span> std::string& <a class="code" href="classError.html#a2d13609e80acd2a2a473a26f273b1c4f">message</a>)</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  : <a class="code" href="classError.html">Error</a>(message + <span class="stringliteral">": "</span> + get_last_error_as_string(_code)), code(_code) {}</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="keyword">private</span>:</div><div class="line
"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">static</span> std::string get_last_error_as_string(DWORD errorCode)</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="comment">// Default if no error.</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordflow">if</span> (errorCode == 0) {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordflow">return</span> std::string();</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>  DWORD allocate_message_buffer =</div><div class="line"><a name="l00049
"></a><span class="lineno"> 49</span>  FORMAT_MESSAGE_ALLOCATE_BUFFER |</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  FORMAT_MESSAGE_FROM_SYSTEM |</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  FORMAT_MESSAGE_IGNORE_INSERTS;</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>  DWORD default_language = MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT);</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>  <span class="comment">// This following function `FormatMessage` is a lot like `strerror`, except</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="comment">// it pretty-prints errors from the Windows API ins
tead of from the C</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// standard library. Basically, the semantics are: we pass in `errorCode`,</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="comment">// and it allocates room for a pretty-printed error message at</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="comment">// `message_buffer`, and then dumps said pretty-printed error message at</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="comment">// that address, in our `default_language`.</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="comment">//</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="comment">// The 5th actual parame
ter (namely `(LPWSTR)&message_buffer`), may look</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="comment">// strange to readers of this code. It is copied directly out of the</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">// documentation[1], and is unfortunately required to get the</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="comment">// pretty-printed error message. The short story is:</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="comment">//</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="comment">// * The flag `FORMAT_MESSAGE_ALLOCATE_BUFFER` tells `FormatMessage` to</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span cla
ss="comment">// point `message_buffer` (which is an `LPWSTR` a.k.a. `char*`) at a</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="comment">// string error message. But, `message_buffer` to point a `char*` at a</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// different place, `FormatMessage` would need the address</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="comment">// `&message_buffer` so that it could change where it is pointing.</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="comment">// * So, to solve this problem, the API writers decided that when you</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="comment">// pass that flag in, `FormatMessage` will
treat the 5th parameter not</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="comment">// as `LPWSTR` (which is what the type is in the function signagure),</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="comment">// but as `LPWSTR*` a.k.a. `char**`, which (assuming you've casted the</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="comment">// parameter correctly) allows it to allocate the message on your</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="comment">// behalf, and change `message_buffer` to point at this new error</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="comment">// string.</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</s
pan>  <span class="comment">// * This is why we need this strange cast that you see below.</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="comment">//</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="comment">// Finally, and this is important: it is up to the user to free the memory</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="comment">// with `LocalFree`! The line below where we do this comes directly from</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="comment">// the documentation as well.</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="comment">//</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="comment">// [1] https://m
sdn.microsoft.com/en-us/library/windows/desktop/ms679351(v=vs.85).aspx</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordtype">wchar_t</span> *message_buffer = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">size_t</span> <a class="code" href="namespaceos_1_1stat.html#a7a116891923bc8b5d8c50f78da8657be">size</a> = ::FormatMessageW(</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  allocate_message_buffer,</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keyword">nullptr</span>, <span class="comment">// Ignored.</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  errorCode,</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  de
fault_language,</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  (LPWSTR)&message_buffer, <span class="comment">// See comment above about quirky cast.</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  0, <span class="comment">// Ignored.</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">nullptr</span>); <span class="comment">// Ignored.</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  std::wstring <a class="code" href="classError.html#a2d13609e80acd2a2a473a26f273b1c4f">message</a>(message_buffer, size);</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</s
pan>  <span class="comment">// Required per documentation above.</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  ::LocalFree(message_buffer);</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordflow">return</span> <a class="code" href="namespacens.html#a28116b46e6543597a11733424cd1aa20">stringify</a>(message);</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> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="classWindowsError.html"> 106</a></span> <span class="keywo
rd">class </span><a class="code" href="classWindowsError.html">WindowsError</a> : <span class="keyword">public</span> <a class="code" href="classWindowsErrorBase.html">WindowsErrorBase</a> {</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00108"></a><span class="lineno"><a class="line" href="classWindowsError.html#a1d7a8ec4ccb9e8de1d1174aa39d1e089"> 108</a></span>  <a class="code" href="classWindowsError.html#a1d7a8ec4ccb9e8de1d1174aa39d1e089">WindowsError</a>() : <a class="code" href="classWindowsErrorBase.html">WindowsErrorBase</a>(::GetLastError()) {}</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00110"></a><span class="lineno"><a class="line" href="classWindowsError.html#a82b53dd919106021585a9151cd156604"> 110</a></span>  <span class="keyword">explicit</span> <a class="code" href="classWindow
sError.html#a82b53dd919106021585a9151cd156604">WindowsError</a>(DWORD _code) : <a class="code" href="classWindowsErrorBase.html">WindowsErrorBase</a>(_code) {}</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div><div class="line"><a name="l00112"></a><span class="lineno"><a class="line" href="classWindowsError.html#a95807a4d4619cb117ead04f3303249d6"> 112</a></span>  <a class="code" href="classWindowsError.html#a95807a4d4619cb117ead04f3303249d6">WindowsError</a>(<span class="keyword">const</span> std::string& <a class="code" href="classError.html#a2d13609e80acd2a2a473a26f273b1c4f">message</a>)</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  : <a class="code" href="classWindowsErrorBase.html">WindowsErrorBase</a>(::GetLastError(), message) {}</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div><div class="line"><a name="l00115"></a><span class="lineno"><a class="
line" href="classWindowsError.html#ac5e8aefb564070d6bc43ec1b87272095"> 115</a></span>  <a class="code" href="classWindowsError.html#ac5e8aefb564070d6bc43ec1b87272095">WindowsError</a>(DWORD _code, <span class="keyword">const</span> std::string& <a class="code" href="classError.html#a2d13609e80acd2a2a473a26f273b1c4f">message</a>)</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  : <a class="code" href="classWindowsErrorBase.html">WindowsErrorBase</a>(_code, message) {}</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> };</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div><div class="line"><a name="l00120"></a><span class="lineno"><a class="line" href="classWindowsSocketError.html"> 120</a></span> <span class="keyword">class </span><a class="code" href="classWindowsSocketError.ht
ml">WindowsSocketError</a> : <span class="keyword">public</span> <a class="code" href="classWindowsErrorBase.html">WindowsErrorBase</a> {</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00122"></a><span class="lineno"><a class="line" href="classWindowsSocketError.html#a27bced956a7f2453b2f8deacf836478e"> 122</a></span>  <a class="code" href="classWindowsSocketError.html#a27bced956a7f2453b2f8deacf836478e">WindowsSocketError</a>() : <a class="code" href="classWindowsErrorBase.html">WindowsErrorBase</a>(::WSAGetLastError()) {}</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div><div class="line"><a name="l00124"></a><span class="lineno"><a class="line" href="classWindowsSocketError.html#a4a81a41e85b87bb39141743f6a99b978"> 124</a></span>  <span class="keyword">explicit</span> <a class="code" href="classWindowsSocketError.html#a4a81a41
e85b87bb39141743f6a99b978">WindowsSocketError</a>(DWORD _code) : <a class="code" href="classWindowsErrorBase.html">WindowsErrorBase</a>(_code) {}</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div><div class="line"><a name="l00126"></a><span class="lineno"><a class="line" href="classWindowsSocketError.html#a5e33cba8ac4e338f4066e7bf7e808f95"> 126</a></span>  <a class="code" href="classWindowsSocketError.html#a5e33cba8ac4e338f4066e7bf7e808f95">WindowsSocketError</a>(<span class="keyword">const</span> std::string& <a class="code" href="classError.html#a2d13609e80acd2a2a473a26f273b1c4f">message</a>)</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  : <a class="code" href="classWindowsErrorBase.html">WindowsErrorBase</a>(::WSAGetLastError(), message) {}</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> </div><div class="line"><a name="l00129"></a><span class="lineno"><a
class="line" href="classWindowsSocketError.html#af866e904d4e353613312fc82b24ac5ab"> 129</a></span>  <a class="code" href="classWindowsSocketError.html#af866e904d4e353613312fc82b24ac5ab">WindowsSocketError</a>(DWORD _code, <span class="keyword">const</span> std::string& <a class="code" href="classError.html#a2d13609e80acd2a2a473a26f273b1c4f">message</a>)</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  : <a class="code" href="classWindowsErrorBase.html">WindowsErrorBase</a>(_code, message) {}</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> };</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="preprocessor">#endif // __STOUT_WINDOWS_ERROR_HPP__</span></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_1_1stat_html_a7a116891923bc8b5d8c50f78da8657be"><div class="ttname"><a href="namespaceos_1_1stat.html#a7a116891923bc8b5d8c50f78da8657be">os::stat::size</a></div><div class="ttdeci">Try< Bytes > size(const std::string &path, const FollowSymlink follow=FollowSymlink::FOLLOW_SYMLINK)</div><div class="ttdef"><b>Definition:</b> stat.hpp:119</div></div>
<div class="ttc" id="classWindowsErrorBase_html_a3d4eef2ab51ef4fc46bb2df7c5880fd8"><div class="ttname"><a href="classWindowsErrorBase.html#a3d4eef2ab51ef4fc46bb2df7c5880fd8">WindowsErrorBase::WindowsErrorBase</a></div><div class="ttdeci">WindowsErrorBase(DWORD _code, const std::string &message)</div><div class="ttdef"><b>Definition:</b> error.hpp:37</div></div>
<div class="ttc" id="classWindowsError_html_ac5e8aefb564070d6bc43ec1b87272095"><div class="ttname"><a href="classWindowsError.html#ac5e8aefb564070d6bc43ec1b87272095">WindowsError::WindowsError</a></div><div class="ttdeci">WindowsError(DWORD _code, const std::string &message)</div><div class="ttdef"><b>Definition:</b> error.hpp:115</div></div>
@@ -67,7 +67,7 @@
<div class="ttc" id="classWindowsErrorBase_html"><div class="ttname"><a href="classWindowsErrorBase.html">WindowsErrorBase</a></div><div class="ttdef"><b>Definition:</b> error.hpp:28</div></div>
<div class="ttc" id="classWindowsSocketError_html_a5e33cba8ac4e338f4066e7bf7e808f95"><div class="ttname"><a href="classWindowsSocketError.html#a5e33cba8ac4e338f4066e7bf7e808f95">WindowsSocketError::WindowsSocketError</a></div><div class="ttdeci">WindowsSocketError(const std::string &message)</div><div class="ttdef"><b>Definition:</b> error.hpp:126</div></div>
<div class="ttc" id="classWindowsError_html_a1d7a8ec4ccb9e8de1d1174aa39d1e089"><div class="ttname"><a href="classWindowsError.html#a1d7a8ec4ccb9e8de1d1174aa39d1e089">WindowsError::WindowsError</a></div><div class="ttdeci">WindowsError()</div><div class="ttdef"><b>Definition:</b> error.hpp:108</div></div>
-<div class="ttc" id="classError_html_a2d13609e80acd2a2a473a26f273b1c4f"><div class="ttname"><a href="classError.html#a2d13609e80acd2a2a473a26f273b1c4f">Error::message</a></div><div class="ttdeci">const std::string message</div><div class="ttdef"><b>Definition:</b> errorbase.hpp:45</div></div>
+<div class="ttc" id="classError_html_a2d13609e80acd2a2a473a26f273b1c4f"><div class="ttname"><a href="classError.html#a2d13609e80acd2a2a473a26f273b1c4f">Error::message</a></div><div class="ttdeci">const std::string message</div><div class="ttdef"><b>Definition:</b> errorbase.hpp:46</div></div>
<div class="ttc" id="error_8hpp_html"><div class="ttname"><a href="error_8hpp.html">error.hpp</a></div></div>
<div class="ttc" id="classWindowsError_html_a95807a4d4619cb117ead04f3303249d6"><div class="ttname"><a href="classWindowsError.html#a95807a4d4619cb117ead04f3303249d6">WindowsError::WindowsError</a></div><div class="ttdeci">WindowsError(const std::string &message)</div><div class="ttdef"><b>Definition:</b> error.hpp:112</div></div>
<div class="ttc" id="classWindowsErrorBase_html_a73005906bfdea54ae771e9ee2b8b9bf0"><div class="ttname"><a href="classWindowsErrorBase.html#a73005906bfdea54ae771e9ee2b8b9bf0">WindowsErrorBase::WindowsErrorBase</a></div><div class="ttdeci">WindowsErrorBase(DWORD _code)</div><div class="ttdef"><b>Definition:</b> error.hpp:34</div></div>
http://git-wip-us.apache.org/repos/asf/mesos-site/blob/d7774475/content/api/latest/c++/windows_2killtree_8hpp_source.html
----------------------------------------------------------------------
diff --git a/content/api/latest/c++/windows_2killtree_8hpp_source.html b/content/api/latest/c++/windows_2killtree_8hpp_source.html
index e58174d..59700eb 100644
--- a/content/api/latest/c++/windows_2killtree_8hpp_source.html
+++ b/content/api/latest/c++/windows_2killtree_8hpp_source.html
@@ -52,7 +52,7 @@
<div class="title">killtree.hpp</div> </div>
</div><!--header-->
<div class="contents">
-<a href="windows_2killtree_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
class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#ifndef __STOUT_OS_WINDOWS_KILLTREE_HPP__</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#define __STOUT_OS_WINDOWS_KILLTREE_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 <<a class="code" href="os_8hpp.html">stout/os.hpp</a>></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <<a class="code" href="try_8hpp.html">stout/try.hpp</a>></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>
<span class="comment">// For `SharedHandle` and `pid_t`.</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <<a class="code" href="stout_2include_2stout_2os_2windows_2jobobject_8hpp.html">stout/os/windows/jobobject.hpp</a>></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"> 24</span> <span class="comment">// Terminate the "process tree" rooted at the specified pid.</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&
#160;<span class="comment">// Since there is no process tree concept on Windows,</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// internally this function looks up the job object for the given pid</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// and terminates the job. This is possible because `name_job`</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// provides an idempotent one-to-one mapping from pid to name.</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">inline</span> <a class="code" href="classTry.html">Try<std::list<ProcessTree></a>> <a class="code" href="namespaceos.html#ae7bf571af786eae39cb025d516566168">killtree</a>(</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <a
class="code" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#ab03ced250ed239bc3b50b669493997f9">pid_t</a> pid,</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordtype">int</span> signal,</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordtype">bool</span> groups = <span class="keyword">false</span>,</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordtype">bool</span> sessions = <span class="keyword">false</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 class="keyword">const</span> <a class="code" href="classTry.html">Try<std::wstring></a> <a class="code" href="namespaceos_1_1Shell.html#acfe16ef2b1146ad49a8651c0a457ce46">name</a> = <a class="code" href="namespaceos.html
#a4c477c8086d4b3004c170ee05e5be9bf">os::name_job</a>(pid);</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordflow">if</span> (name.<a class="code" href="classTry.html#a0b98f95163b8a38daafd1651b043a276">isError</a>()) {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordflow">return</span> <a class="code" href="classError.html">Error</a>(<span class="stringliteral">"Failed to determine job object name: "</span> + name.<a class="code" href="classTry.html#aec4a11ddd3c036e889d90b7eb6258ba7">error</a>());</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> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <a class="code" href="classTry.html">Try<SharedHandle></a> handle =</div><div class="line"><a name="l00041">
</a><span class="lineno"> 41</span>  <a class="code" href="namespaceos.html#aa3da520f1619211c592b12a92639a1f9">os::open_job</a>(JOB_OBJECT_TERMINATE, <span class="keyword">false</span>, name.<a class="code" href="classTry.html#a8bc7f43e75a47111ea18e9c83b007be5">get</a>());</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordflow">if</span> (handle.isError()) {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">return</span> <a class="code" href="classError.html">Error</a>(<span class="stringliteral">"Failed to open job object: "</span> + handle.error());</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>  <a class="code" href="classTry.html">Try<N
othing></a> killJobResult = <a class="code" href="namespaceos.html#a8181969d159a69d91d1e265f1bb1eddc">os::kill_job</a>(handle.get());</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordflow">if</span> (killJobResult.isError()) {</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordflow">return</span> <a class="code" href="classError.html">Error</a>(<span class="stringliteral">"Failed to delete job object: "</span> + killJobResult.error());</div><div class="line"><a name="l00049"></a><span class="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="comment">// NOTE: This return value is unused. A future refactor</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span
class="comment">// may change the return type to `Try<None>`.</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  std::list<ProcessTree> process_tree_list;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordflow">return</span> process_tree_list;</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="comment">// namespace os {</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="preprocessor">#endif // __STOUT_OS_WINDOWS_KILLTREE_HPP__</span></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:35</div></div>
+<a href="windows_2killtree_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
class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#ifndef __STOUT_OS_WINDOWS_KILLTREE_HPP__</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#define __STOUT_OS_WINDOWS_KILLTREE_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 <<a class="code" href="os_8hpp.html">stout/os.hpp</a>></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <<a class="code" href="try_8hpp.html">stout/try.hpp</a>></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>
<span class="comment">// For `SharedHandle` and `pid_t`.</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <<a class="code" href="stout_2include_2stout_2os_2windows_2jobobject_8hpp.html">stout/os/windows/jobobject.hpp</a>></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"> 24</span> <span class="comment">// Terminate the "process tree" rooted at the specified pid.</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&
#160;<span class="comment">// Since there is no process tree concept on Windows,</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// internally this function looks up the job object for the given pid</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// and terminates the job. This is possible because `name_job`</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// provides an idempotent one-to-one mapping from pid to name.</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">inline</span> <a class="code" href="classTry.html">Try<std::list<ProcessTree></a>> <a class="code" href="namespaceos.html#ae7bf571af786eae39cb025d516566168">killtree</a>(</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <a
class="code" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#ab03ced250ed239bc3b50b669493997f9">pid_t</a> pid,</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordtype">int</span> signal,</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordtype">bool</span> groups = <span class="keyword">false</span>,</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordtype">bool</span> sessions = <span class="keyword">false</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 class="keyword">const</span> <a class="code" href="classTry.html">Try<std::wstring></a> <a class="code" href="namespaceos_1_1Shell.html#acfe16ef2b1146ad49a8651c0a457ce46">name</a> = <a class="code" href="namespaceos.html
#a4c477c8086d4b3004c170ee05e5be9bf">os::name_job</a>(pid);</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordflow">if</span> (name.<a class="code" href="classTry.html#a0b98f95163b8a38daafd1651b043a276">isError</a>()) {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordflow">return</span> <a class="code" href="classError.html">Error</a>(<span class="stringliteral">"Failed to determine job object name: "</span> + name.<a class="code" href="classTry.html#aec4a11ddd3c036e889d90b7eb6258ba7">error</a>());</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> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <a class="code" href="classTry.html">Try<SharedHandle></a> handle =</div><div class="line"><a name="l00041">
</a><span class="lineno"> 41</span>  <a class="code" href="namespaceos.html#aa3da520f1619211c592b12a92639a1f9">os::open_job</a>(JOB_OBJECT_TERMINATE, <span class="keyword">false</span>, name.<a class="code" href="classTry.html#a8bc7f43e75a47111ea18e9c83b007be5">get</a>());</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordflow">if</span> (handle.isError()) {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">return</span> <a class="code" href="classError.html">Error</a>(<span class="stringliteral">"Failed to open job object: "</span> + handle.error());</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>  <a class="code" href="classTry.html">Try<N
othing></a> killJobResult = <a class="code" href="namespaceos.html#a8181969d159a69d91d1e265f1bb1eddc">os::kill_job</a>(handle.get());</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordflow">if</span> (killJobResult.isError()) {</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordflow">return</span> <a class="code" href="classError.html">Error</a>(<span class="stringliteral">"Failed to delete job object: "</span> + killJobResult.error());</div><div class="line"><a name="l00049"></a><span class="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="comment">// NOTE: This return value is unused. A future refactor</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span
class="comment">// may change the return type to `Try<None>`.</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  std::list<ProcessTree> process_tree_list;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordflow">return</span> process_tree_list;</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="comment">// namespace os {</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="preprocessor">#endif // __STOUT_OS_WINDOWS_KILLTREE_HPP__</span></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="classTry_html_a8bc7f43e75a47111ea18e9c83b007be5"><div class="ttname"><a href="classTry.html#a8bc7f43e75a47111ea18e9c83b007be5">Try::get</a></div><div class="ttdeci">T & get()&</div><div class="ttdef"><b>Definition:</b> try.hpp:73</div></div>
<div class="ttc" id="classTry_html"><div class="ttname"><a href="classTry.html">Try</a></div><div class="ttdef"><b>Definition:</b> check.hpp:33</div></div>
<div class="ttc" id="os_8hpp_html"><div class="ttname"><a href="os_8hpp.html">os.hpp</a></div></div>