| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.5"/> |
| <title>Apache Mesos: 3rdparty/libprocess/include/process/help.hpp Source File</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">Apache Mesos |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.5 --> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="pages.html"><span>Related Pages</span></a></li> |
| <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
| <li><a href="annotated.html"><span>Classes</span></a></li> |
| <li class="current"><a href="files.html"><span>Files</span></a></li> |
| <li><a href="examples.html"><span>Examples</span></a></li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="files.html"><span>File List</span></a></li> |
| <li><a href="globals.html"><span>File Members</span></a></li> |
| </ul> |
| </div> |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_8cab8f464681f7cc51cee77e79a434cd.html">3rdparty</a></li><li class="navelem"><a class="el" href="dir_043a76de98701f9bddf61b5e98f305ff.html">libprocess</a></li><li class="navelem"><a class="el" href="dir_eac18f7a64f6f8afbd1493ef4e09abdb.html">include</a></li><li class="navelem"><a class="el" href="dir_1894286df79cf582d947dbc4268b06cf.html">process</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">help.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="help_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 __PROCESS_HELP_HPP__</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor"></span><span class="preprocessor">#define __PROCESS_HELP_HPP__</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <string></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="future_8hpp.html">process/future.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_2libprocess_2include_2process_2http_8hpp.html">process/http.hpp</a>></span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <<a class="code" href="libprocess_2include_2process_2process_8hpp.html">process/process.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="preprocessor">#include <<a class="code" href="foreach_8hpp.html">stout/foreach.hpp</a>></span></div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <<a class="code" href="json_8hpp.html">stout/json.hpp</a>></span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <<a class="code" href="option_8hpp.html">stout/option.hpp</a>></span></div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <<a class="code" href="preprocessor_8hpp.html">stout/preprocessor.hpp</a>></span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <<a class="code" href="stringify_8hpp.html">stout/stringify.hpp</a>></span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <<a class="code" href="strings_8hpp.html">stout/strings.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> <span class="keyword">namespace </span><a class="code" href="namespaceos.html#ae19e4161a51b86a1f330f3bf1dc75389">process</a> {</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">// Constructs a Markdown based help "page" for a route with the</span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// following template:</span></div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">//</span></div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// ### USAGE ###</span></div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// usage</span></div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">//</span></div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">// ### TL;DR; ###</span></div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">// tldr</span></div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">//</span></div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// ### DESCRIPTION ###</span></div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">// description</span></div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">//</span></div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">// ### AUTHENTICATION ###</span></div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">// authentication requirements</span></div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">//</span></div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">// ### AUTHORIZATION ###</span></div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">// authorization requirements and granularity</span></div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">//</span></div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">// references</span></div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">//</span></div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">// See the 'USAGE', 'TLDR', 'DESCRIPTION', 'AUTHENTICATION', and</span></div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">// 'REFERENCES' helpers below to more easily construct your help pages.</span></div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> std::string <a class="code" href="namespaceprocess.html#a61f0548459d8e5a950dd91cfc2bd4aa7">HELP</a>(</div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">const</span> std::string& tldr,</div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">const</span> <a class="code" href="classOption.html">Option<std::string></a>& description = <a class="code" href="structNone.html">None</a>(),</div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">const</span> <a class="code" href="classOption.html">Option<std::string></a>& authentication = <a class="code" href="structNone.html">None</a>(),</div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">const</span> <a class="code" href="classOption.html">Option<std::string></a>& authorization = <a class="code" href="structNone.html">None</a>(),</div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">const</span> <a class="code" href="classOption.html">Option<std::string></a>& references = <a class="code" href="structNone.html">None</a>());</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">// Helper for single-line usage that puts it in a blockquote as code</span></div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">// and adds a newline.</span></div> |
| <div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="namespaceprocess.html#a525cafa300f0b0630d9c2c9b9ce2c77f"> 62</a></span> <span class="keyword">inline</span> std::string <a class="code" href="namespaceprocess.html#a525cafa300f0b0630d9c2c9b9ce2c77f">USAGE</a>(<span class="keyword">const</span> std::string& <a class="code" href="namespacemesos_1_1internal.html#a91a5bc5e418e8712bb512721b5abc46d">usage</a>)</div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> {</div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">return</span> <span class="stringliteral">"> "</span> + usage + <span class="stringliteral">"\n"</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> </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> <span class="comment">// Helper for single-line TL;DR; that adds a newline.</span></div> |
| <div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="namespaceprocess.html#a1455e1604a68bfe45564ec63c34a9653"> 69</a></span> <span class="keyword">inline</span> std::string <a class="code" href="namespaceprocess.html#a1455e1604a68bfe45564ec63c34a9653">TLDR</a>(<span class="keyword">const</span> std::string& tldr)</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="keywordflow">return</span> tldr + <span class="stringliteral">"\n"</span>;</div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> }</div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">template</span> <<span class="keyword">typename</span>... T></div> |
| <div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="namespaceprocess.html#ac77710abb3ca0716be1856035c78cb89"> 76</a></span> <span class="keyword">inline</span> std::string <a class="code" href="namespaceprocess.html#ac77710abb3ca0716be1856035c78cb89">DESCRIPTION</a>(T&&... args)</div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> {</div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordflow">return</span> <a class="code" href="namespacestrings.html#ac315a6174f56cba0d8295f84da265416">strings::join</a>(<span class="stringliteral">"\n"</span>, std::forward<T>(args)..., <span class="stringliteral">"\n"</span>);</div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> }</div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div> |
| <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment">// Helper for description of Authentication requirements.</span></div> |
| <div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="namespaceprocess.html#af11700c40575d7826e6e820896ab7023"> 83</a></span> <span class="keyword">inline</span> std::string <a class="code" href="namespaceprocess.html#af11700c40575d7826e6e820896ab7023">AUTHENTICATION</a>(<span class="keywordtype">bool</span> required)</div> |
| <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> {</div> |
| <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordflow">if</span> (required) {</div> |
| <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordflow">return</span> <span class="stringliteral">"This endpoint requires authentication iff HTTP authentication is\n"</span></div> |
| <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="stringliteral">"enabled.\n"</span>;</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">return</span> <span class="stringliteral">"This endpoint does not require authentication.\n"</span>;</div> |
| <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> }</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">// Helper for description of Authorization requirements.</span></div> |
| <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="keyword">template</span> <<span class="keyword">typename</span>... T></div> |
| <div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="namespaceprocess.html#a7212d55e280e9111f2419ab09ed4be5b"> 95</a></span> <span class="keyword">inline</span> std::string <a class="code" href="namespaceprocess.html#a7212d55e280e9111f2419ab09ed4be5b">AUTHORIZATION</a>(T&&... args)</div> |
| <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> {</div> |
| <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordflow">return</span> <a class="code" href="namespacestrings.html#ac315a6174f56cba0d8295f84da265416">strings::join</a>(<span class="stringliteral">"\n"</span>, std::forward<T>(args)..., <span class="stringliteral">"\n"</span>);</div> |
| <div class="line"><a name="l00098"></a><span class="lineno"> 98</span> }</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 class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="keyword">template</span> <<span class="keyword">typename</span>... T></div> |
| <div class="line"><a name="l00102"></a><span class="lineno"><a class="line" href="namespaceprocess.html#a648914a95c6a0879a00159dcbfb06f5e"> 102</a></span> <span class="keyword">inline</span> std::string <a class="code" href="namespaceprocess.html#a648914a95c6a0879a00159dcbfb06f5e">REFERENCES</a>(T&&... args)</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="keywordflow">return</span> <a class="code" href="namespacestrings.html#ac315a6174f56cba0d8295f84da265416">strings::join</a>(<span class="stringliteral">"\n"</span>, std::forward<T>(args)..., <span class="stringliteral">"\n"</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> </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="comment">// Help process for serving /help, /help/id, and /help/id/name (see</span></div> |
| <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment">// Help::help below for more information).</span></div> |
| <div class="line"><a name="l00110"></a><span class="lineno"><a class="line" href="classprocess_1_1Help.html"> 110</a></span> <span class="keyword">class </span><a class="code" href="classprocess_1_1Help.html">Help</a> : <span class="keyword">public</span> <a class="code" href="classprocess_1_1Process.html">Process</a><Help></div> |
| <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> {</div> |
| <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <a class="code" href="classprocess_1_1Help.html#a7a9a386f1a00090e225106e3cc1b24ff">Help</a>(<span class="keyword">const</span> <a class="code" href="classOption.html">Option<std::string></a>& delegate);</div> |
| <div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div> |
| <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="comment">// Adds 'help' for the route 'name' of the process with the</span></div> |
| <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="comment">// specified 'id' (i.e., 'http://ip:port/id/name'). It's expected</span></div> |
| <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="comment">// that 'help' is written using Markdown. When serving help to a</span></div> |
| <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="comment">// browser the Markdown will be rendered into HTML while a tool like</span></div> |
| <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="comment">// 'curl' or 'http' will just be given the Markdown directly (thus</span></div> |
| <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="comment">// making it easy to get help without opening a browser).</span></div> |
| <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="comment">// NOTE: There is no need to dispatch this directly; this gets</span></div> |
| <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="comment">// automagically dispatched by 'ProcessBase::route'.</span></div> |
| <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keywordtype">void</span> <a class="code" href="classprocess_1_1Help.html#ad87d893bda926c9b6016e43974e2cddc">add</a>(<span class="keyword">const</span> std::string& <span class="keywordtype">id</span>,</div> |
| <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keyword">const</span> std::string& <a class="code" href="namespaceos_1_1Shell.html#acfe16ef2b1146ad49a8651c0a457ce46">name</a>,</div> |
| <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keyword">const</span> <a class="code" href="classOption.html">Option<std::string></a>& help);</div> |
| <div class="line"><a name="l00126"></a><span class="lineno"> 126</span> </div> |
| <div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="comment">// Remove a previously installed 'help' string for '/id/name'.</span></div> |
| <div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keywordtype">bool</span> <span class="keyword">remove</span>(<span class="keyword">const</span> std::string& id, <span class="keyword">const</span> std::string& <a class="code" href="namespaceos_1_1Shell.html#acfe16ef2b1146ad49a8651c0a457ce46">name</a>);</div> |
| <div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div> |
| <div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="comment">// Remove all previously installed 'help' strings for '/id/*'.</span></div> |
| <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keywordtype">bool</span> <span class="keyword">remove</span>(<span class="keyword">const</span> std::string& id);</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="comment">// Allow the global json function to dump this object to its</span></div> |
| <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="comment">// canonical JSON representation.</span></div> |
| <div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keyword">friend</span> <span class="keywordtype">void</span> <a class="code" href="classprocess_1_1Help.html#ab53a069425d0fc76d75fc807799cad7e">json</a>(<a class="code" href="classJSON_1_1ObjectWriter.html">JSON::ObjectWriter</a>* writer, <span class="keyword">const</span> <a class="code" href="classprocess_1_1Help.html">Help</a>& help);</div> |
| <div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div> |
| <div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="keyword">protected</span>:</div> |
| <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classprocess_1_1Help.html#ab60e978a150594aae173311d776483c5">initialize</a>();</div> |
| <div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div> |
| <div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="comment">// Handles the following:</span></div> |
| <div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="comment">//</span></div> |
| <div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="comment">// (1) http://ip:port/help</span></div> |
| <div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="comment">// (2) http://ip:port/help/id</span></div> |
| <div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="comment">// (3) http://ip:port/help/id/name</span></div> |
| <div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <span class="comment">//</span></div> |
| <div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="comment">// Where 'id' and 'name' are replaced with a process ID and route</span></div> |
| <div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="comment">// name respectively. (1) provides a "table of contents" for all</span></div> |
| <div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="comment">// available processes while (2) provides a "table of contents" for</span></div> |
| <div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="comment">// all endpoints associated with a particular process and (3)</span></div> |
| <div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="comment">// provides the help associated with a particular endpoint of a</span></div> |
| <div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="comment">// process.</span></div> |
| <div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <a class="code" href="classprocess_1_1Future.html">Future<http::Response></a> help(<span class="keyword">const</span> <a class="code" href="structprocess_1_1http_1_1Request.html">http::Request</a>& <a class="code" href="namespaceprocess_1_1http.html#ad8f400b5e54038df7e5662ec35da05fa">request</a>);</div> |
| <div class="line"><a name="l00154"></a><span class="lineno"> 154</span> </div> |
| <div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="comment">// Helper function to get usage path by process id and endpoint name.</span></div> |
| <div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  std::string getUsagePath(<span class="keyword">const</span> std::string& <span class="keywordtype">id</span>, <span class="keyword">const</span> std::string& name);</div> |
| <div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div> |
| <div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="comment">// Delegate process name to receive root HTTP requests.</span></div> |
| <div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="keyword">const</span> <a class="code" href="classOption.html">Option<std::string></a> delegate;</div> |
| <div class="line"><a name="l00160"></a><span class="lineno"> 160</span> </div> |
| <div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  std::map<std::string, std::map<std::string, std::string>> helps;</div> |
| <div class="line"><a name="l00162"></a><span class="lineno"> 162</span> };</div> |
| <div class="line"><a name="l00163"></a><span class="lineno"> 163</span> </div> |
| <div class="line"><a name="l00164"></a><span class="lineno"> 164</span> } <span class="comment">// namespace process {</span></div> |
| <div class="line"><a name="l00165"></a><span class="lineno"> 165</span> </div> |
| <div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="preprocessor">#endif // __PROCESS_HELP_HPP__</span></div> |
| <div class="ttc" id="classOption_html"><div class="ttname"><a href="classOption.html">Option< std::string ></a></div></div> |
| <div class="ttc" id="namespaceprocess_html_af11700c40575d7826e6e820896ab7023"><div class="ttname"><a href="namespaceprocess.html#af11700c40575d7826e6e820896ab7023">process::AUTHENTICATION</a></div><div class="ttdeci">std::string AUTHENTICATION(bool required)</div><div class="ttdef"><b>Definition:</b> help.hpp:83</div></div> |
| <div class="ttc" id="namespaceprocess_1_1http_html_ad8f400b5e54038df7e5662ec35da05fa"><div class="ttname"><a href="namespaceprocess_1_1http.html#ad8f400b5e54038df7e5662ec35da05fa">process::http::request</a></div><div class="ttdeci">Future< Response > request(const Request &request, bool streamedResponse=false)</div><div class="ttdoc">Asynchronously sends an HTTP request to the process and returns the HTTP response once the entire res...</div></div> |
| <div class="ttc" id="namespacestrings_html_ac315a6174f56cba0d8295f84da265416"><div class="ttname"><a href="namespacestrings.html#ac315a6174f56cba0d8295f84da265416">strings::join</a></div><div class="ttdeci">std::stringstream & join(std::stringstream &stream, const std::string &separator, T &&...args)</div><div class="ttdef"><b>Definition:</b> strings.hpp:294</div></div> |
| <div class="ttc" id="json_8hpp_html"><div class="ttname"><a href="json_8hpp.html">json.hpp</a></div></div> |
| <div class="ttc" id="structprocess_1_1http_1_1Request_html"><div class="ttname"><a href="structprocess_1_1http_1_1Request.html">process::http::Request</a></div><div class="ttdef"><b>Definition:</b> http.hpp:511</div></div> |
| <div class="ttc" id="namespacemesos_1_1internal_html_a91a5bc5e418e8712bb512721b5abc46d"><div class="ttname"><a href="namespacemesos_1_1internal.html#a91a5bc5e418e8712bb512721b5abc46d">mesos::internal::usage</a></div><div class="ttdeci">Try< ResourceStatistics > usage(pid_t pid, bool mem=true, bool cpus=true)</div></div> |
| <div class="ttc" id="namespaceprocess_html_a1455e1604a68bfe45564ec63c34a9653"><div class="ttname"><a href="namespaceprocess.html#a1455e1604a68bfe45564ec63c34a9653">process::TLDR</a></div><div class="ttdeci">std::string TLDR(const std::string &tldr)</div><div class="ttdef"><b>Definition:</b> help.hpp:69</div></div> |
| <div class="ttc" id="classprocess_1_1Help_html_ad87d893bda926c9b6016e43974e2cddc"><div class="ttname"><a href="classprocess_1_1Help.html#ad87d893bda926c9b6016e43974e2cddc">process::Help::add</a></div><div class="ttdeci">void add(const std::string &id, const std::string &name, const Option< std::string > &help)</div></div> |
| <div class="ttc" id="classJSON_1_1ObjectWriter_html"><div class="ttname"><a href="classJSON_1_1ObjectWriter.html">JSON::ObjectWriter</a></div><div class="ttdef"><b>Definition:</b> jsonify.hpp:416</div></div> |
| <div class="ttc" id="option_8hpp_html"><div class="ttname"><a href="option_8hpp.html">option.hpp</a></div></div> |
| <div class="ttc" id="classprocess_1_1Help_html_a7a9a386f1a00090e225106e3cc1b24ff"><div class="ttname"><a href="classprocess_1_1Help.html#a7a9a386f1a00090e225106e3cc1b24ff">process::Help::Help</a></div><div class="ttdeci">Help(const Option< std::string > &delegate)</div></div> |
| <div class="ttc" id="future_8hpp_html"><div class="ttname"><a href="future_8hpp.html">future.hpp</a></div></div> |
| <div class="ttc" id="classprocess_1_1Help_html_ab60e978a150594aae173311d776483c5"><div class="ttname"><a href="classprocess_1_1Help.html#ab60e978a150594aae173311d776483c5">process::Help::initialize</a></div><div class="ttdeci">virtual void initialize()</div><div class="ttdoc">Invoked when a process gets spawned. </div></div> |
| <div class="ttc" id="foreach_8hpp_html"><div class="ttname"><a href="foreach_8hpp.html">foreach.hpp</a></div></div> |
| <div class="ttc" id="namespaceprocess_html_a61f0548459d8e5a950dd91cfc2bd4aa7"><div class="ttname"><a href="namespaceprocess.html#a61f0548459d8e5a950dd91cfc2bd4aa7">process::HELP</a></div><div class="ttdeci">std::string HELP(const std::string &tldr, const Option< std::string > &description=None(), const Option< std::string > &authentication=None(), const Option< std::string > &authorization=None(), const Option< std::string > &references=None())</div></div> |
| <div class="ttc" id="namespaceos_html_ae19e4161a51b86a1f330f3bf1dc75389"><div class="ttname"><a href="namespaceos.html#ae19e4161a51b86a1f330f3bf1dc75389">os::process</a></div><div class="ttdeci">Result< Process > process(pid_t pid)</div><div class="ttdef"><b>Definition:</b> freebsd.hpp:30</div></div> |
| <div class="ttc" id="namespaceprocess_html_a648914a95c6a0879a00159dcbfb06f5e"><div class="ttname"><a href="namespaceprocess.html#a648914a95c6a0879a00159dcbfb06f5e">process::REFERENCES</a></div><div class="ttdeci">std::string REFERENCES(T &&...args)</div><div class="ttdef"><b>Definition:</b> help.hpp:102</div></div> |
| <div class="ttc" id="structNone_html"><div class="ttname"><a href="structNone.html">None</a></div><div class="ttdef"><b>Definition:</b> none.hpp:27</div></div> |
| <div class="ttc" id="classprocess_1_1Help_html"><div class="ttname"><a href="classprocess_1_1Help.html">process::Help</a></div><div class="ttdef"><b>Definition:</b> help.hpp:110</div></div> |
| <div class="ttc" id="stringify_8hpp_html"><div class="ttname"><a href="stringify_8hpp.html">stringify.hpp</a></div></div> |
| <div class="ttc" id="namespaceprocess_html_a525cafa300f0b0630d9c2c9b9ce2c77f"><div class="ttname"><a href="namespaceprocess.html#a525cafa300f0b0630d9c2c9b9ce2c77f">process::USAGE</a></div><div class="ttdeci">std::string USAGE(const std::string &usage)</div><div class="ttdef"><b>Definition:</b> help.hpp:62</div></div> |
| <div class="ttc" id="classprocess_1_1Help_html_ab53a069425d0fc76d75fc807799cad7e"><div class="ttname"><a href="classprocess_1_1Help.html#ab53a069425d0fc76d75fc807799cad7e">process::Help::json</a></div><div class="ttdeci">friend void json(JSON::ObjectWriter *writer, const Help &help)</div></div> |
| <div class="ttc" id="3rdparty_2libprocess_2include_2process_2http_8hpp_html"><div class="ttname"><a href="3rdparty_2libprocess_2include_2process_2http_8hpp.html">http.hpp</a></div></div> |
| <div class="ttc" id="classprocess_1_1Process_html"><div class="ttname"><a href="classprocess_1_1Process.html">process::Process</a></div><div class="ttdef"><b>Definition:</b> process.hpp:490</div></div> |
| <div class="ttc" id="preprocessor_8hpp_html"><div class="ttname"><a href="preprocessor_8hpp.html">preprocessor.hpp</a></div></div> |
| <div class="ttc" id="libprocess_2include_2process_2process_8hpp_html"><div class="ttname"><a href="libprocess_2include_2process_2process_8hpp.html">process.hpp</a></div></div> |
| <div class="ttc" id="namespaceos_1_1Shell_html_acfe16ef2b1146ad49a8651c0a457ce46"><div class="ttname"><a href="namespaceos_1_1Shell.html#acfe16ef2b1146ad49a8651c0a457ce46">os::Shell::name</a></div><div class="ttdeci">constexpr const char * name</div><div class="ttdef"><b>Definition:</b> shell.hpp:41</div></div> |
| <div class="ttc" id="namespaceprocess_html_a7212d55e280e9111f2419ab09ed4be5b"><div class="ttname"><a href="namespaceprocess.html#a7212d55e280e9111f2419ab09ed4be5b">process::AUTHORIZATION</a></div><div class="ttdeci">std::string AUTHORIZATION(T &&...args)</div><div class="ttdef"><b>Definition:</b> help.hpp:95</div></div> |
| <div class="ttc" id="strings_8hpp_html"><div class="ttname"><a href="strings_8hpp.html">strings.hpp</a></div></div> |
| <div class="ttc" id="namespaceprocess_html_ac77710abb3ca0716be1856035c78cb89"><div class="ttname"><a href="namespaceprocess.html#ac77710abb3ca0716be1856035c78cb89">process::DESCRIPTION</a></div><div class="ttdeci">std::string DESCRIPTION(T &&...args)</div><div class="ttdef"><b>Definition:</b> help.hpp:76</div></div> |
| <div class="ttc" id="classprocess_1_1Future_html"><div class="ttname"><a href="classprocess_1_1Future.html">process::Future< http::Response ></a></div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.5 |
| </small></address> |
| </body> |
| </html> |
