http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/54a3e718/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/SystemFailure.html ---------------------------------------------------------------------- diff --git a/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/SystemFailure.html b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/SystemFailure.html new file mode 100644 index 0000000..92a31d1 --- /dev/null +++ b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/SystemFailure.html @@ -0,0 +1,1088 @@ +<!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 (1.8.0_45) on Fri Mar 11 16:13:08 PST 2016 --> +<title>SystemFailure (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)</title> +<meta name="date" content="2016-03-11"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SystemFailure (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":9,"i16":9,"i17":9,"i18":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<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="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><a href="../../../com/gemstone/gemfire/SystemConnectException.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../com/gemstone/gemfire/SystemIsRunningException.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/gemstone/gemfire/SystemFailure.html" target="_top">Frames</a></li> +<li><a href="SystemFailure.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><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </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">com.gemstone.gemfire</div> +<h2 title="Class SystemFailure" class="title">Class SystemFailure</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.gemstone.gemfire.SystemFailure</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">SystemFailure</span> +extends java.lang.Object</pre> +<div class="block">Catches and responds to JVM failure + <p> + This class represents a catastrophic failure of the system, + especially the Java virtual machine. Any class may, + at any time, indicate that a system failure has occurred by calling + <a href="../../../com/gemstone/gemfire/SystemFailure.html#initiateFailure-java.lang.Error-"><code>initiateFailure(Error)</code></a> (or, less commonly, + <a href="../../../com/gemstone/gemfire/SystemFailure.html#setFailure-java.lang.Error-"><code>setFailure(Error)</code></a>). + <p> + In practice, the most common type of failure that is likely to be + reported by an otherwise healthy JVM is <code>OutOfMemoryError</code>. However, + GemFire will report any occurrence of <code>VirtualMachineError</code> as + a JVM failure. + <p> + When a failure is reported, you must assume that the JVM has <em>broken + its fundamental execution contract</em> with your application. + No programming invariant can be assumed to be true, and your + entire application must be regarded as corrupted. + <h1>Failure Hooks</h1> + GemFire uses this class to disable its distributed system (group + communication) and any open caches. It also provides a hook for you + to respond to after GemFire disables itself. + <h1>Failure WatchDog</h1> + When <a href="../../../com/gemstone/gemfire/SystemFailure.html#startThreads--"><code>startThreads()</code></a> is called, a "watchdog" <code>Thread</code> is started that + periodically checks to see if system corruption has been reported. When + system corruption is detected, this thread proceeds to: + <p> + <ol> + <li> + <em>Close GemFire</em> -- Group communication is ceased (this cache + member recuses itself from the distributed system) and the cache + is further poisoned (it is pointless to try to cleanly close it at this + point.). + <p> + After this has successfully ended, we launch a + </li> + <li> + <em>failure action</em>, a user-defined Runnable + <a href="../../../com/gemstone/gemfire/SystemFailure.html#setFailureAction-java.lang.Runnable-"><code>setFailureAction(Runnable)</code></a>. + By default, this Runnable performs nothing. If you feel you need to perform + an action before exiting the JVM, this hook gives you a + means of attempting some action. Whatever you attempt should be extremely + simple, since your Java execution environment has been corrupted. + <p> + GemStone recommends that you employ + <a href="http://wrapper.tanukisoftware.org/doc/english/introduction.html"> + Java Service Wrapper</a> to detect when your JVM exits and to perform + appropriate failure and restart actions. + </li> + <li> + Finally, if the application has granted the watchdog permission to exit the JVM + (via <a href="../../../com/gemstone/gemfire/SystemFailure.html#setExitOK-boolean-"><code>setExitOK(boolean)</code></a>), the watchdog calls <code>System.exit(int)</code> with + an argument of 1. If you have not granted this class permission to + close the JVM, you are <em>strongly</em> advised to call it in your + failure action (in the previous step). + </li> + </ol> + <p> + Each of these actions will be run exactly once in the above described + order. However, if either step throws any type of error (<code>Throwable</code>), + the watchdog will assume that the JVM is still under duress (esp. an + <code>OutOfMemoryError</code>), will wait a bit, and then retry the failed action. + <p> + It bears repeating that you should be very cautious of any Runnables you + ask this class to run. By definition the JVM is <em>very sick</em> + when failure has been signalled. + <p> + <h1>Failure Proctor</h1> + In addition to the failure watchdog, <a href="../../../com/gemstone/gemfire/SystemFailure.html#startThreads--"><code>startThreads()</code></a> creates a second + thread (the "proctor") that monitors free memory. It does this by examining + <code>free memory</code>, + <code>total memory</code> and + <code>maximum memory</code>. If the amount of available + memory stays below a given + <a href="../../../com/gemstone/gemfire/SystemFailure.html#setFailureMemoryThreshold-long-"><code>threshold</code></a>, for + more than <a href="../../../com/gemstone/gemfire/SystemFailure.html#WATCHDOG_WAIT"><code>WATCHDOG_WAIT</code></a> seconds, the watchdog is notified. + <p> + Note that the proctor can be effectively disabled by + <a href="../../../com/gemstone/gemfire/SystemFailure.html#setFailureMemoryThreshold-long-"><code>setting</code></a> the failure memory threshold + to a negative value. + <p> + The proctor is a second line of defense, attempting to detect + OutOfMemoryError conditions in circumstances where nothing alerted the + watchdog. For instance, a third-party jar might incorrectly handle this + error and leave your virtual machine in a "stuck" state. + <p> + Note that the proctor does not relieve you of the obligation to + follow the best practices in the next section. + <h1>Best Practices</h1> + <h2>Catch and Handle VirtualMachineError</h2> + If you feel obliged to catch <em>either</em> <code>Error</code>, or + <code>Throwable</code>, you <em>must</em>also check for + <code>VirtualMachineError</code> like so: + <p> + <pre> + catch (VirtualMachineError err) { + SystemFailure.<a href="../../../com/gemstone/gemfire/SystemFailure.html#initiateFailure-java.lang.Error-"><code>initiateFailure</code></a>(err); + // If this ever returns, rethrow the error. We're poisoned + // now, so don't let this thread continue. + throw err; + } + </pre> + <h2>Periodically Check For Errors</h2> + Check for serious system errors at + appropriate points in your algorithms. You may elect to use + the <a href="../../../com/gemstone/gemfire/SystemFailure.html#checkFailure--"><code>checkFailure()</code></a> utility function, but you are + not required to (you could just see if <a href="../../../com/gemstone/gemfire/SystemFailure.html#getFailure--"><code>getFailure()</code></a> + returns a non-null result). + <p> + A job processing loop is a good candidate, for + instance, in com.gemstone.org.jgroups.protocols.UDP#run(), + which implements <code>Thread.run()</code>: + <p> + <pre> + for (;;) { + SystemFailure.<a href="../../../com/gemstone/gemfire/SystemFailure.html#checkFailure--"><code>checkFailure</code></a>(); + if (mcast_recv_sock == null || mcast_recv_sock.isClosed()) break; + if (Thread.currentThread().isInterrupted()) break; + ... + </pre> + <h2>Create Logging ThreadGroups</h2> + If you create any Thread, a best practice is to catch severe errors + and signal failure appropriately. One trick to do this is to create a + ThreadGroup that handles uncaught exceptions by overriding + <code>ThreadGroup.uncaughtException(Thread, Throwable)</code> and to declare + your thread as a member of that <code>ThreadGroup</code>. This also has a + significant side-benefit in that most uncaught exceptions + can be detected: + <p> + <pre> + ThreadGroup tg = new ThreadGroup("Worker Threads") { + public void uncaughtException(Thread t, Throwable e) { + // Do this *before* any object allocation in case of + // OutOfMemoryError (for instance) + if (e instanceof VirtualMachineError) { + SystemFailure.<a href="../../../com/gemstone/gemfire/SystemFailure.html#setFailure-java.lang.Error-"><code>setFailure</code></a>((VirtualMachineError)e); // don't throw + } + String s = "Uncaught exception in thread " + t; + system.getLogWriter().severe(s, e); + } + Thread t = new Thread(myRunnable, tg, "My Thread"); + t.start(); + }; * </pre> + <p> + <h2>Catches of Error and Throwable Should Check for Failure</h2> + Keep in mind that peculiar or flat-out<em>impossible</em> exceptions may + ensue after a VirtualMachineError has been thrown <em>anywhere</em> in + your virtual machine. Whenever you catch <code>Error</code> or <code>Throwable</code>, + you should also make sure that you aren't dealing with a corrupted JVM: + <p> + <pre> + catch (Throwable t) { + // Whenever you catch Error or Throwable, you must also + // catch VirtualMachineError (see above). However, there is + // _still_ a possibility that you are dealing with a cascading + // error condition, so you also need to check to see if the JVM + // is still usable: + SystemFailure.<a href="../../../com/gemstone/gemfire/SystemFailure.html#checkFailure--"><code>checkFailure</code></a>(); + ... + } + </pre></div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>5.1</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemFailure.html#DISTRIBUTED_SYSTEM_DISCONNECTED_MESSAGE">DISTRIBUTED_SYSTEM_DISCONNECTED_MESSAGE</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemFailure.html#DISTRIBUTION_HALTED_MESSAGE">DISTRIBUTION_HALTED_MESSAGE</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected static java.lang.Error</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemFailure.html#failure">failure</a></span></code> +<div class="block">the underlying failure + + This is usually an instance of <code>VirtualMachineError</code>, but it + is not required to be such.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemFailure.html#MEMORY_MAX_WAIT">MEMORY_MAX_WAIT</a></span></code> +<div class="block">This is the maximum amount of time, in seconds, that the proctor thread + will tolerate seeing free memory stay below + <a href="../../../com/gemstone/gemfire/SystemFailure.html#setFailureMemoryThreshold-long-"><code>setFailureMemoryThreshold(long)</code></a>, after which point it will + declare a system failure.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemFailure.html#MEMORY_POLL_INTERVAL">MEMORY_POLL_INTERVAL</a></span></code> +<div class="block">This is the interval, in seconds, that the proctor + thread will awaken and poll system free memory.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemFailure.html#MONITOR_MEMORY">MONITOR_MEMORY</a></span></code> +<div class="block">Flag that determines whether or not we monitor memory on our own.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemFailure.html#PROCTOR_NAME">PROCTOR_NAME</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemFailure.html#TRACE_CLOSE">TRACE_CLOSE</a></span></code> +<div class="block">If true, we track the progress of emergencyClose + on System.err</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemFailure.html#WATCHDOG_NAME">WATCHDOG_NAME</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemFailure.html#WATCHDOG_WAIT">WATCHDOG_WAIT</a></span></code> +<div class="block">This is the amount of time, in seconds, the watchdog periodically awakens + to see if the system has been corrupted.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemFailure.html#checkFailure--">checkFailure</a></span>()</code> +<div class="block">Utility function to check for failures.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemFailure.html#emergencyClose--">emergencyClose</a></span>()</code> +<div class="block">Attempt to close any and all GemFire resources.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static java.lang.Error</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemFailure.html#getFailure--">getFailure</a></span>()</code> +<div class="block">Returns the catastrophic system failure, if any.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemFailure.html#initiateFailure-java.lang.Error-">initiateFailure</a></span>(java.lang.Error f)</code> +<div class="block">Signals that a system failure has occurred and then throws an + AssertionError.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemFailure.html#isJVMFailureError-java.lang.Error-">isJVMFailureError</a></span>(java.lang.Error err)</code> +<div class="block">Returns true if the given Error is a fatal to the JVM and it should be shut + down.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemFailure.html#loadEmergencyClasses--">loadEmergencyClasses</a></span>()</code> +<div class="block">Since it requires object memory to unpack a jar file, + make sure this JVM has loaded the classes necessary for + closure <em>before</em> it becomes necessary to use them.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>protected static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemFailure.html#logFine-java.lang.String-java.lang.String-">logFine</a></span>(java.lang.String name, + java.lang.String s)</code> +<div class="block">Logging can require allocation of objects, so we wrap the + logger so that failures are silently ignored.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>protected static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemFailure.html#logInfo-java.lang.String-java.lang.String-">logInfo</a></span>(java.lang.String name, + java.lang.String s)</code> +<div class="block">Logging can require allocation of objects, so we wrap the + logger so that failures are silently ignored.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>protected static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemFailure.html#logWarning-java.lang.String-java.lang.String-java.lang.Throwable-">logWarning</a></span>(java.lang.String name, + java.lang.String s, + java.lang.Throwable t)</code> +<div class="block">Logging can require allocation of objects, so we wrap the + logger so that failures are silently ignored.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>protected static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemFailure.html#runProctor--">runProctor</a></span>()</code> +<div class="block">This is the run loop for the proctor thread (formally known + as the "watchcat" (grin)</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>protected static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemFailure.html#runWatchDog--">runWatchDog</a></span>()</code> +<div class="block">This is the run loop for the watchdog thread.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemFailure.html#setExitOK-boolean-">setExitOK</a></span>(boolean newVal)</code> +<div class="block">Indicate whether it is acceptable to call <code>System.exit(int)</code> after + failure processing has completed.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemFailure.html#setFailure-java.lang.Error-">setFailure</a></span>(java.lang.Error failure)</code> +<div class="block">Set the underlying system failure, if not already set.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>static java.lang.Runnable</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemFailure.html#setFailureAction-java.lang.Runnable-">setFailureAction</a></span>(java.lang.Runnable action)</code> +<div class="block">Sets a user-defined action that is run in the event + that failure has been detected.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemFailure.html#setFailureMemoryThreshold-long-">setFailureMemoryThreshold</a></span>(long newVal)</code> +<div class="block">Set the memory threshold under which system failure will be + notified.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemFailure.html#signalCacheClose--">signalCacheClose</a></span>()</code> +<div class="block">Should be invoked when GemFire cache is closing or closed.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemFailure.html#signalCacheCreate--">signalCacheCreate</a></span>()</code> +<div class="block">Should be invoked when GemFire cache is being created.</div> +</td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemFailure.html#startThreads--">startThreads</a></span>()</code> +<div class="block">This starts up the watchdog and proctor threads.</div> +</td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemFailure.html#stopThreads--">stopThreads</a></span>()</code> +<div class="block">This stops the threads that implement this service.</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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="DISTRIBUTION_HALTED_MESSAGE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DISTRIBUTION_HALTED_MESSAGE</h4> +<pre>public static final java.lang.String DISTRIBUTION_HALTED_MESSAGE</pre> +</li> +</ul> +<a name="DISTRIBUTED_SYSTEM_DISCONNECTED_MESSAGE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DISTRIBUTED_SYSTEM_DISCONNECTED_MESSAGE</h4> +<pre>public static final java.lang.String DISTRIBUTED_SYSTEM_DISCONNECTED_MESSAGE</pre> +</li> +</ul> +<a name="failure"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>failure</h4> +<pre>protected static volatile java.lang.Error failure</pre> +<div class="block">the underlying failure + + This is usually an instance of <code>VirtualMachineError</code>, but it + is not required to be such.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../com/gemstone/gemfire/SystemFailure.html#getFailure--"><code>getFailure()</code></a>, +<a href="../../../com/gemstone/gemfire/SystemFailure.html#initiateFailure-java.lang.Error-"><code>initiateFailure(Error)</code></a></dd> +</dl> +</li> +</ul> +<a name="WATCHDOG_WAIT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>WATCHDOG_WAIT</h4> +<pre>public static final int WATCHDOG_WAIT</pre> +<div class="block">This is the amount of time, in seconds, the watchdog periodically awakens + to see if the system has been corrupted. + <p> + The watchdog will be explicitly awakened by calls to + <a href="../../../com/gemstone/gemfire/SystemFailure.html#setFailure-java.lang.Error-"><code>setFailure(Error)</code></a> or <a href="../../../com/gemstone/gemfire/SystemFailure.html#initiateFailure-java.lang.Error-"><code>initiateFailure(Error)</code></a>, but + it will awaken of its own accord periodically to check for failure even + if the above calls do not occur. + <p> + This can be set with the system property + <code>gemfire.WATCHDOG_WAIT</code>. The default is 15 sec.</div> +</li> +</ul> +<a name="MEMORY_POLL_INTERVAL"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MEMORY_POLL_INTERVAL</h4> +<pre>public static final long MEMORY_POLL_INTERVAL</pre> +<div class="block">This is the interval, in seconds, that the proctor + thread will awaken and poll system free memory. + + The default is 1 sec. This can be set using the system property + <code>gemfire.SystemFailure.MEMORY_POLL_INTERVAL</code>.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../com/gemstone/gemfire/SystemFailure.html#setFailureMemoryThreshold-long-"><code>setFailureMemoryThreshold(long)</code></a></dd> +</dl> +</li> +</ul> +<a name="MEMORY_MAX_WAIT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MEMORY_MAX_WAIT</h4> +<pre>public static final long MEMORY_MAX_WAIT</pre> +<div class="block">This is the maximum amount of time, in seconds, that the proctor thread + will tolerate seeing free memory stay below + <a href="../../../com/gemstone/gemfire/SystemFailure.html#setFailureMemoryThreshold-long-"><code>setFailureMemoryThreshold(long)</code></a>, after which point it will + declare a system failure. + + The default is 15 sec. This can be set using the system property + <code>gemfire.SystemFailure.MEMORY_MAX_WAIT</code>.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../com/gemstone/gemfire/SystemFailure.html#setFailureMemoryThreshold-long-"><code>setFailureMemoryThreshold(long)</code></a></dd> +</dl> +</li> +</ul> +<a name="MONITOR_MEMORY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MONITOR_MEMORY</h4> +<pre>public static final boolean MONITOR_MEMORY</pre> +<div class="block">Flag that determines whether or not we monitor memory on our own. + If this flag is set, we will check freeMemory, invoke GC if free memory + gets low, and start throwing our own OutOfMemoryException if + + The default is false, so this monitoring is turned off. This monitoring has been found + to be unreliable in non-Sun VMs when the VM is under stress or behaves in unpredictable ways.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>6.5</dd> +</dl> +</li> +</ul> +<a name="TRACE_CLOSE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TRACE_CLOSE</h4> +<pre>public static final boolean TRACE_CLOSE</pre> +<div class="block">If true, we track the progress of emergencyClose + on System.err</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../constant-values.html#com.gemstone.gemfire.SystemFailure.TRACE_CLOSE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="WATCHDOG_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>WATCHDOG_NAME</h4> +<pre>protected static final java.lang.String WATCHDOG_NAME</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../constant-values.html#com.gemstone.gemfire.SystemFailure.WATCHDOG_NAME">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="PROCTOR_NAME"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PROCTOR_NAME</h4> +<pre>protected static final java.lang.String PROCTOR_NAME</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../constant-values.html#com.gemstone.gemfire.SystemFailure.PROCTOR_NAME">Constant Field Values</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="setExitOK-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setExitOK</h4> +<pre>public static boolean setExitOK(boolean newVal)</pre> +<div class="block">Indicate whether it is acceptable to call <code>System.exit(int)</code> after + failure processing has completed. + <p> + This may be dynamically modified while the system is running.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>newVal</code> - true if it is OK to exit the process</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the previous value</dd> +</dl> +</li> +</ul> +<a name="isJVMFailureError-java.lang.Error-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isJVMFailureError</h4> +<pre>public static boolean isJVMFailureError(java.lang.Error err)</pre> +<div class="block">Returns true if the given Error is a fatal to the JVM and it should be shut + down. Code should call <a href="../../../com/gemstone/gemfire/SystemFailure.html#initiateFailure-java.lang.Error-"><code>initiateFailure(Error)</code></a> or + <a href="../../../com/gemstone/gemfire/SystemFailure.html#setFailure-java.lang.Error-"><code>setFailure(Error)</code></a> if this returns true.</div> +</li> +</ul> +<a name="signalCacheCreate--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>signalCacheCreate</h4> +<pre>public static void signalCacheCreate()</pre> +<div class="block">Should be invoked when GemFire cache is being created.</div> +</li> +</ul> +<a name="signalCacheClose--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>signalCacheClose</h4> +<pre>public static void signalCacheClose()</pre> +<div class="block">Should be invoked when GemFire cache is closing or closed.</div> +</li> +</ul> +<a name="runWatchDog--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>runWatchDog</h4> +<pre>protected static void runWatchDog()</pre> +<div class="block">This is the run loop for the watchdog thread.</div> +</li> +</ul> +<a name="runProctor--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>runProctor</h4> +<pre>protected static void runProctor()</pre> +<div class="block">This is the run loop for the proctor thread (formally known + as the "watchcat" (grin)</div> +</li> +</ul> +<a name="loadEmergencyClasses--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>loadEmergencyClasses</h4> +<pre>public static void loadEmergencyClasses()</pre> +<div class="block">Since it requires object memory to unpack a jar file, + make sure this JVM has loaded the classes necessary for + closure <em>before</em> it becomes necessary to use them. + <p> + Note that just touching the class in order to load it + is usually sufficient, so all an implementation needs + to do is to reference the same classes used in + <a href="../../../com/gemstone/gemfire/SystemFailure.html#emergencyClose--"><code>emergencyClose()</code></a>. Just make sure to do it while + you still have memory to succeed!</div> +</li> +</ul> +<a name="emergencyClose--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>emergencyClose</h4> +<pre>public static void emergencyClose()</pre> +<div class="block">Attempt to close any and all GemFire resources. + + The contract of this method is that it should not + acquire any synchronization mutexes nor create any objects. + <p> + The former is because the system is in an undefined state and + attempting to acquire the mutex may cause a hang. + <p> + The latter is because the likelihood is that we are invoking + this method due to memory exhaustion, so any attempt to create + an object will also cause a hang. + <p> + This method is not meant to be called directly (but, well, I + guess it could). It is public to document the contract + that is implemented by <code>emergencyClose</code> in other + parts of the system.</div> +</li> +</ul> +<a name="checkFailure--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>checkFailure</h4> +<pre>public static void checkFailure() + throws <a href="../../../com/gemstone/gemfire/InternalGemFireError.html" title="class in com.gemstone.gemfire">InternalGemFireError</a>, + java.lang.Error</pre> +<div class="block">Utility function to check for failures. If a failure is + detected, this methods throws an AssertionFailure.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../com/gemstone/gemfire/InternalGemFireError.html" title="class in com.gemstone.gemfire">InternalGemFireError</a></code> - if the system has been corrupted</dd> +<dd><code>java.lang.Error</code> - if the system has been corrupted and a thread-specific + AssertionError cannot be allocated</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../com/gemstone/gemfire/SystemFailure.html#initiateFailure-java.lang.Error-"><code>initiateFailure(Error)</code></a></dd> +</dl> +</li> +</ul> +<a name="initiateFailure-java.lang.Error-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initiateFailure</h4> +<pre>public static void initiateFailure(java.lang.Error f) + throws <a href="../../../com/gemstone/gemfire/InternalGemFireError.html" title="class in com.gemstone.gemfire">InternalGemFireError</a>, + java.lang.Error</pre> +<div class="block">Signals that a system failure has occurred and then throws an + AssertionError.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>f</code> - the failure to set</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if f is null</dd> +<dd><code><a href="../../../com/gemstone/gemfire/InternalGemFireError.html" title="class in com.gemstone.gemfire">InternalGemFireError</a></code> - always; this method does not return normally.</dd> +<dd><code>java.lang.Error</code> - if a thread-specific AssertionError cannot be allocated.</dd> +</dl> +</li> +</ul> +<a name="setFailure-java.lang.Error-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFailure</h4> +<pre>public static void setFailure(java.lang.Error failure)</pre> +<div class="block">Set the underlying system failure, if not already set. + <p> + This method does not generate an error, and should only be used + in circumstances where execution needs to continue, such as when + re-implementing <code>ThreadGroup.uncaughtException(Thread, Throwable)</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>failure</code> - the system failure</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if you attempt to set the failure to null</dd> +</dl> +</li> +</ul> +<a name="getFailure--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFailure</h4> +<pre>public static java.lang.Error getFailure()</pre> +<div class="block">Returns the catastrophic system failure, if any. + <p> + This is usually (though not necessarily) an instance of + <code>VirtualMachineError</code>. + <p> + A return value of null indicates that no system failure has yet been + detected. + <p> + Object synchronization can implicitly require object creation (fat locks + in JRockit for instance), so the underlying value is not synchronized + (it is a volatile). This means the return value from this call is not + necessarily the <em>first</em> failure reported by the JVM. + <p> + Note that even if it <em>were</em> synchronized, it would only be a + proximal indicator near the time that the JVM crashed, and may not + actually reflect the underlying root cause that generated the failure. + For instance, if your JVM is running short of memory, this Throwable is + probably an innocent victim and <em>not</em> the actual allocation (or + series of allocations) that caused your JVM to exhaust memory. + <p> + If this function returns a non-null value, keep in mind that the JVM is + very limited. In particular, any attempt to allocate objects may fail + if the original failure was an OutOfMemoryError.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the failure, if any</dd> +</dl> +</li> +</ul> +<a name="setFailureAction-java.lang.Runnable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFailureAction</h4> +<pre>public static java.lang.Runnable setFailureAction(java.lang.Runnable action)</pre> +<div class="block">Sets a user-defined action that is run in the event + that failure has been detected. + <p> + This action is run <em>after</em> the GemFire cache has been shut down. + If it throws any error, it will be reattempted indefinitely until it + succeeds. This action may be dynamically modified while the system + is running. + <p> + The default action prints the failure stack trace to System.err.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>action</code> - the Runnable to use</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the previous action</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../com/gemstone/gemfire/SystemFailure.html#initiateFailure-java.lang.Error-"><code>initiateFailure(Error)</code></a></dd> +</dl> +</li> +</ul> +<a name="setFailureMemoryThreshold-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFailureMemoryThreshold</h4> +<pre>public static long setFailureMemoryThreshold(long newVal)</pre> +<div class="block">Set the memory threshold under which system failure will be + notified. + + This value may be dynamically modified while the system + is running. The default is 1048576 bytes. This can be set using the + system property <code>gemfire.SystemFailure.chronic_memory_threshold</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>newVal</code> - threshold in bytes</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the old threshold</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>Runtime.freeMemory()</code></dd> +</dl> +</li> +</ul> +<a name="logWarning-java.lang.String-java.lang.String-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>logWarning</h4> +<pre>protected static boolean logWarning(java.lang.String name, + java.lang.String s, + java.lang.Throwable t)</pre> +<div class="block">Logging can require allocation of objects, so we wrap the + logger so that failures are silently ignored.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>s</code> - string to print</dd> +<dd><code>t</code> - the call stack, if any</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if the warning got printed</dd> +</dl> +</li> +</ul> +<a name="logInfo-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>logInfo</h4> +<pre>protected static void logInfo(java.lang.String name, + java.lang.String s)</pre> +<div class="block">Logging can require allocation of objects, so we wrap the + logger so that failures are silently ignored.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>s</code> - string to print</dd> +</dl> +</li> +</ul> +<a name="logFine-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>logFine</h4> +<pre>protected static void logFine(java.lang.String name, + java.lang.String s)</pre> +<div class="block">Logging can require allocation of objects, so we wrap the + logger so that failures are silently ignored.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>s</code> - string to print</dd> +</dl> +</li> +</ul> +<a name="startThreads--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>startThreads</h4> +<pre>public static void startThreads()</pre> +<div class="block">This starts up the watchdog and proctor threads. + This method is called when a Cache is created.</div> +</li> +</ul> +<a name="stopThreads--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>stopThreads</h4> +<pre>public static void stopThreads()</pre> +<div class="block">This stops the threads that implement this service. + This method is called when a Cache is closed.</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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<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="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><a href="../../../com/gemstone/gemfire/SystemConnectException.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../com/gemstone/gemfire/SystemIsRunningException.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/gemstone/gemfire/SystemFailure.html" target="_top">Frames</a></li> +<li><a href="SystemFailure.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><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/54a3e718/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/SystemIsRunningException.html ---------------------------------------------------------------------- diff --git a/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/SystemIsRunningException.html b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/SystemIsRunningException.html new file mode 100644 index 0000000..4129dc4 --- /dev/null +++ b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/SystemIsRunningException.html @@ -0,0 +1,302 @@ +<!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 (1.8.0_45) on Fri Mar 11 16:13:08 PST 2016 --> +<title>SystemIsRunningException (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)</title> +<meta name="date" content="2016-03-11"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SystemIsRunningException (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<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="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><a href="../../../com/gemstone/gemfire/SystemFailure.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../com/gemstone/gemfire/ThreadInterruptedException.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/gemstone/gemfire/SystemIsRunningException.html" target="_top">Frames</a></li> +<li><a href="SystemIsRunningException.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="#methods.inherited.from.class.com.gemstone.gemfire.GemFireException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">com.gemstone.gemfire</div> +<h2 title="Class SystemIsRunningException" class="title">Class SystemIsRunningException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li>java.lang.RuntimeException</li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/gemstone/gemfire/GemFireException.html" title="class in com.gemstone.gemfire">com.gemstone.gemfire.GemFireException</a></li> +<li> +<ul class="inheritance"> +<li>com.gemstone.gemfire.SystemIsRunningException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">SystemIsRunningException</span> +extends <a href="../../../com/gemstone/gemfire/GemFireException.html" title="class in com.gemstone.gemfire">GemFireException</a></pre> +<div class="block">A <code>SystemIsRunningException</code> is thrown when an operation + is attempted that requires that the locator is stopped. + <p> + In some cases this exception may be thrown and the locator will + not be running. This will happen if the locator was not stopped + cleanly. + <p>As of GemFire 5.0 this exception should be named LocatorIsRunningException.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../serialized-form.html#com.gemstone.gemfire.SystemIsRunningException">Serialized Form</a></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="memberSummary" 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="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemIsRunningException.html#SystemIsRunningException--">SystemIsRunningException</a></span>()</code> +<div class="block">Creates a new <code>SystemIsRunningException</code>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/SystemIsRunningException.html#SystemIsRunningException-java.lang.String-">SystemIsRunningException</a></span>(java.lang.String message)</code> +<div class="block">Creates a new <code>SystemIsRunningException</code>.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.com.gemstone.gemfire.GemFireException"> +<!-- --> +</a> +<h3>Methods inherited from class com.gemstone.gemfire.<a href="../../../com/gemstone/gemfire/GemFireException.html" title="class in com.gemstone.gemfire">GemFireException</a></h3> +<code><a href="../../../com/gemstone/gemfire/GemFireException.html#getRootCause--">getRootCause</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, 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="SystemIsRunningException--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SystemIsRunningException</h4> +<pre>public SystemIsRunningException()</pre> +<div class="block">Creates a new <code>SystemIsRunningException</code>.</div> +</li> +</ul> +<a name="SystemIsRunningException-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SystemIsRunningException</h4> +<pre>public SystemIsRunningException(java.lang.String message)</pre> +<div class="block">Creates a new <code>SystemIsRunningException</code>.</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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<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="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><a href="../../../com/gemstone/gemfire/SystemFailure.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../com/gemstone/gemfire/ThreadInterruptedException.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/gemstone/gemfire/SystemIsRunningException.html" target="_top">Frames</a></li> +<li><a href="SystemIsRunningException.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="#methods.inherited.from.class.com.gemstone.gemfire.GemFireException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/54a3e718/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/ThreadInterruptedException.html ---------------------------------------------------------------------- diff --git a/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/ThreadInterruptedException.html b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/ThreadInterruptedException.html new file mode 100644 index 0000000..c8286dc --- /dev/null +++ b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/ThreadInterruptedException.html @@ -0,0 +1,258 @@ +<!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 (1.8.0_45) on Fri Mar 11 16:13:08 PST 2016 --> +<title>ThreadInterruptedException (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)</title> +<meta name="date" content="2016-03-11"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ThreadInterruptedException (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<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="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><a href="../../../com/gemstone/gemfire/SystemIsRunningException.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../com/gemstone/gemfire/ToDataException.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/gemstone/gemfire/ThreadInterruptedException.html" target="_top">Frames</a></li> +<li><a href="ThreadInterruptedException.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>Constr | </li> +<li><a href="#methods.inherited.from.class.com.gemstone.gemfire.cache.CacheRuntimeException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">com.gemstone.gemfire</div> +<h2 title="Class ThreadInterruptedException" class="title">Class ThreadInterruptedException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li>java.lang.RuntimeException</li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/gemstone/gemfire/GemFireException.html" title="class in com.gemstone.gemfire">com.gemstone.gemfire.GemFireException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/gemstone/gemfire/cache/CacheRuntimeException.html" title="class in com.gemstone.gemfire.cache">com.gemstone.gemfire.cache.CacheRuntimeException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/gemstone/gemfire/CancelException.html" title="class in com.gemstone.gemfire">com.gemstone.gemfire.CancelException</a></li> +<li> +<ul class="inheritance"> +<li>com.gemstone.gemfire.ThreadInterruptedException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">this class is no longer used</span></div> +</div> +<br> +<pre>@Deprecated +public final class <span class="typeNameLabel">ThreadInterruptedException</span> +extends <a href="../../../com/gemstone/gemfire/CancelException.html" title="class in com.gemstone.gemfire">CancelException</a></pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../serialized-form.html#com.gemstone.gemfire.ThreadInterruptedException">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.com.gemstone.gemfire.cache.CacheRuntimeException"> +<!-- --> +</a> +<h3>Methods inherited from class com.gemstone.gemfire.cache.<a href="../../../com/gemstone/gemfire/cache/CacheRuntimeException.html" title="class in com.gemstone.gemfire.cache">CacheRuntimeException</a></h3> +<code><a href="../../../com/gemstone/gemfire/cache/CacheRuntimeException.html#toString--">toString</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.com.gemstone.gemfire.GemFireException"> +<!-- --> +</a> +<h3>Methods inherited from class com.gemstone.gemfire.<a href="../../../com/gemstone/gemfire/GemFireException.html" title="class in com.gemstone.gemfire">GemFireException</a></h3> +<code><a href="../../../com/gemstone/gemfire/GemFireException.html#getRootCause--">getRootCause</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace</code></li> +</ul> +<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, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<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="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><a href="../../../com/gemstone/gemfire/SystemIsRunningException.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../com/gemstone/gemfire/ToDataException.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/gemstone/gemfire/ThreadInterruptedException.html" target="_top">Frames</a></li> +<li><a href="ThreadInterruptedException.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>Constr | </li> +<li><a href="#methods.inherited.from.class.com.gemstone.gemfire.cache.CacheRuntimeException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/54a3e718/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/ToDataException.html ---------------------------------------------------------------------- diff --git a/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/ToDataException.html b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/ToDataException.html new file mode 100644 index 0000000..6acc249 --- /dev/null +++ b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/ToDataException.html @@ -0,0 +1,314 @@ +<!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 (1.8.0_45) on Fri Mar 11 16:13:08 PST 2016 --> +<title>ToDataException (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)</title> +<meta name="date" content="2016-03-11"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ToDataException (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<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="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><a href="../../../com/gemstone/gemfire/ThreadInterruptedException.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../com/gemstone/gemfire/UncreatedSystemException.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/gemstone/gemfire/ToDataException.html" target="_top">Frames</a></li> +<li><a href="ToDataException.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="#methods.inherited.from.class.com.gemstone.gemfire.GemFireException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">com.gemstone.gemfire</div> +<h2 title="Class ToDataException" class="title">Class ToDataException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li>java.lang.RuntimeException</li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/gemstone/gemfire/GemFireException.html" title="class in com.gemstone.gemfire">com.gemstone.gemfire.GemFireException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/gemstone/gemfire/GemFireIOException.html" title="class in com.gemstone.gemfire">com.gemstone.gemfire.GemFireIOException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/gemstone/gemfire/SerializationException.html" title="class in com.gemstone.gemfire">com.gemstone.gemfire.SerializationException</a></li> +<li> +<ul class="inheritance"> +<li>com.gemstone.gemfire.ToDataException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">ToDataException</span> +extends <a href="../../../com/gemstone/gemfire/SerializationException.html" title="class in com.gemstone.gemfire">SerializationException</a></pre> +<div class="block">A <code>ToDataException</code> is thrown during serialization if + <a href="../../../com/gemstone/gemfire/DataSerializable.html#toData-java.io.DataOutput-"><code>DataSerializable.toData(java.io.DataOutput)</code></a> throws an exception or if + <a href="../../../com/gemstone/gemfire/DataSerializer.html#toData-java.lang.Object-java.io.DataOutput-"><code>DataSerializer.toData(java.lang.Object, java.io.DataOutput)</code></a> is called and returns false.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>6.5</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../serialized-form.html#com.gemstone.gemfire.ToDataException">Serialized Form</a></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="memberSummary" 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="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/ToDataException.html#ToDataException-java.lang.String-">ToDataException</a></span>(java.lang.String message)</code> +<div class="block">Creates a new <code>ToDataException</code> with the given message</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/ToDataException.html#ToDataException-java.lang.String-java.lang.Throwable-">ToDataException</a></span>(java.lang.String message, + java.lang.Throwable cause)</code> +<div class="block">Creates a new <code>ToDataException</code> with the given message + and cause.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.com.gemstone.gemfire.GemFireException"> +<!-- --> +</a> +<h3>Methods inherited from class com.gemstone.gemfire.<a href="../../../com/gemstone/gemfire/GemFireException.html" title="class in com.gemstone.gemfire">GemFireException</a></h3> +<code><a href="../../../com/gemstone/gemfire/GemFireException.html#getRootCause--">getRootCause</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, 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="ToDataException-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ToDataException</h4> +<pre>public ToDataException(java.lang.String message)</pre> +<div class="block">Creates a new <code>ToDataException</code> with the given message</div> +</li> +</ul> +<a name="ToDataException-java.lang.String-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ToDataException</h4> +<pre>public ToDataException(java.lang.String message, + java.lang.Throwable cause)</pre> +<div class="block">Creates a new <code>ToDataException</code> with the given message + and cause.</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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<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="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><a href="../../../com/gemstone/gemfire/ThreadInterruptedException.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../com/gemstone/gemfire/UncreatedSystemException.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/gemstone/gemfire/ToDataException.html" target="_top">Frames</a></li> +<li><a href="ToDataException.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="#methods.inherited.from.class.com.gemstone.gemfire.GemFireException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>