<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_40) on Fri Oct 18 06:47:24 UTC 2013 -->
<title>AbstractHeartBeat (MX4J API)</title>
<meta name="date" content="2013-10-18">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AbstractHeartBeat (MX4J API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AbstractHeartBeat.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../mx4j/remote/AbstractRemoteNotificationClientHandler.html" title="class in mx4j.remote"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?mx4j/remote/AbstractHeartBeat.html" target="_top">Frames</a></li>
<li><a href="AbstractHeartBeat.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">mx4j.remote</div>
<h2 title="Class AbstractHeartBeat" class="title">Class AbstractHeartBeat</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>mx4j.remote.AbstractHeartBeat</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.Runnable, <a href="../../mx4j/remote/HeartBeat.html" title="interface in mx4j.remote">HeartBeat</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../mx4j/tools/remote/http/HTTPHeartBeat.html" title="class in mx4j.tools.remote.http">HTTPHeartBeat</a>, <a href="../../mx4j/remote/rmi/RMIHeartBeat.html" title="class in mx4j.remote.rmi">RMIHeartBeat</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">AbstractHeartBeat</span>
extends java.lang.Object
implements <a href="../../mx4j/remote/HeartBeat.html" title="interface in mx4j.remote">HeartBeat</a>, java.lang.Runnable</pre>
<div class="block">Base implementation for the HeartBeat interface.</div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>$Revision: 1.4 $</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><strong><a href="../../mx4j/remote/AbstractHeartBeat.html#AbstractHeartBeat(mx4j.remote.ConnectionNotificationEmitter, java.util.Map)">AbstractHeartBeat</a></strong>(<a href="../../mx4j/remote/ConnectionNotificationEmitter.html" title="class in mx4j.remote">ConnectionNotificationEmitter</a> emitter,
java.util.Map environment)</code>
<div class="block">Creates a new HeartBeat.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../mx4j/remote/AbstractHeartBeat.html#getMaxRetries()">getMaxRetries</a></strong>()</code>
<div class="block">Returns the maximum number of retries this heart beat attempts after
a first connection failure before declaring the connection or the server
as dead.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../mx4j/remote/AbstractHeartBeat.html#getPulsePeriod()">getPulsePeriod</a></strong>()</code>
<div class="block">Returns the period of time in milliseconds between two heart beats</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected abstract void</code></td>
<td class="colLast"><code><strong><a href="../../mx4j/remote/AbstractHeartBeat.html#pulse()">pulse</a></strong>()</code>
<div class="block">Subclasses will implement this method using protocol specific connections.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../mx4j/remote/AbstractHeartBeat.html#run()">run</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../mx4j/remote/AbstractHeartBeat.html#sendConnectionNotificationFailed()">sendConnectionNotificationFailed</a></strong>()</code>
<div class="block">Sends the connection failed notification using the emitter specified in
<a href="../../mx4j/remote/AbstractHeartBeat.html#AbstractHeartBeat(mx4j.remote.ConnectionNotificationEmitter, java.util.Map)"><code>AbstractHeartBeat(mx4j.remote.ConnectionNotificationEmitter, java.util.Map)</code></a></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../mx4j/remote/AbstractHeartBeat.html#start()">start</a></strong>()</code>
<div class="block">Starts the heart beat</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../mx4j/remote/AbstractHeartBeat.html#stop()">stop</a></strong>()</code>
<div class="block">Stops the heart beat</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AbstractHeartBeat(mx4j.remote.ConnectionNotificationEmitter, java.util.Map)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractHeartBeat</h4>
<pre>protected AbstractHeartBeat(<a href="../../mx4j/remote/ConnectionNotificationEmitter.html" title="class in mx4j.remote">ConnectionNotificationEmitter</a> emitter,
java.util.Map environment)</pre>
<div class="block">Creates a new HeartBeat.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>emitter</code> - The NotificationEmitter that sends connection failures notifications.</dd><dd><code>environment</code> - The environment that may contain properties that specify heart beat's behavior</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../mx4j/remote/AbstractHeartBeat.html#sendConnectionNotificationFailed()"><code>sendConnectionNotificationFailed()</code></a>,
<a href="../../mx4j/remote/MX4JRemoteConstants.html#CONNECTION_HEARTBEAT_PERIOD"><code>MX4JRemoteConstants.CONNECTION_HEARTBEAT_PERIOD</code></a>,
<a href="../../mx4j/remote/MX4JRemoteConstants.html#CONNECTION_HEARTBEAT_RETRIES"><code>MX4JRemoteConstants.CONNECTION_HEARTBEAT_RETRIES</code></a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getPulsePeriod()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPulsePeriod</h4>
<pre>public long getPulsePeriod()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../mx4j/remote/HeartBeat.html#getPulsePeriod()">HeartBeat</a></code></strong></div>
<div class="block">Returns the period of time in milliseconds between two heart beats</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../mx4j/remote/HeartBeat.html#getPulsePeriod()">getPulsePeriod</a></code> in interface <code><a href="../../mx4j/remote/HeartBeat.html" title="interface in mx4j.remote">HeartBeat</a></code></dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../mx4j/remote/MX4JRemoteConstants.html#CONNECTION_HEARTBEAT_PERIOD"><code>MX4JRemoteConstants.CONNECTION_HEARTBEAT_PERIOD</code></a>,
<a href="../../mx4j/remote/HeartBeat.html#getMaxRetries()"><code>HeartBeat.getMaxRetries()</code></a></dd></dl>
</li>
</ul>
<a name="getMaxRetries()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxRetries</h4>
<pre>public int getMaxRetries()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../mx4j/remote/HeartBeat.html#getMaxRetries()">HeartBeat</a></code></strong></div>
<div class="block">Returns the maximum number of retries this heart beat attempts after
a first connection failure before declaring the connection or the server
as dead.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../mx4j/remote/HeartBeat.html#getMaxRetries()">getMaxRetries</a></code> in interface <code><a href="../../mx4j/remote/HeartBeat.html" title="interface in mx4j.remote">HeartBeat</a></code></dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../mx4j/remote/MX4JRemoteConstants.html#CONNECTION_HEARTBEAT_RETRIES"><code>MX4JRemoteConstants.CONNECTION_HEARTBEAT_RETRIES</code></a>,
<a href="../../mx4j/remote/HeartBeat.html#getPulsePeriod()"><code>HeartBeat.getPulsePeriod()</code></a></dd></dl>
</li>
</ul>
<a name="pulse()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pulse</h4>
<pre>protected abstract void pulse()
throws java.io.IOException</pre>
<div class="block">Subclasses will implement this method using protocol specific connections.
Normally the method <code>MBeanServerConnection.getDefaultDomain()</code> is used
to "ping" the server side.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="start()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre>public void start()
throws java.io.IOException</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../mx4j/remote/HeartBeat.html#start()">HeartBeat</a></code></strong></div>
<div class="block">Starts the heart beat</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../mx4j/remote/HeartBeat.html#start()">start</a></code> in interface <code><a href="../../mx4j/remote/HeartBeat.html" title="interface in mx4j.remote">HeartBeat</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If there are problems contacting the server</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../mx4j/remote/HeartBeat.html#stop()"><code>HeartBeat.stop()</code></a></dd></dl>
</li>
</ul>
<a name="stop()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre>public void stop()
throws java.io.IOException</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../mx4j/remote/HeartBeat.html#stop()">HeartBeat</a></code></strong></div>
<div class="block">Stops the heart beat</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../mx4j/remote/HeartBeat.html#stop()">stop</a></code> in interface <code><a href="../../mx4j/remote/HeartBeat.html" title="interface in mx4j.remote">HeartBeat</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If there are problems contacting the server</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../mx4j/remote/HeartBeat.html#start()"><code>HeartBeat.start()</code></a></dd></dl>
</li>
</ul>
<a name="run()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>run</h4>
<pre>public void run()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>run</code> in interface <code>java.lang.Runnable</code></dd>
</dl>
</li>
</ul>
<a name="sendConnectionNotificationFailed()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>sendConnectionNotificationFailed</h4>
<pre>protected void sendConnectionNotificationFailed()</pre>
<div class="block">Sends the connection failed notification using the emitter specified in
<a href="../../mx4j/remote/AbstractHeartBeat.html#AbstractHeartBeat(mx4j.remote.ConnectionNotificationEmitter, java.util.Map)"><code>AbstractHeartBeat(mx4j.remote.ConnectionNotificationEmitter, java.util.Map)</code></a></div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AbstractHeartBeat.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../mx4j/remote/AbstractRemoteNotificationClientHandler.html" title="class in mx4j.remote"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?mx4j/remote/AbstractHeartBeat.html" target="_top">Frames</a></li>
<li><a href="AbstractHeartBeat.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><center><small>Copyright © 2001-2005 The MX4J Contributors. All Rights Reserved.</small></center></small></p>
</body>
</html>
