| <!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: src/watcher/whitelist_watcher.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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_a0e215a65efa46f71fb1b59f1d6ea35a.html">watcher</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">whitelist_watcher.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="whitelist__watcher_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 __WATCHER_WHITELIST_WATCHER_HPP__</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"></span><span class="preprocessor">#define __WATCHER_WHITELIST_WATCHER_HPP__</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor"></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="libprocess_2include_2process_2process_8hpp.html">process/process.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="duration_8hpp.html">stout/duration.hpp</a>></span></div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <<a class="code" href="hashset_8hpp.html">stout/hashset.hpp</a>></span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <<a class="code" href="lambda_8hpp.html">stout/lambda.hpp</a>></span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <<a class="code" href="option_8hpp.html">stout/option.hpp</a>></span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <<a class="code" href="path_8hpp.html">stout/path.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>mesos {</div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span>internal {</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="comment">// A whitelist may be (1) absent, (2) empty, (3) non-empty. The</span></div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// watcher notifies the subscriber if the state of the whitelist</span></div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// changes or if the contents changes in case the whitelist is in</span></div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// state (3) non-empty.</span></div> |
| <div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classmesos_1_1internal_1_1WhitelistWatcher.html"> 37</a></span> <span class="keyword">class </span><a class="code" href="classmesos_1_1internal_1_1WhitelistWatcher.html">WhitelistWatcher</a> : <span class="keyword">public</span> <a class="code" href="classprocess_1_1Process.html">process::Process</a><WhitelistWatcher></div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> {</div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="comment">// By default the initial policy is assumed to be permissive, i.e.</span></div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="comment">// initial whitelist is in state (1), meaning that peers are</span></div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="comment">// accepted before a whitelist is first loaded. In this case a</span></div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="comment">// subscriber is notified only if a set of peers (possibly empty)</span></div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="comment">// is loaded from the whitelist file.</span></div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="comment">// If a subscriber initially uses a nonpermissive policy, i.e.</span></div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="comment">// initial whitelist is in state (2) or (3), peers before first</span></div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="comment">// loaded whitelist are rejected. In this case a subscriber must</span></div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="comment">// provide the initial whitelist and will be notified if the policy</span></div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="comment">// becomes permissive (no whitelist file) or if a set of peers</span></div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="comment">// loaded from the whitelist file changes.</span></div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="comment">// NOTE: The caller should ensure a callback exists throughout</span></div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="comment">// WhitelistWatcher's lifetime.</span></div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" href="classmesos_1_1internal_1_1WhitelistWatcher.html#aad1c3e12d5efb1b77d533deef725b877">WhitelistWatcher</a>(</div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">const</span> <a class="code" href="classOption.html">Option<Path></a>& path,</div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">const</span> <a class="code" href="classDuration.html">Duration</a>& watchInterval,</div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">const</span> lambda::function<</div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">void</span>(<span class="keyword">const</span> <a class="code" href="classOption.html">Option</a><<a class="code" href="classhashset.html">hashset<std::string></a>>& whitelist)>& subscriber,</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</a><<a class="code" href="classhashset.html">hashset<std::string></a>>& initialWhitelist = <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="keyword">protected</span>:</div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmesos_1_1internal_1_1WhitelistWatcher.html#a554e828d1e5aa7a84c5b38ad20a7731f">initialize</a>();</div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">void</span> <a class="code" href="classmesos_1_1internal_1_1WhitelistWatcher.html#a50bcaa3c031dd1e6ca574b7f07dc229d">watch</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="keyword">private</span>:</div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">const</span> <a class="code" href="classOption.html">Option<Path></a> path;</div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">const</span> <a class="code" href="classDuration.html">Duration</a> watchInterval;</div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  lambda::function<void(const Option<hashset<std::string>>& whitelist)></div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  subscriber;</div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <a class="code" href="classOption.html">Option<hashset<std::string></a>> lastWhitelist;</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> </div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> } <span class="comment">// namespace internal {</span></div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> } <span class="comment">// namespace mesos {</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="preprocessor">#endif // __WATCHER_WHITELIST_WATCHER_HPP__</span></div> |
| <div class="ttc" id="classmesos_1_1internal_1_1WhitelistWatcher_html_aad1c3e12d5efb1b77d533deef725b877"><div class="ttname"><a href="classmesos_1_1internal_1_1WhitelistWatcher.html#aad1c3e12d5efb1b77d533deef725b877">mesos::internal::WhitelistWatcher::WhitelistWatcher</a></div><div class="ttdeci">WhitelistWatcher(const Option< Path > &path, const Duration &watchInterval, const lambda::function< void(const Option< hashset< std::string >> &whitelist)> &subscriber, const Option< hashset< std::string >> &initialWhitelist=None())</div></div> |
| <div class="ttc" id="classOption_html"><div class="ttname"><a href="classOption.html">Option< Path ></a></div></div> |
| <div class="ttc" id="classmesos_1_1internal_1_1WhitelistWatcher_html_a554e828d1e5aa7a84c5b38ad20a7731f"><div class="ttname"><a href="classmesos_1_1internal_1_1WhitelistWatcher.html#a554e828d1e5aa7a84c5b38ad20a7731f">mesos::internal::WhitelistWatcher::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="classhashset_html"><div class="ttname"><a href="classhashset.html">hashset< std::string ></a></div></div> |
| <div class="ttc" id="classDuration_html"><div class="ttname"><a href="classDuration.html">Duration</a></div><div class="ttdef"><b>Definition:</b> duration.hpp:32</div></div> |
| <div class="ttc" id="lambda_8hpp_html"><div class="ttname"><a href="lambda_8hpp.html">lambda.hpp</a></div></div> |
| <div class="ttc" id="duration_8hpp_html"><div class="ttname"><a href="duration_8hpp.html">duration.hpp</a></div></div> |
| <div class="ttc" id="path_8hpp_html"><div class="ttname"><a href="path_8hpp.html">path.hpp</a></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="classmesos_1_1internal_1_1WhitelistWatcher_html"><div class="ttname"><a href="classmesos_1_1internal_1_1WhitelistWatcher.html">mesos::internal::WhitelistWatcher</a></div><div class="ttdef"><b>Definition:</b> whitelist_watcher.hpp:37</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="hashset_8hpp_html"><div class="ttname"><a href="hashset_8hpp.html">hashset.hpp</a></div></div> |
| <div class="ttc" id="classmesos_1_1internal_1_1WhitelistWatcher_html_a50bcaa3c031dd1e6ca574b7f07dc229d"><div class="ttname"><a href="classmesos_1_1internal_1_1WhitelistWatcher.html#a50bcaa3c031dd1e6ca574b7f07dc229d">mesos::internal::WhitelistWatcher::watch</a></div><div class="ttdeci">void watch()</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="libprocess_2include_2process_2process_8hpp_html"><div class="ttname"><a href="libprocess_2include_2process_2process_8hpp.html">process.hpp</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> |
