blob: eb4803342d1b6f3ccf6aefd23088aa7a8996b2af [file] [log] [blame]
<!DOCTYPE html >
<html>
<head>
<title>util - org.apache.gearpump.util</title>
<meta name="description" content="util - org.apache.gearpump.util" />
<meta name="keywords" content="util org.apache.gearpump.util" />
<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.util.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></p>
<h1>util</h1><span class="permalink">
<a href="../../../../index.html#org.apache.gearpump.util.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">util</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.util.ActorSystemBooter" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="ActorSystemBooterextendsAnyRef"></a>
<a id="ActorSystemBooter:ActorSystemBooter"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a href="ActorSystemBooter.html"><span class="name">ActorSystemBooter</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.util.package@ActorSystemBooterextendsAnyRef" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">ActorSystemBooter start a new JVM process to boot an actor system.</p><div class="fullcomment"><div class="comment cmt"><p>ActorSystemBooter start a new JVM process to boot an actor system.
All executors are started by ActorSystemBooter</p><p>It send the system address to &quot;report back actor&quot;
</p></div></div>
</li><li name="org.apache.gearpump.util.AkkaApp" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped">
<a id="AkkaAppextendsAnyRef"></a>
<a id="AkkaApp:AkkaApp"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">trait</span>
</span>
<span class="symbol">
<a href="AkkaApp.html"><span class="name">AkkaApp</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.util.package@AkkaAppextendsAnyRef" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">A Main class helper to load Akka configuration automatically.</p>
</li><li name="org.apache.gearpump.util.AkkaHelper" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="AkkaHelperextendsObject"></a>
<a id="AkkaHelper:AkkaHelper"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a href="AkkaHelper.html"><span class="name">AkkaHelper</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.util.package@AkkaHelperextendsObject" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li><li name="org.apache.gearpump.util.ConsoleOutput" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped">
<a id="ConsoleOutputextendsAnyRef"></a>
<a id="ConsoleOutput:ConsoleOutput"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">trait</span>
</span>
<span class="symbol">
<a href="ConsoleOutput.html"><span class="name">ConsoleOutput</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.util.package@ConsoleOutputextendsAnyRef" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li><li name="org.apache.gearpump.util.Graph" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="Graph[N,E]extendsSerializable"></a>
<a id="Graph[N,E]:Graph[N,E]"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a href="Graph.html"><span class="name">Graph</span></a><span class="tparams">[<span name="N">N</span>, <span name="E">E</span>]</span><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.util.package@Graph[N,E]extendsSerializable" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Generic mutable Graph libraries.</p>
</li><li name="org.apache.gearpump.util.HadoopFSLogAppender" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="HadoopFSLogAppenderextendsRollingFileAppender"></a>
<a id="HadoopFSLogAppender:HadoopFSLogAppender"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a href="HadoopFSLogAppender.html"><span class="name">HadoopFSLogAppender</span></a><span class="result"> extends <span class="extype" name="org.apache.log4j.RollingFileAppender">RollingFileAppender</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.gearpump.util.package@HadoopFSLogAppenderextendsRollingFileAppender" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li><li name="org.apache.gearpump.util.HistoryMetricsService" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="HistoryMetricsServiceextendsActor"></a>
<a id="HistoryMetricsService:HistoryMetricsService"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a href="HistoryMetricsService.html"><span class="name">HistoryMetricsService</span></a><span class="result"> extends <span class="extype" name="akka.actor.Actor">Actor</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.gearpump.util.package@HistoryMetricsServiceextendsActor" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Metrics service to serve history metrics data</p><div class="fullcomment"><div class="comment cmt"><p>Metrics service to serve history metrics data</p><p>For simplicity, HistoryMetricsService will maintain 72 hours coarse-grained data
for last 72 hours, and fine-grained data for past 5 min.</p><p>For the coarse-grained data of past 72 hours, one or two sample point will be stored
for each hour.</p><p>For fine-grained data in last 5 min, there will be 1 sample point per 15 seconds.
</p></div></div>
</li><li name="org.apache.gearpump.util.ProcessLogRedirector" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="ProcessLogRedirectorextendsProcessLoggerwithCloseablewithFlushablewithConsoleOutput"></a>
<a id="ProcessLogRedirector:ProcessLogRedirector"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a href="ProcessLogRedirector.html"><span class="name">ProcessLogRedirector</span></a><span class="result"> extends <span class="extype" name="scala.sys.process.ProcessLogger">ProcessLogger</span> with <span class="extype" name="java.io.Closeable">Closeable</span> with <span class="extype" name="java.io.Flushable">Flushable</span> with <a href="ConsoleOutput.html" class="extype" name="org.apache.gearpump.util.ConsoleOutput">ConsoleOutput</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.gearpump.util.package@ProcessLogRedirectorextendsProcessLoggerwithCloseablewithFlushablewithConsoleOutput" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Redirect the console output to parent process</p>
</li><li name="org.apache.gearpump.util.RecreateRollingFileAppender" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="RecreateRollingFileAppenderextendsRollingFileAppender"></a>
<a id="RecreateRollingFileAppender:RecreateRollingFileAppender"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a href="RecreateRollingFileAppender.html"><span class="name">RecreateRollingFileAppender</span></a><span class="result"> extends <span class="extype" name="org.apache.log4j.RollingFileAppender">RollingFileAppender</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.gearpump.util.package@RecreateRollingFileAppenderextendsRollingFileAppender" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li><li name="org.apache.gearpump.util.ReferenceEqual" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped">
<a id="ReferenceEqualextendsAnyRef"></a>
<a id="ReferenceEqual:ReferenceEqual"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">trait</span>
</span>
<span class="symbol">
<a href="ReferenceEqual.html"><span class="name">ReferenceEqual</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.util.package@ReferenceEqualextendsAnyRef" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Check equal using reference-equal.</p>
</li><li name="org.apache.gearpump.util.RestartPolicy" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="RestartPolicyextendsAnyRef"></a>
<a id="RestartPolicy:RestartPolicy"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a href="RestartPolicy.html"><span class="name">RestartPolicy</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.util.package@RestartPolicyextendsAnyRef" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">When one executor or task fails, Gearpump will try to start.</p><div class="fullcomment"><div class="comment cmt"><p>When one executor or task fails, Gearpump will try to start. However, if it fails after
multiple retries, then we abort.
</p></div></div>
</li><li name="org.apache.gearpump.util.RichProcess" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="RichProcessextendsProcess"></a>
<a id="RichProcess:RichProcess"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a href="RichProcess.html"><span class="name">RichProcess</span></a><span class="result"> extends <span class="extype" name="scala.sys.process.Process">Process</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.gearpump.util.package@RichProcessextendsProcess" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Extends Process by providing a additional logger: ConsoleOutput interface.</p>
</li><li name="org.apache.gearpump.util.TimeOutScheduler" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped">
<a id="TimeOutSchedulerextendsAnyRef"></a>
<a id="TimeOutScheduler:TimeOutScheduler"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">trait</span>
</span>
<span class="symbol">
<a href="TimeOutScheduler.html"><span class="name">TimeOutScheduler</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.util.package@TimeOutSchedulerextendsAnyRef" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">A helper util to send a message to remote actor and notify callback when timeout</p>
</li></ol>
</div>
<div id="values" class="values members">
<h3>Value Members</h3>
<ol><li name="org.apache.gearpump.util.ActorSystemBooter" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="ActorSystemBooter"></a>
<a id="ActorSystemBooter:ActorSystemBooter"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="ActorSystemBooter$.html"><span class="name">ActorSystemBooter</span></a>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.gearpump.util.package@ActorSystemBooter" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li><li name="org.apache.gearpump.util.ActorUtil" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="ActorUtil"></a>
<a id="ActorUtil:ActorUtil"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="ActorUtil$.html"><span class="name">ActorUtil</span></a>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.gearpump.util.package@ActorUtil" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li><li name="org.apache.gearpump.util.Constants" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="Constants"></a>
<a id="Constants:Constants"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="Constants$.html"><span class="name">Constants</span></a>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.gearpump.util.package@Constants" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li><li name="org.apache.gearpump.util.FileUtils" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="FileUtils"></a>
<a id="FileUtils:FileUtils"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="FileUtils$.html"><span class="name">FileUtils</span></a>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.gearpump.util.package@FileUtils" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li><li name="org.apache.gearpump.util.Graph" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="Graph"></a>
<a id="Graph:Graph"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="Graph$.html"><span class="name">Graph</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.util.package@Graph" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li><li name="org.apache.gearpump.util.HistoryMetricsService" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="HistoryMetricsService"></a>
<a id="HistoryMetricsService:HistoryMetricsService"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="HistoryMetricsService$.html"><span class="name">HistoryMetricsService</span></a>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.gearpump.util.package@HistoryMetricsService" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li><li name="org.apache.gearpump.util.LogUtil" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="LogUtil"></a>
<a id="LogUtil:LogUtil"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="LogUtil$.html"><span class="name">LogUtil</span></a>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.gearpump.util.package@LogUtil" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li><li name="org.apache.gearpump.util.Util" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="Util"></a>
<a id="Util:Util"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="Util$.html"><span class="name">Util</span></a>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.gearpump.util.package@Util" 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>