Regenerated docs for v0.5.0

docs/Executor.html

@@ -561,7 +561,7 @@ <h5>Parameters:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jan 16 2017 10:33:15 GMT+0100 (CET) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Feb 14 2017 10:57:19 GMT-0800 (PST) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/Mesos.html

@@ -499,7 +499,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jan 16 2017 10:33:15 GMT+0100 (CET) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Feb 14 2017 10:57:19 GMT-0800 (PST) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/Scheduler.html

@@ -349,7 +349,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="scheduler.js.html">scheduler.js</a>, <a href="scheduler.js.html#line556">line 556</a>
+        <a href="scheduler.js.html">scheduler.js</a>, <a href="scheduler.js.html#line563">line 563</a>
     </li></ul></dd>
 
 
@@ -480,7 +480,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="scheduler.js.html">scheduler.js</a>, <a href="scheduler.js.html#line731">line 731</a>
+        <a href="scheduler.js.html">scheduler.js</a>, <a href="scheduler.js.html#line738">line 738</a>
     </li></ul></dd>
 
 
@@ -634,7 +634,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="scheduler.js.html">scheduler.js</a>, <a href="scheduler.js.html#line583">line 583</a>
+        <a href="scheduler.js.html">scheduler.js</a>, <a href="scheduler.js.html#line590">line 590</a>
     </li></ul></dd>
 
 
@@ -716,7 +716,7 @@ <h4 class="name" id="getRunningTasks"><span class="type-signature"></span>getRun
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="scheduler.js.html">scheduler.js</a>, <a href="scheduler.js.html#line880">line 880</a>
+        <a href="scheduler.js.html">scheduler.js</a>, <a href="scheduler.js.html#line887">line 887</a>
     </li></ul></dd>
 
 
@@ -893,7 +893,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="scheduler.js.html">scheduler.js</a>, <a href="scheduler.js.html#line658">line 658</a>
+        <a href="scheduler.js.html">scheduler.js</a>, <a href="scheduler.js.html#line665">line 665</a>
     </li></ul></dd>
 
 
@@ -1070,7 +1070,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="scheduler.js.html">scheduler.js</a>, <a href="scheduler.js.html#line820">line 820</a>
+        <a href="scheduler.js.html">scheduler.js</a>, <a href="scheduler.js.html#line827">line 827</a>
     </li></ul></dd>
 
 
@@ -1225,7 +1225,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="scheduler.js.html">scheduler.js</a>, <a href="scheduler.js.html#line770">line 770</a>
+        <a href="scheduler.js.html">scheduler.js</a>, <a href="scheduler.js.html#line777">line 777</a>
     </li></ul></dd>
 
 
@@ -1356,7 +1356,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="scheduler.js.html">scheduler.js</a>, <a href="scheduler.js.html#line854">line 854</a>
+        <a href="scheduler.js.html">scheduler.js</a>, <a href="scheduler.js.html#line861">line 861</a>
     </li></ul></dd>
 
 
@@ -1438,7 +1438,7 @@ <h4 class="name" id="revive"><span class="type-signature"></span>revive<span cla
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="scheduler.js.html">scheduler.js</a>, <a href="scheduler.js.html#line631">line 631</a>
+        <a href="scheduler.js.html">scheduler.js</a>, <a href="scheduler.js.html#line638">line 638</a>
     </li></ul></dd>
 
 
@@ -1593,7 +1593,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="scheduler.js.html">scheduler.js</a>, <a href="scheduler.js.html#line698">line 698</a>
+        <a href="scheduler.js.html">scheduler.js</a>, <a href="scheduler.js.html#line705">line 705</a>
     </li></ul></dd>
 
 
@@ -1757,7 +1757,7 @@ <h4 class="name" id="sync"><span class="type-signature"></span>sync<span class="
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="scheduler.js.html">scheduler.js</a>, <a href="scheduler.js.html#line898">line 898</a>
+        <a href="scheduler.js.html">scheduler.js</a>, <a href="scheduler.js.html#line905">line 905</a>
     </li></ul></dd>
 
 
@@ -1840,7 +1840,7 @@ <h4 class="name" id="teardown"><span class="type-signature"></span>teardown<span
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="scheduler.js.html">scheduler.js</a>, <a href="scheduler.js.html#line607">line 607</a>
+        <a href="scheduler.js.html">scheduler.js</a>, <a href="scheduler.js.html#line614">line 614</a>
     </li></ul></dd>
 
 
@@ -1884,7 +1884,7 @@ <h4 class="name" id="teardown"><span class="type-signature"></span>teardown<span
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jan 16 2017 10:33:15 GMT+0100 (CET) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Feb 14 2017 10:57:19 GMT-0800 (PST) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/TaskHealthHelper.html

@@ -235,7 +235,7 @@ <h5>Parameters:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jan 16 2017 10:33:16 GMT+0100 (CET) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Feb 14 2017 10:57:19 GMT-0800 (PST) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/TaskHelper.html

@@ -560,7 +560,7 @@ <h5>Parameters:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jan 16 2017 10:33:16 GMT+0100 (CET) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Feb 14 2017 10:57:19 GMT-0800 (PST) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/executor.js.html

@@ -333,7 +333,7 @@ <h1 class="page-title">executor.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jan 16 2017 10:33:15 GMT+0100 (CET) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Feb 14 2017 10:57:19 GMT-0800 (PST) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/index.html

@@ -101,7 +101,7 @@ <h4>High availability</h4><p>Currently, <code>mesos-framework</code> doesn't sup
 <h4>Sample framework implementation</h4><p>See also the example implementation of a framework at <a href="https://github.com/tobilg/mesos-framework-boilerplate">mesos-framework-boilerplate</a>.</p>
 <h4>Events</h4><p><strong>Events from Master</strong><br>The following events from the leading Mesos master are exposed:</p>
 <ul>
-<li><code>subscribed</code>: The first event sent by the master when the scheduler sends a <code>SUBSCRIBE</code> request on the persistent connection (i.e. the framework was started). Emits an object containing the <code>frameworkId</code> and the <code>mesosStreamId</code>. </li>
+<li><code>subscribed</code>: The first event sent by the master when the scheduler sends a <code>SUBSCRIBE</code> request on the persistent connection (i.e. the framework was started). Emits an object containing the <code>frameworkId</code> and the <code>mesosStreamId</code>, this may be emitted multiple times in the lifetime of a framework, as reconnections emit it as well. </li>
 <li><code>offers</code>: Sent by the master whenever there are new resources that can be offered to the framework. Emits the base object from the Master for this event.</li>
 <li><code>rescind</code>: Sent by the master when a particular offer is no longer valid. Emits the base object from the Master for this event.</li>
 <li><code>update</code>: Sent by the master whenever there is a status update that is generated by the executor, agent or master. Emits the base object from the Master for this event.</li>
@@ -248,7 +248,25 @@ <h3>Mesos</h3><p>The module also exposes the Mesos protocol buffer object, which
     &quot;value&quot;: &quot;my-task-id&quot;
 };
 
-var TaskID = new (Builder.build(&quot;mesos.TaskID&quot;))(taskId);</code></pre></article>
+var TaskID = new (Builder.build(&quot;mesos.TaskID&quot;))(taskId);</code></pre><h3>taskHealthHelper</h3><p>This module allows for testing of task health (or any metric available via HTTP, for example cluster state, leader, etc...) and emit a scheduler event so the issue will be handled in code.  </p>
+<p>The option properties you can specify to create a <code>taskHealthHelper</code> are the following:</p>
+<ul>
+<li><code>interval</code>: The time interval between checks, in seconds, can be partial seconds (but not recommended), defaults to 30 seconds.</li>
+<li><code>graceCount</code>: The amount of failed checks until a task is marked as unhealthy, defaults to 4.</li>
+<li><code>portIndex</code>: The port index to check, defaults to 0.</li>
+<li><code>propertyPrefix</code>: A optional prefix for the health property, mainly to be used when having multiple health checks per framework (normal health and leader status, for instance), defaults to an empty string.</li>
+<li><code>errorEvent</code>: The name of the event to emit when a task fails the health check (after the grace count), defaults to propertyPrefix + &quot;task_unhealthy&quot;.</li>
+<li><code>additionalProperties</code>: An array of additional properties to be set, these properties do not have the prefix added to them, information below.</li>
+<li><code>taskNameFilter</code>: An optional regular expression to filter tasks to be checked by the health check.</li>
+<li><code>statusCodes</code>: An array of acceptable HTTP status codes, defaults to [200].</li>
+<li><code>checkBodyFunction</code>: An optional function to check the body of the HTTP response (only after it passed the status check), parameters are the task object and the response body, needs to retrun a boolean.</li>
+</ul>
+<p>The additional properties array is an array of objects with the following members:</p>
+<ul>
+<li><code>name</code>: The name of the property to set, for example: &quot;leader&quot; (mandatory).</li>
+<li><code>setUnhealthy</code>: Should the property be set when the check fails (optional, when unset it only sets the property when healthy).</li>
+<li><code>inverse</code>: Whether the health status and the property are inversed or not (optional).</li>
+</ul></article>
     </section>
 
 
@@ -261,7 +279,7 @@ <h3>Mesos</h3><p>The module also exposes the Mesos protocol buffer object, which
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jan 16 2017 10:33:15 GMT+0100 (CET) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Feb 14 2017 10:57:19 GMT-0800 (PST) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/mesos.js.html

@@ -99,7 +99,7 @@ <h1 class="page-title">mesos.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jan 16 2017 10:33:15 GMT+0100 (CET) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Feb 14 2017 10:57:19 GMT-0800 (PST) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/scheduler.js.html

@@ -505,11 +505,18 @@ <h1 class="page-title">scheduler.js</h1>
 
     // Register a timeout for triggering of re-registrations of the scheduler
     self.httpRequest.on('socket', function (socket) {
+        var httpRequest = self.httpRequest;
         socket.setTimeout(self.options.masterConnectionTimeout);
         socket.on('timeout', function() {
             self.logger.error("Received a timeout on the long-running Master connection! Will try to re-register the framework scheduler!");
             handledTimeout = true;
             socket.destroy();
+            // Make sure the timeout is not re-emitted.
+            socket.setTimeout(0);
+            if (httpRequest !== self.httpRequest) {
+                self.logger.info("Already reconnected, not attempting again.");
+                return;
+            }
 
             // If we're using Mesos DNS, we can directy re-register, because Mesos DNS will discover the current leader automatically
             if (self.options.masterUrl === "leader.mesos") {
@@ -594,7 +601,7 @@ <h1 class="page-title">scheduler.js</h1>
  * @param {array} filters - The array of {@link https://github.com/apache/mesos/blob/c6e9ce16850f69fda719d4e32be3f2a2e1d80387/include/mesos/v1/mesos.proto#L1418|Filter} objects.
  */
 Scheduler.prototype.accept = function (offers, operations, filters) {
-    
+
     var self = this;
 
     // Set the Accept object
@@ -946,6 +953,11 @@ <h1 class="page-title">scheduler.js</h1>
         }
     }
     self.reconcileTasks = [];
+    self.launchedTasks.forEach(function (task) {
+        if (task.runtimeInfo.agentId) {
+            self.reconcile(task.taskId, task.runtimeInfo.agentId);
+        }
+    });
     for (var i = 0; i &lt; self.killTasks.length; i++) {
         self.kill(self.killTasks[i].taskId, self.killTasks[i].runtimeInfo.agentId);
     }
@@ -968,7 +980,7 @@ <h1 class="page-title">scheduler.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jan 16 2017 10:33:15 GMT+0100 (CET) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Feb 14 2017 10:57:19 GMT-0800 (PST) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>