|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
|
|
|
<html lang="en"> |
|
<head> |
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
|
<title>BackgroundThread (JanusGraph-Core: Core Library for JanusGraph 1.0.0 API)</title> |
|
<meta name="date" content="2023-10-21"> |
|
<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="BackgroundThread (JanusGraph-Core: Core Library for JanusGraph 1.0.0 API)"; |
|
} |
|
} |
|
catch(err) { |
|
} |
|
|
|
var methods = {"i0":6,"i1":10,"i2":10,"i3":10,"i4":6}; |
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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> |
|
|
|
<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="class-use/BackgroundThread.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="../../../../org/janusgraph/util/system/CheckSocket.html" title="class in org.janusgraph.util.system"><span class="typeNameLink">Next Class</span></a></li> |
|
</ul> |
|
<ul class="navList"> |
|
<li><a href="../../../../index.html?org/janusgraph/util/system/BackgroundThread.html" target="_top">Frames</a></li> |
|
<li><a href="BackgroundThread.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"> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</script> |
|
</div> |
|
<div> |
|
<ul class="subNavList"> |
|
<li>Summary: </li> |
|
<li><a href="#nested.classes.inherited.from.class.java.lang.Thread">Nested</a> | </li> |
|
<li><a href="#fields.inherited.from.class.java.lang.Thread">Field</a> | </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> |
|
|
|
|
|
<div class="header"> |
|
<div class="subTitle">org.janusgraph.util.system</div> |
|
<h2 title="Class BackgroundThread" class="title">Class BackgroundThread</h2> |
|
</div> |
|
<div class="contentContainer"> |
|
<ul class="inheritance"> |
|
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
|
<li> |
|
<ul class="inheritance"> |
|
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true" title="class or interface in java.lang">java.lang.Thread</a></li> |
|
<li> |
|
<ul class="inheritance"> |
|
<li>org.janusgraph.util.system.BackgroundThread</li> |
|
</ul> |
|
</li> |
|
</ul> |
|
</li> |
|
</ul> |
|
<div class="description"> |
|
<ul class="blockList"> |
|
<li class="blockList"> |
|
<dl> |
|
<dt>All Implemented Interfaces:</dt> |
|
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a></dd> |
|
</dl> |
|
<hr> |
|
<br> |
|
<pre>public abstract class <span class="typeNameLabel">BackgroundThread</span> |
|
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true" title="class or interface in java.lang">Thread</a></pre> |
|
<dl> |
|
<dt><span class="simpleTagLabel">Author:</span></dt> |
|
<dd>Matthias Broecheler (me@matthiasb.com)</dd> |
|
</dl> |
|
</li> |
|
</ul> |
|
</div> |
|
<div class="summary"> |
|
<ul class="blockList"> |
|
<li class="blockList"> |
|
|
|
<ul class="blockList"> |
|
<li class="blockList"><a name="nested.class.summary"> |
|
|
|
</a> |
|
<h3>Nested Class Summary</h3> |
|
<ul class="blockList"> |
|
<li class="blockList"><a name="nested.classes.inherited.from.class.java.lang.Thread"> |
|
|
|
</a> |
|
<h3>Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true" title="class or interface in java.lang">Thread</a></h3> |
|
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.State.html?is-external=true" title="class or interface in java.lang">Thread.State</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.UncaughtExceptionHandler.html?is-external=true" title="class or interface in java.lang">Thread.UncaughtExceptionHandler</a></code></li> |
|
</ul> |
|
</li> |
|
</ul> |
|
|
|
<ul class="blockList"> |
|
<li class="blockList"><a name="field.summary"> |
|
|
|
</a> |
|
<h3>Field Summary</h3> |
|
<ul class="blockList"> |
|
<li class="blockList"><a name="fields.inherited.from.class.java.lang.Thread"> |
|
|
|
</a> |
|
<h3>Fields inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true" title="class or interface in java.lang">Thread</a></h3> |
|
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#MAX_PRIORITY" title="class or interface in java.lang">MAX_PRIORITY</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#MIN_PRIORITY" title="class or interface in java.lang">MIN_PRIORITY</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#NORM_PRIORITY" title="class or interface in java.lang">NORM_PRIORITY</a></code></li> |
|
</ul> |
|
</li> |
|
</ul> |
|
|
|
<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="../../../../org/janusgraph/util/system/BackgroundThread.html#BackgroundThread-java.lang.String-boolean-">BackgroundThread</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
|
boolean daemon)</code> |
|
<div class="block">NEVER set daemon=true and override the cleanup() method.</div> |
|
</td> |
|
</tr> |
|
</table> |
|
</li> |
|
</ul> |
|
|
|
<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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>protected abstract void</code></td> |
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/janusgraph/util/system/BackgroundThread.html#action--">action</a></span>()</code> |
|
<div class="block">The action taken by this background thread when the wait condition is met.</div> |
|
</td> |
|
</tr> |
|
<tr id="i1" class="rowColor"> |
|
<td class="colFirst"><code>protected void</code></td> |
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/janusgraph/util/system/BackgroundThread.html#cleanup--">cleanup</a></span>()</code> |
|
<div class="block">Any clean up that needs to be done before this thread is closed down.</div> |
|
</td> |
|
</tr> |
|
<tr id="i2" class="altColor"> |
|
<td class="colFirst"><code>void</code></td> |
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/janusgraph/util/system/BackgroundThread.html#close-java.time.Duration-">close</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html?is-external=true" title="class or interface in java.time">Duration</a> duration)</code> </td> |
|
</tr> |
|
<tr id="i3" class="rowColor"> |
|
<td class="colFirst"><code>void</code></td> |
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/janusgraph/util/system/BackgroundThread.html#run--">run</a></span>()</code> </td> |
|
</tr> |
|
<tr id="i4" class="altColor"> |
|
<td class="colFirst"><code>protected abstract void</code></td> |
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/janusgraph/util/system/BackgroundThread.html#waitCondition--">waitCondition</a></span>()</code> |
|
<div class="block">The wait condition for the background thread.</div> |
|
</td> |
|
</tr> |
|
</table> |
|
<ul class="blockList"> |
|
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Thread"> |
|
|
|
</a> |
|
<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true" title="class or interface in java.lang">Thread</a></h3> |
|
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#activeCount--" title="class or interface in java.lang">activeCount</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#checkAccess--" title="class or interface in java.lang">checkAccess</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#countStackFrames--" title="class or interface in java.lang">countStackFrames</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#currentThread--" title="class or interface in java.lang">currentThread</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#destroy--" title="class or interface in java.lang">destroy</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#dumpStack--" title="class or interface in java.lang">dumpStack</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#enumerate-java.lang.Thread:A-" title="class or interface in java.lang">enumerate</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#getAllStackTraces--" title="class or interface in java.lang">getAllStackTraces</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#getContextClassLoader--" title="class or interface in java.lang">getContextClassLoader</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#getDefaultUncaughtExceptionHandler--" title="class or interface in java.lang">getDefaultUncaughtExceptionHandler</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#getId--" title="class or interface in java.lang">getId</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#getName--" title="class or interface in java.lang">getName</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#getPriority--" title="class or interface in java.lang">getPriority</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#getStackTrace--" title="class or interface in java.lang">getStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#getState--" title="class or interface in java.lang">getState</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#getThreadGroup--" title="class or interface in java.lang">getThreadGroup</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#getUncaughtExceptionHandler--" title="class or interface in java.lang">getUncaughtExceptionHandler</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#holdsLock-java.lang.Object-" title="class or interface in java.lang">holdsLock</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#interrupt--" title="class or interface in java.lang">interrupt</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#interrupted--" title="class or interface in java.lang">interrupted</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#isAlive--" title="class or interface in java.lang">isAlive</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#isDaemon--" title="class or interface in java.lang">isDaemon</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#isInterrupted--" title="class or interface in java.lang">isInterrupted</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#join--" title="class or interface in java.lang">join</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#join-long-" title="class or interface in java.lang">join</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#join-long-int-" title="class or interface in java.lang">join</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#resume--" title="class or interface in java.lang">resume</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#setContextClassLoader-java.lang.ClassLoader-" title="class or interface in java.lang">setContextClassLoader</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#setDaemon-boolean-" title="class or interface in java.lang">setDaemon</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#setDefaultUncaughtExceptionHandler-java.lang.Thread.UncaughtExceptionHandler-" title="class or interface in java.lang">setDefaultUncaughtExceptionHandler</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#setName-java.lang.String-" title="class or interface in java.lang">setName</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#setPriority-int-" title="class or interface in java.lang">setPriority</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#setUncaughtExceptionHandler-java.lang.Thread.UncaughtExceptionHandler-" title="class or interface in java.lang">setUncaughtExceptionHandler</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#sleep-long-" title="class or interface in java.lang">sleep</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#sleep-long-int-" title="class or interface in java.lang">sleep</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#start--" title="class or interface in java.lang">start</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#stop--" title="class or interface in java.lang">stop</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#stop-java.lang.Throwable-" title="class or interface in java.lang">stop</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#suspend--" title="class or interface in java.lang">suspend</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#yield--" title="class or interface in java.lang">yield</a></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.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
|
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
|
</ul> |
|
</li> |
|
</ul> |
|
</li> |
|
</ul> |
|
</div> |
|
<div class="details"> |
|
<ul class="blockList"> |
|
<li class="blockList"> |
|
|
|
<ul class="blockList"> |
|
<li class="blockList"><a name="constructor.detail"> |
|
|
|
</a> |
|
<h3>Constructor Detail</h3> |
|
<a name="BackgroundThread-java.lang.String-boolean-"> |
|
|
|
</a> |
|
<ul class="blockListLast"> |
|
<li class="blockList"> |
|
<h4>BackgroundThread</h4> |
|
<pre>public BackgroundThread(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
|
boolean daemon)</pre> |
|
<div class="block">NEVER set daemon=true and override the cleanup() method. If this is a daemon thread there is no guarantee that |
|
cleanup is called.</div> |
|
<dl> |
|
<dt><span class="paramLabel">Parameters:</span></dt> |
|
<dd><code>name</code> - </dd> |
|
<dd><code>daemon</code> - </dd> |
|
</dl> |
|
</li> |
|
</ul> |
|
</li> |
|
</ul> |
|
|
|
<ul class="blockList"> |
|
<li class="blockList"><a name="method.detail"> |
|
|
|
</a> |
|
<h3>Method Detail</h3> |
|
<a name="run--"> |
|
|
|
</a> |
|
<ul class="blockList"> |
|
<li class="blockList"> |
|
<h4>run</h4> |
|
<pre>public void run()</pre> |
|
<dl> |
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true#run--" title="class or interface in java.lang">run</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a></code></dd> |
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true#run--" title="class or interface in java.lang">run</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true" title="class or interface in java.lang">Thread</a></code></dd> |
|
</dl> |
|
</li> |
|
</ul> |
|
<a name="waitCondition--"> |
|
|
|
</a> |
|
<ul class="blockList"> |
|
<li class="blockList"> |
|
<h4>waitCondition</h4> |
|
<pre>protected abstract void waitCondition() |
|
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></pre> |
|
<div class="block">The wait condition for the background thread. This determines what this background thread is waiting for in |
|
its execution. This might be elapsing time or availability of resources. |
|
|
|
Since there is a wait involved, this method should throw an InterruptedException</div> |
|
<dl> |
|
<dt><span class="throwsLabel">Throws:</span></dt> |
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code></dd> |
|
</dl> |
|
</li> |
|
</ul> |
|
<a name="action--"> |
|
|
|
</a> |
|
<ul class="blockList"> |
|
<li class="blockList"> |
|
<h4>action</h4> |
|
<pre>protected abstract void action()</pre> |
|
<div class="block">The action taken by this background thread when the wait condition is met. |
|
This action should execute swiftly to ensure that this thread can be closed in a reasonable amount of time. |
|
|
|
This action will not be interrupted by <a href="../../../../org/janusgraph/util/system/BackgroundThread.html#close-java.time.Duration-"><code>close(Duration)</code></a>.</div> |
|
</li> |
|
</ul> |
|
<a name="cleanup--"> |
|
|
|
</a> |
|
<ul class="blockList"> |
|
<li class="blockList"> |
|
<h4>cleanup</h4> |
|
<pre>protected void cleanup()</pre> |
|
<div class="block">Any clean up that needs to be done before this thread is closed down.</div> |
|
</li> |
|
</ul> |
|
<a name="close-java.time.Duration-"> |
|
|
|
</a> |
|
<ul class="blockListLast"> |
|
<li class="blockList"> |
|
<h4>close</h4> |
|
<pre>public void close(<a href="https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html?is-external=true" title="class or interface in java.time">Duration</a> duration)</pre> |
|
</li> |
|
</ul> |
|
</li> |
|
</ul> |
|
</li> |
|
</ul> |
|
</div> |
|
</div> |
|
|
|
|
|
<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="class-use/BackgroundThread.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="../../../../org/janusgraph/util/system/CheckSocket.html" title="class in org.janusgraph.util.system"><span class="typeNameLink">Next Class</span></a></li> |
|
</ul> |
|
<ul class="navList"> |
|
<li><a href="../../../../index.html?org/janusgraph/util/system/BackgroundThread.html" target="_top">Frames</a></li> |
|
<li><a href="BackgroundThread.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"> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</script> |
|
</div> |
|
<div> |
|
<ul class="subNavList"> |
|
<li>Summary: </li> |
|
<li><a href="#nested.classes.inherited.from.class.java.lang.Thread">Nested</a> | </li> |
|
<li><a href="#fields.inherited.from.class.java.lang.Thread">Field</a> | </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> |
|
|
|
<p class="legalCopy"><small>Copyright © 2012–2023. All rights reserved.</small></p> |
|
</body> |
|
</html> |
|
|