blob: 49ab4f4165b3ab6adf568282515977db3c73f460 [file] [log] [blame]
<!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: include/mesos/zookeeper/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&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;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&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_a00cdca4cac44d29e96ac7c7cae2bc86.html">mesos</a></li><li class="navelem"><a class="el" href="dir_c17ba5dacf03ff8b8f3824850be465e6.html">zookeeper</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">watcher.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="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>&#160;<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>&#160;<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>&#160;<span class="comment">// distributed with this work for additional information</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<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>&#160;<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>&#160;<span class="comment">// &quot;License&quot;); you may not use this file except in compliance</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<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>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<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>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<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>&#160;<span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<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>&#160;<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>&#160;<span class="comment">// limitations under the License</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#ifndef __MESOS_ZOOKEEPER_WATCHER_HPP__</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define __MESOS_ZOOKEEPER_WATCHER_HPP__</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &lt;glog/logging.h&gt;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="include_2mesos_2zookeeper_2zookeeper_8hpp.html">mesos/zookeeper/zookeeper.hpp</a>&gt;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="dispatch_8hpp.html">process/dispatch.hpp</a>&gt;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment">// A watcher which dispatches events to a process. Note that it is</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment">// only &quot;safe&quot; to reuse an instance across ZooKeeper instances after a</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment">// session expiration. TODO(benh): Add a &#39;reset/initialize&#39; to the</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment">// Watcher so that a single instance can be reused.</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="comment">// NOTE: By the time the dispatched events are processed by &#39;pid&#39;,</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="comment">// its session ID may have changed! Therefore, we pass the session ID</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="comment">// for the event to allow the &#39;pid&#39; Process to check for staleness.</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classProcessWatcher.html"> 37</a></span>&#160;<span class="keyword">class </span><a class="code" href="classProcessWatcher.html">ProcessWatcher</a> : <span class="keyword">public</span> <a class="code" href="classWatcher.html">Watcher</a></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;{</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classProcessWatcher.html#ae6f5acc4af4d936adca882e2274e6491"> 40</a></span>&#160; <span class="keyword">explicit</span> <a class="code" href="classProcessWatcher.html#ae6f5acc4af4d936adca882e2274e6491">ProcessWatcher</a>(<span class="keyword">const</span> <a class="code" href="structprocess_1_1PID.html">process::PID&lt;T&gt;</a>&amp; _pid)</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; : pid(_pid), reconnect(false) {}</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classProcessWatcher.html#a8858c74f313c22f72836beabb73e7c27"> 43</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classProcessWatcher.html#a8858c74f313c22f72836beabb73e7c27">process</a>(</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordtype">int</span> type,</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordtype">int</span> state,</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; int64_t sessionId,</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keyword">const</span> std::string&amp; path)</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; {</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordflow">if</span> (type == ZOO_SESSION_EVENT) {</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordflow">if</span> (state == ZOO_CONNECTED_STATE) {</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="comment">// Connected (initial or reconnect).</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <a class="code" href="namespaceprocess.html#acfbc29404bc653268289691b0dd59e22">process::dispatch</a>(pid, &amp;T::connected, sessionId, reconnect);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="comment">// If this watcher gets reused then the next connected</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="comment">// event shouldn&#39;t be perceived as a reconnect.</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; reconnect = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (state == ZOO_CONNECTING_STATE) {</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="comment">// The client library automatically reconnects, taking</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="comment">// into account failed servers in the connection string,</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="comment">// appropriately handling the &quot;herd effect&quot;, etc.</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <a class="code" href="namespaceprocess.html#acfbc29404bc653268289691b0dd59e22">process::dispatch</a>(pid, &amp;T::reconnecting, sessionId);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="comment">// TODO(benh): If this watcher gets reused then the next</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="comment">// connected event will be perceived as a reconnect, but it</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="comment">// should not.</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; reconnect = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (state == ZOO_EXPIRED_SESSION_STATE) {</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <a class="code" href="namespaceprocess.html#acfbc29404bc653268289691b0dd59e22">process::dispatch</a>(pid, &amp;<a class="code" href="namespaceprocess_1_1internal.html#a8847bb6267d177c5e587f482b823b908">T::expired</a>, sessionId);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="comment">// If this watcher gets reused then the next connected</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="comment">// event shouldn&#39;t be perceived as a reconnect.</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; reconnect = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; LOG(FATAL) &lt;&lt; <span class="stringliteral">&quot;Unhandled ZooKeeper state (&quot;</span> &lt;&lt; state &lt;&lt; <span class="stringliteral">&quot;)&quot;</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; &lt;&lt; <span class="stringliteral">&quot; for ZOO_SESSION_EVENT&quot;</span>;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; }</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (type == ZOO_CHILD_EVENT) {</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <a class="code" href="namespaceprocess.html#acfbc29404bc653268289691b0dd59e22">process::dispatch</a>(pid, &amp;T::updated, sessionId, path);</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (type == ZOO_CHANGED_EVENT) {</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <a class="code" href="namespaceprocess.html#acfbc29404bc653268289691b0dd59e22">process::dispatch</a>(pid, &amp;T::updated, sessionId, path);</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (type == ZOO_CREATED_EVENT) {</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <a class="code" href="namespaceprocess.html#acfbc29404bc653268289691b0dd59e22">process::dispatch</a>(pid, &amp;T::created, sessionId, path);</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (type == ZOO_DELETED_EVENT) {</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <a class="code" href="namespaceprocess.html#acfbc29404bc653268289691b0dd59e22">process::dispatch</a>(pid, &amp;T::deleted, sessionId, path);</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; LOG(FATAL) &lt;&lt; <span class="stringliteral">&quot;Unhandled ZooKeeper event (&quot;</span> &lt;&lt; type &lt;&lt; <span class="stringliteral">&quot;)&quot;</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; &lt;&lt; <span class="stringliteral">&quot; in state (&quot;</span> &lt;&lt; state &lt;&lt; <span class="stringliteral">&quot;)&quot;</span>;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; }</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; }</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keyword">const</span> <a class="code" href="structprocess_1_1PID.html">process::PID&lt;T&gt;</a> pid;</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="keywordtype">bool</span> reconnect;</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;};</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;<span class="preprocessor">#endif // __MESOS_ZOOKEEPER_WATCHER_HPP__</span></div>
<div class="ttc" id="dispatch_8hpp_html"><div class="ttname"><a href="dispatch_8hpp.html">dispatch.hpp</a></div></div>
<div class="ttc" id="classProcessWatcher_html_a8858c74f313c22f72836beabb73e7c27"><div class="ttname"><a href="classProcessWatcher.html#a8858c74f313c22f72836beabb73e7c27">ProcessWatcher::process</a></div><div class="ttdeci">virtual void process(int type, int state, int64_t sessionId, const std::string &amp;path)</div><div class="ttdef"><b>Definition:</b> watcher.hpp:43</div></div>
<div class="ttc" id="namespaceprocess_html_acfbc29404bc653268289691b0dd59e22"><div class="ttname"><a href="namespaceprocess.html#acfbc29404bc653268289691b0dd59e22">process::dispatch</a></div><div class="ttdeci">void dispatch(const PID&lt; T &gt; &amp;pid, void(T::*method)())</div><div class="ttdef"><b>Definition:</b> dispatch.hpp:157</div></div>
<div class="ttc" id="classWatcher_html"><div class="ttname"><a href="classWatcher.html">Watcher</a></div><div class="ttdoc">This interface specifies the public interface an event handler class must implement. </div><div class="ttdef"><b>Definition:</b> zookeeper.hpp:52</div></div>
<div class="ttc" id="classProcessWatcher_html_ae6f5acc4af4d936adca882e2274e6491"><div class="ttname"><a href="classProcessWatcher.html#ae6f5acc4af4d936adca882e2274e6491">ProcessWatcher::ProcessWatcher</a></div><div class="ttdeci">ProcessWatcher(const process::PID&lt; T &gt; &amp;_pid)</div><div class="ttdef"><b>Definition:</b> watcher.hpp:40</div></div>
<div class="ttc" id="namespaceprocess_1_1internal_html_a8847bb6267d177c5e587f482b823b908"><div class="ttname"><a href="namespaceprocess_1_1internal.html#a8847bb6267d177c5e587f482b823b908">process::internal::expired</a></div><div class="ttdeci">void expired(const lambda::function&lt; Future&lt; T &gt;(const Future&lt; T &gt; &amp;)&gt; &amp;f, const std::shared_ptr&lt; Latch &gt; &amp;latch, const std::shared_ptr&lt; Promise&lt; T &gt;&gt; &amp;promise, const Future&lt; T &gt; &amp;future)</div><div class="ttdef"><b>Definition:</b> future.hpp:1333</div></div>
<div class="ttc" id="structprocess_1_1PID_html"><div class="ttname"><a href="structprocess_1_1PID.html">process::PID</a></div><div class="ttdoc">A &amp;quot;process identifier&amp;quot; used to uniquely identify a process when dispatching messages. </div><div class="ttdef"><b>Definition:</b> pid.hpp:127</div></div>
<div class="ttc" id="include_2mesos_2zookeeper_2zookeeper_8hpp_html"><div class="ttname"><a href="include_2mesos_2zookeeper_2zookeeper_8hpp.html">zookeeper.hpp</a></div></div>
<div class="ttc" id="classProcessWatcher_html"><div class="ttname"><a href="classProcessWatcher.html">ProcessWatcher</a></div><div class="ttdef"><b>Definition:</b> watcher.hpp:37</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>