| <!DOCTYPE html > |
| <html> |
| <head> |
| <title>worker - org.apache.gearpump.cluster.worker</title> |
| <meta name="description" content="worker - org.apache.gearpump.cluster.worker" /> |
| <meta name="keywords" content="worker org.apache.gearpump.cluster.worker" /> |
| <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> |
| |
| <link href="../../../../../lib/template.css" media="screen" type="text/css" rel="stylesheet" /> |
| <link href="../../../../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css" /> |
| <script type="text/javascript" src="../../../../../lib/jquery.js" id="jquery-js"></script> |
| <script type="text/javascript" src="../../../../../lib/jquery-ui.js"></script> |
| <script type="text/javascript" src="../../../../../lib/template.js"></script> |
| <script type="text/javascript" src="../../../../../lib/tools.tooltip.js"></script> |
| |
| <script type="text/javascript"> |
| if(top === self) { |
| var url = '../../../../../index.html'; |
| var hash = 'org.apache.gearpump.cluster.worker.package'; |
| var anchor = window.location.hash; |
| var anchor_opt = ''; |
| if (anchor.length >= 1) |
| anchor_opt = '@' + anchor.substring(1); |
| window.location.href = url + '#' + hash + anchor_opt; |
| } |
| </script> |
| |
| </head> |
| <body class="value"> |
| <div id="definition"> |
| <img alt="Package" src="../../../../../lib/package_big.png" /> |
| <p id="owner"><a href="../../../../package.html" class="extype" name="org">org</a>.<a href="../../../package.html" class="extype" name="org.apache">apache</a>.<a href="../../package.html" class="extype" name="org.apache.gearpump">gearpump</a>.<a href="../package.html" class="extype" name="org.apache.gearpump.cluster">cluster</a></p> |
| <h1>worker</h1><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.gearpump.cluster.worker.package" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| </div> |
| |
| <h4 id="signature" class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">package</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">worker</span> |
| </span> |
| </h4> |
| |
| <div id="comment" class="fullcommenttop"></div> |
| |
| |
| <div id="mbrsel"> |
| <div id="textfilter"><span class="pre"></span><span class="input"><input id="mbrsel-input" type="text" accesskey="/" /></span><span class="post"></span></div> |
| |
| |
| <div id="visbl"> |
| <span class="filtertype">Visibility</span> |
| <ol><li class="public in"><span>Public</span></li><li class="all out"><span>All</span></li></ol> |
| </div> |
| </div> |
| |
| <div id="template"> |
| <div id="allMembers"> |
| |
| |
| <div id="types" class="types members"> |
| <h3>Type Members</h3> |
| <ol><li name="org.apache.gearpump.cluster.worker.DefaultExecutorProcessLauncher" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="DefaultExecutorProcessLauncherextendsExecutorProcessLauncher"></a> |
| <a id="DefaultExecutorProcessLauncher:DefaultExecutorProcessLauncher"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="DefaultExecutorProcessLauncher.html"><span class="name">DefaultExecutorProcessLauncher</span></a><span class="result"> extends <a href="ExecutorProcessLauncher.html" class="extype" name="org.apache.gearpump.cluster.worker.ExecutorProcessLauncher">ExecutorProcessLauncher</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.gearpump.cluster.worker.package@DefaultExecutorProcessLauncherextendsExecutorProcessLauncher" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Launcher to start an executor process</p> |
| </li><li name="org.apache.gearpump.cluster.worker.ExecutorProcessLauncher" visbl="pub" data-isabs="true" fullComment="yes" group="Ungrouped"> |
| <a id="ExecutorProcessLauncherextendsAnyRef"></a> |
| <a id="ExecutorProcessLauncher:ExecutorProcessLauncher"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">trait</span> |
| </span> |
| <span class="symbol"> |
| <a href="ExecutorProcessLauncher.html"><span class="name">ExecutorProcessLauncher</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.gearpump.cluster.worker.package@ExecutorProcessLauncherextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">ExecutorProcessLauncher is used to launch a process for Executor using given parameters.</p><div class="fullcomment"><div class="comment cmt"><p>ExecutorProcessLauncher is used to launch a process for Executor using given parameters.</p><p>User can implement this interface to decide the behavior of launching a process. |
| Set "gearpump.worker.executor-process-launcher" to your implemented class name. |
| </p></div></div> |
| </li><li name="org.apache.gearpump.cluster.worker.ExecutorSlots" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="ExecutorSlotsextendsProductwithSerializable"></a> |
| <a id="ExecutorSlots:ExecutorSlots"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">case class</span> |
| </span> |
| <span class="symbol"> |
| <a href="ExecutorSlots.html"><span class="name">ExecutorSlots</span></a><span class="params">(<span name="appId">appId: <span class="extype" name="scala.Int">Int</span></span>, <span name="executorId">executorId: <span class="extype" name="scala.Int">Int</span></span>, <span name="slots">slots: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result"> extends <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.gearpump.cluster.worker.package@ExecutorSlotsextendsProductwithSerializable" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.gearpump.cluster.worker.WorkerId" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="WorkerIdextendsProductwithSerializable"></a> |
| <a id="WorkerId:WorkerId"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">case class</span> |
| </span> |
| <span class="symbol"> |
| <a href="WorkerId.html"><span class="name">WorkerId</span></a><span class="params">(<span name="sessionId">sessionId: <span class="extype" name="scala.Int">Int</span></span>, <span name="registerTime">registerTime: <span class="extype" name="scala.Long">Long</span></span>)</span><span class="result"> extends <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.gearpump.cluster.worker.package@WorkerIdextendsProductwithSerializable" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">WorkerId is used to uniquely track a worker machine.</p><div class="fullcomment"><div class="comment cmt"><p>WorkerId is used to uniquely track a worker machine. |
| </p></div><dl class="paramcmts block"><dt class="param">sessionId</dt><dd class="cmt"><p>sessionId is assigned by Master node for easy tracking. It is possible that |
| sessionId is **NOT** unique, so always use WorkerId for comparison.</p></dd><dt class="param">registerTime</dt><dd class="cmt"><p>the timestamp when a worker node register itself to master node</p></dd></dl></div> |
| </li><li name="org.apache.gearpump.cluster.worker.WorkerSummary" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="WorkerSummaryextendsProductwithSerializable"></a> |
| <a id="WorkerSummary:WorkerSummary"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">case class</span> |
| </span> |
| <span class="symbol"> |
| <a href="WorkerSummary.html"><span class="name">WorkerSummary</span></a><span class="params">(<span name="workerId">workerId: <a href="WorkerId.html" class="extype" name="org.apache.gearpump.cluster.worker.WorkerId">WorkerId</a></span>, <span name="state">state: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="actorPath">actorPath: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="aliveFor">aliveFor: <span class="extype" name="scala.Long">Long</span></span>, <span name="logFile">logFile: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="executors">executors: <span class="extype" name="scala.Array">Array</span>[<a href="ExecutorSlots.html" class="extype" name="org.apache.gearpump.cluster.worker.ExecutorSlots">ExecutorSlots</a>]</span>, <span name="totalSlots">totalSlots: <span class="extype" name="scala.Int">Int</span></span>, <span name="availableSlots">availableSlots: <span class="extype" name="scala.Int">Int</span></span>, <span name="homeDirectory">homeDirectory: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="jvmName">jvmName: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="resourceManagerContainerId">resourceManagerContainerId: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="historyMetricsConfig">historyMetricsConfig: <a href="../../util/HistoryMetricsService$$HistoryMetricsConfig.html" class="extype" name="org.apache.gearpump.util.HistoryMetricsService.HistoryMetricsConfig">HistoryMetricsConfig</a> = <span class="symbol">null</span></span>)</span><span class="result"> extends <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.gearpump.cluster.worker.package@WorkerSummaryextendsProductwithSerializable" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Worker summary information for REST API.</p> |
| </li></ol> |
| </div> |
| |
| |
| |
| <div id="values" class="values members"> |
| <h3>Value Members</h3> |
| <ol><li name="org.apache.gearpump.cluster.worker.WorkerId" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="WorkerId"></a> |
| <a id="WorkerId:WorkerId"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="WorkerId$.html"><span class="name">WorkerId</span></a><span class="result"> extends <span class="extype" name="scala.Serializable">Serializable</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.gearpump.cluster.worker.package@WorkerId" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.gearpump.cluster.worker.WorkerSummary" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="WorkerSummary"></a> |
| <a id="WorkerSummary:WorkerSummary"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="WorkerSummary$.html"><span class="name">WorkerSummary</span></a><span class="result"> extends <span class="extype" name="scala.Serializable">Serializable</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#org.apache.gearpump.cluster.worker.package@WorkerSummary" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li></ol> |
| </div> |
| |
| |
| |
| |
| </div> |
| |
| <div id="inheritedMembers"> |
| |
| |
| </div> |
| |
| <div id="groupedMembers"> |
| <div class="group" name="Ungrouped"> |
| <h3>Ungrouped</h3> |
| |
| </div> |
| </div> |
| |
| </div> |
| |
| <div id="tooltip"></div> |
| |
| <div id="footer"> </div> |
| |
| |
| </body> |
| </html> |
