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/03/14 17:55:10 UTC
[03/23] mesos-site git commit: Updated the website built from mesos
SHA: 768d6fc.
http://git-wip-us.apache.org/repos/asf/mesos-site/blob/9c0e2e8a/content/api/latest/c++/src_2scheduler_2flags_8hpp_source.html
----------------------------------------------------------------------
diff --git a/content/api/latest/c++/src_2scheduler_2flags_8hpp_source.html b/content/api/latest/c++/src_2scheduler_2flags_8hpp_source.html
index 3e736fe..b3e0b1d 100644
--- a/content/api/latest/c++/src_2scheduler_2flags_8hpp_source.html
+++ b/content/api/latest/c++/src_2scheduler_2flags_8hpp_source.html
@@ -55,7 +55,7 @@
<a href="src_2scheduler_2flags_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><span 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
">// distributed 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 __SCHEDULER_FLAGS_HPP__</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define __SCHEDULER_FLAGS_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 <string></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="preprocessor">#include <<a class="code" href="include_2mesos_2mesos_8hpp.html">mesos/mesos.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="src_2common_2parse_8hpp.html">common/parse.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="src_2local_2flags_8hpp.html">local/flags.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="preprocessor">#include "<a class="code" href="src_2scheduler_2constants_8hpp.html">scheduler/constants.hpp</a>"</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="namespacemesos.html">mesos</a> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span>v1 {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">namespace </span>scheduler {</div><div class="line"><a name="l00033"></a><span class="lineno">
33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classmesos_1_1v1_1_1scheduler_1_1Flags.html"> 34</a></span> <span class="keyword">class </span><a class="code" href="classmesos_1_1v1_1_1scheduler_1_1Flags.html">Flags</a> : <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code" href="classmesos_1_1internal_1_1local_1_1Flags.html">mesos::internal::local::Flags</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> <span class="keyword">public</span>:</div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classmesos_1_1v1_1_1scheduler_1_1Flags.html#a01f2f82da5e7ac2159dd2530a68467f6"> 37</a></span>  <a class="code" href="classmesos_1_1v1_1_1scheduler_1_1Flags.html#a01f2f82da5e7ac2159dd2530a68467f6">Flags</a>()</div><div class="line"><a na
me="l00038"></a><span class="lineno"> 38</span>  {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="classflags_1_1FlagsBase.html#a09ebe840242a3b0fbd3263bb6c7ca226">add</a>(&<a class="code" href="classmesos_1_1v1_1_1scheduler_1_1Flags.html#a9f65c2be40d1f9ed8e4ad37d7ec91ae2">Flags::connectionDelayMax</a>,</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="stringliteral">"connection_delay_max"</span>,</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="stringliteral">"The maximum amount of time to wait before trying to initiate a\n"</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="stringliteral">"connection with the master. The library waits for a random amount of\n"</span></div><div class="line"><a name="l00043"></a><spa
n class="lineno"> 43</span>  <span class="stringliteral">"time between [0, b], where `b = connection_delay_max` before\n"</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="stringliteral">"initiating a (re-)connection attempt with the master."</span>,</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="namespacemesos_1_1v1_1_1scheduler.html#ac409f781f284b9623c561dad7f4a3097">DEFAULT_CONNECTION_DELAY_MAX</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>  <a class="code" href="classflags_1_1FlagsBase.html#a09ebe840242a3b0fbd3263bb6c7ca226">add</a>(&<a class="code" href="classmesos_1_1v1_1_1scheduler_1_1Flags.html#a2a40703f27e54a2e27b493bae661c3d8">Flags::httpAuthenticatee</a>,</div><div class="line"><a na
me="l00048"></a><span class="lineno"> 48</span>  <span class="stringliteral">"http_authenticatee"</span>,</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="stringliteral">"HTTP authenticatee implementation to use when authenticating against\n"</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="stringliteral">"the master. Use the default '"</span> +</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  std::string(<a class="code" href="namespacemesos_1_1internal.html#a28cee975f23fd806363158b32abb6d9b">mesos::internal::DEFAULT_BASIC_HTTP_AUTHENTICATEE</a>) +</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="stringliteral">"' or load an alternate\n"</span></div><div class="line"><a name="l00053"></a><span class="lineno"
> 53</span>  <span class="stringliteral">"authenticatee module using MESOS_MODULES."</span>,</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="namespacemesos_1_1internal.html#a28cee975f23fd806363158b32abb6d9b">mesos::internal::DEFAULT_BASIC_HTTP_AUTHENTICATEE</a>);</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>  <span class="comment">// This help message for --modules flag is the same for</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// {master,slave,sched,tests}/flags.[ch]pp and should always be kept</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="comment">// in sync.</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</spa
n>  <span class="comment">// TODO(karya): Remove the JSON example and add reference to the</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="comment">// doc file explaining the --modules flag.</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="code" href="classflags_1_1FlagsBase.html#a09ebe840242a3b0fbd3263bb6c7ca226">add</a>(&<a class="code" href="classmesos_1_1v1_1_1scheduler_1_1Flags.html#ae238850ab72f3aff828a412fa823712a">Flags::modules</a>,</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="stringliteral">"modules"</span>,</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="stringliteral">"List of modules to be loaded and be available to the internal\n"</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span
>  <span class="stringliteral">"subsystems.\n"</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="stringliteral">"\n"</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="stringliteral">"Use --modules=filepath to specify the list of modules via a\n"</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="stringliteral">"file containing a JSON formatted string. 'filepath' can be\n"</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="stringliteral">"of the form 'file:///path/to/file' or '/path/to/file'.\n"</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="stringliteral">"\n"</span></div><div class="line
"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="stringliteral">"Use --modules=\"{...}\" to specify the list of modules inline.\n"</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="stringliteral">"\n"</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="stringliteral">"Example:\n"</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="stringliteral">"{\n"</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="stringliteral">" \"libraries\": [\n"</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="stringliteral">" {\n"</span></div><div class="line"><a name="l00076"></a><span class="l
ineno"> 76</span>  <span class="stringliteral">" \"file\": \"/path/to/libfoo.so\",\n"</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="stringliteral">" \"modules\": [\n"</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="stringliteral">" {\n"</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="stringliteral">" \"name\": \"org_apache_mesos_bar\",\n"</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="stringliteral">" \"parameters\": [\n"</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="stringliteral">" {\n"</sp
an></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="stringliteral">" \"key\": \"X\",\n"</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="stringliteral">" \"value\": \"Y\"\n"</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="stringliteral">" }\n"</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="stringliteral">" ]\n"</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="stringliteral">" },\n"</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="stringliteral">" {\n"</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="stringliteral">" \"name\": \"org_apache_mesos_baz\"\n"</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="stringliteral">" }\n"</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="stringliteral">" ]\n"</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="stringliteral">" },\n"</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="stringliteral">" {\n"</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="stringliteral">" \"name\": \"qux\",\n"</span></div><div class="line
"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="stringliteral">" \"modules\": [\n"</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="stringliteral">" {\n"</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="stringliteral">" \"name\": \"org_apache_mesos_norf\"\n"</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="stringliteral">" }\n"</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="stringliteral">" ]\n"</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="stringliteral">" }\n"</span></div><div class="line"><a name="l00100"></a><sp
an class="lineno"> 100</span>  <span class="stringliteral">" ]\n"</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="stringliteral">"}"</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="comment">// This help message for --modules_dir flag is the same for</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="comment">// {master,slave,sched,tests}/flags.[ch]pp and should always be kept</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="comment">// in sync.</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <a class="code" href="classflags_1_1FlagsBase.html#a09ebe840242a3b0fbd3263bb6c7ca226">add</a>(&
;<a class="code" href="classmesos_1_1v1_1_1scheduler_1_1Flags.html#af379f044e99ca8c74169e6c0ee2a56d2">Flags::modulesDir</a>,</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="stringliteral">"modules_dir"</span>,</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="stringliteral">"Directory path of the module manifest files.\n"</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="stringliteral">"The manifest files are processed in alphabetical order.\n"</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="stringliteral">"(See --modules for more information on module manifest files).\n"</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="stringliteral">"Cannot be us
ed in conjunction with --modules.\n"</span>);</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  }</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div><div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="classmesos_1_1v1_1_1scheduler_1_1Flags.html#a9f65c2be40d1f9ed8e4ad37d7ec91ae2"> 114</a></span>  <a class="code" href="classDuration.html">Duration</a> <a class="code" href="classmesos_1_1v1_1_1scheduler_1_1Flags.html#a9f65c2be40d1f9ed8e4ad37d7ec91ae2">connectionDelayMax</a>;</div><div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="classmesos_1_1v1_1_1scheduler_1_1Flags.html#ae238850ab72f3aff828a412fa823712a"> 115</a></span>  <a class="code" href="classOption.html">Option<Modules></a> <a class="code" href="classmesos_1_1v1_1_1scheduler_1_1Flags.html#ae238850ab72f3aff828a412fa823712a">modules</a>;</div><div class="line"><a name="l00
116"></a><span class="lineno"><a class="line" href="classmesos_1_1v1_1_1scheduler_1_1Flags.html#af379f044e99ca8c74169e6c0ee2a56d2"> 116</a></span>  <a class="code" href="classOption.html">Option<std::string></a> <a class="code" href="classmesos_1_1v1_1_1scheduler_1_1Flags.html#af379f044e99ca8c74169e6c0ee2a56d2">modulesDir</a>;</div><div class="line"><a name="l00117"></a><span class="lineno"><a class="line" href="classmesos_1_1v1_1_1scheduler_1_1Flags.html#a2a40703f27e54a2e27b493bae661c3d8"> 117</a></span>  std::string <a class="code" href="classmesos_1_1v1_1_1scheduler_1_1Flags.html#a2a40703f27e54a2e27b493bae661c3d8">httpAuthenticatee</a>;</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"> 120</span> } <span class="comment">// namespace scheduler {</span></div><div class="lin
e"><a name="l00121"></a><span class="lineno"> 121</span> } <span class="comment">// namespace v1 {</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> } <span class="comment">// namespace mesos {</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="preprocessor">#endif // __SCHEDULER_FLAGS_HPP__</span></div><div class="ttc" id="classOption_html"><div class="ttname"><a href="classOption.html">Option< Modules ></a></div></div>
<div class="ttc" id="classmesos_1_1v1_1_1scheduler_1_1Flags_html_ae238850ab72f3aff828a412fa823712a"><div class="ttname"><a href="classmesos_1_1v1_1_1scheduler_1_1Flags.html#ae238850ab72f3aff828a412fa823712a">mesos::v1::scheduler::Flags::modules</a></div><div class="ttdeci">Option< Modules > modules</div><div class="ttdef"><b>Definition:</b> flags.hpp:115</div></div>
<div class="ttc" id="classmesos_1_1v1_1_1scheduler_1_1Flags_html"><div class="ttname"><a href="classmesos_1_1v1_1_1scheduler_1_1Flags.html">mesos::v1::scheduler::Flags</a></div><div class="ttdef"><b>Definition:</b> flags.hpp:34</div></div>
-<div class="ttc" id="namespacemesos_1_1internal_html_a28cee975f23fd806363158b32abb6d9b"><div class="ttname"><a href="namespacemesos_1_1internal.html#a28cee975f23fd806363158b32abb6d9b">mesos::internal::DEFAULT_BASIC_HTTP_AUTHENTICATEE</a></div><div class="ttdeci">constexpr char DEFAULT_BASIC_HTTP_AUTHENTICATEE[]</div><div class="ttdef"><b>Definition:</b> http.hpp:52</div></div>
+<div class="ttc" id="namespacemesos_1_1internal_html_a28cee975f23fd806363158b32abb6d9b"><div class="ttname"><a href="namespacemesos_1_1internal.html#a28cee975f23fd806363158b32abb6d9b">mesos::internal::DEFAULT_BASIC_HTTP_AUTHENTICATEE</a></div><div class="ttdeci">constexpr char DEFAULT_BASIC_HTTP_AUTHENTICATEE[]</div><div class="ttdef"><b>Definition:</b> http.hpp:75</div></div>
<div class="ttc" id="src_2common_2parse_8hpp_html"><div class="ttname"><a href="src_2common_2parse_8hpp.html">parse.hpp</a></div></div>
<div class="ttc" id="include_2mesos_2mesos_8hpp_html"><div class="ttname"><a href="include_2mesos_2mesos_8hpp.html">mesos.hpp</a></div></div>
<div class="ttc" id="classmesos_1_1v1_1_1scheduler_1_1Flags_html_a01f2f82da5e7ac2159dd2530a68467f6"><div class="ttname"><a href="classmesos_1_1v1_1_1scheduler_1_1Flags.html#a01f2f82da5e7ac2159dd2530a68467f6">mesos::v1::scheduler::Flags::Flags</a></div><div class="ttdeci">Flags()</div><div class="ttdef"><b>Definition:</b> flags.hpp:37</div></div>