blob: adf5daf3982ab20951c75244193e75e0a5640e0e [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Thu Sep 15 14:13:16 CDT 2022 -->
<title>org.eclipse.jetty.util.thread (Eclipse Jetty API Doc - v11.0.12)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-09-15">
<meta name="description" content="declaration: package: org.eclipse.jetty.util.thread">
<meta name="generator" content="javadoc/PackageWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="package-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li class="nav-bar-cell1-rev">Package</li>
<li>Class</li>
<li><a href="package-use.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#package">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Package:&nbsp;</li>
<li><a href="#package-description">Description</a>&nbsp;|&nbsp;</li>
<li><a href="#related-package-summary">Related Packages</a>&nbsp;|&nbsp;</li>
<li><a href="#class-summary">Classes and Interfaces</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 title="Package org.eclipse.jetty.util.thread" class="title">Package org.eclipse.jetty.util.thread</h1>
</div>
<hr>
<div class="package-signature">package <span class="element-name">org.eclipse.jetty.util.thread</span></div>
<section class="package-description" id="package-description">
<div class="block">Jetty Util : Common ThreadPool Utilities</div>
</section>
<section class="summary">
<ul class="summary-list">
<li>
<div id="related-package-summary">
<div class="caption"><span>Related Packages</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="../package-summary.html">org.eclipse.jetty.util</a></div>
<div class="col-last even-row-color">
<div class="block">Jetty Util : Common Utility Classes</div>
</div>
<div class="col-first odd-row-color"><a href="strategy/package-summary.html">org.eclipse.jetty.util.thread.strategy</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
</div>
</li>
<li>
<div id="class-summary">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enums</button></div>
<div id="class-summary.tabpanel" role="tabpanel">
<div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="AutoLock.html" title="class in org.eclipse.jetty.util.thread">AutoLock</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Reentrant lock that can be used in a try-with-resources statement.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="AutoLock.WithCondition.html" title="class in org.eclipse.jetty.util.thread">AutoLock.WithCondition</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A reentrant lock with a condition that can be used in a try-with-resources statement.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="ExecutionStrategy.html" title="interface in org.eclipse.jetty.util.thread">ExecutionStrategy</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">An <a href="ExecutionStrategy.html" title="interface in org.eclipse.jetty.util.thread"><code>ExecutionStrategy</code></a> executes <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Runnable.html" title="class or interface in java.lang" class="external-link"><code>Runnable</code></a> tasks produced by a <a href="ExecutionStrategy.Producer.html" title="interface in org.eclipse.jetty.util.thread"><code>ExecutionStrategy.Producer</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ExecutionStrategy.Producer.html" title="interface in org.eclipse.jetty.util.thread">ExecutionStrategy.Producer</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">A producer of <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Runnable.html" title="class or interface in java.lang" class="external-link"><code>Runnable</code></a> tasks to run.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ExecutorThreadPool.html" title="class in org.eclipse.jetty.util.thread">ExecutorThreadPool</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A <a href="ThreadPool.SizedThreadPool.html" title="interface in org.eclipse.jetty.util.thread"><code>ThreadPool.SizedThreadPool</code></a> wrapper around <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/ThreadPoolExecutor.html" title="class or interface in java.util.concurrent" class="external-link"><code>ThreadPoolExecutor</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Invocable.html" title="interface in org.eclipse.jetty.util.thread">Invocable</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">A task (typically either a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Runnable.html" title="class or interface in java.lang" class="external-link"><code>Runnable</code></a> or <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Callable.html" title="class or interface in java.util.concurrent" class="external-link"><code>Callable</code></a>
that declares how it will behave when invoked:</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab3"><a href="Invocable.InvocationType.html" title="enum in org.eclipse.jetty.util.thread">Invocable.InvocationType</a></div>
<div class="col-last even-row-color class-summary class-summary-tab3">
<div class="block">The behavior of an <a href="Invocable.html" title="interface in org.eclipse.jetty.util.thread"><code>Invocable</code></a> when it is invoked.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Invocable.ReadyTask.html" title="class in org.eclipse.jetty.util.thread">Invocable.ReadyTask</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Runnable.html" title="class or interface in java.lang" class="external-link"><code>Runnable</code></a> decorated with an <a href="Invocable.InvocationType.html" title="enum in org.eclipse.jetty.util.thread"><code>Invocable.InvocationType</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="Invocable.Task.html" title="interface in org.eclipse.jetty.util.thread">Invocable.Task</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">A task with an <a href="Invocable.InvocationType.html" title="enum in org.eclipse.jetty.util.thread"><code>Invocable.InvocationType</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="MonitoredQueuedThreadPool.html" title="class in org.eclipse.jetty.util.thread">MonitoredQueuedThreadPool</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A <a href="QueuedThreadPool.html" title="class in org.eclipse.jetty.util.thread"><code>QueuedThreadPool</code></a> subclass that monitors its own activity by recording queue and task statistics.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="QueuedThreadPool.html" title="class in org.eclipse.jetty.util.thread">QueuedThreadPool</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A thread pool with a queue of jobs to execute.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ReservedThreadExecutor.html" title="class in org.eclipse.jetty.util.thread">ReservedThreadExecutor</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A TryExecutor using pre-allocated/reserved threads from an external Executor.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ScheduledExecutorScheduler.html" title="class in org.eclipse.jetty.util.thread">ScheduledExecutorScheduler</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Implementation of <a href="Scheduler.html" title="interface in org.eclipse.jetty.util.thread"><code>Scheduler</code></a> based on JDK's <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/ScheduledThreadPoolExecutor.html" title="class or interface in java.util.concurrent" class="external-link"><code>ScheduledThreadPoolExecutor</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Scheduler.html" title="interface in org.eclipse.jetty.util.thread">Scheduler</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="Scheduler.Task.html" title="interface in org.eclipse.jetty.util.thread">Scheduler.Task</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SerializedExecutor.html" title="class in org.eclipse.jetty.util.thread">SerializedExecutor</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">An executor than ensurers serial execution of submitted tasks.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="SerializedExecutor.ErrorHandlingTask.html" title="interface in org.eclipse.jetty.util.thread">SerializedExecutor.ErrorHandlingTask</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Error handling task</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ShutdownThread.html" title="class in org.eclipse.jetty.util.thread">ShutdownThread</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">ShutdownThread is a shutdown hook thread implemented as
singleton that maintains a list of lifecycle instances
that are registered with it and provides ability to stop
these lifecycles upon shutdown of the Java Virtual Machine</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Sweeper.html" title="class in org.eclipse.jetty.util.thread">Sweeper</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A utility class to perform periodic sweeping of resources.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Sweeper.Sweepable.html" title="interface in org.eclipse.jetty.util.thread">Sweeper.Sweepable</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">A <a href="Sweeper.Sweepable.html" title="interface in org.eclipse.jetty.util.thread"><code>Sweeper.Sweepable</code></a> resource implements this interface to
signal to a <a href="Sweeper.html" title="class in org.eclipse.jetty.util.thread"><code>Sweeper</code></a> or to a parent container if it
needs to be swept or not.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ThreadClassLoaderScope.html" title="class in org.eclipse.jetty.util.thread">ThreadClassLoaderScope</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ThreadPool.html" title="interface in org.eclipse.jetty.util.thread">ThreadPool</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">A pool for threads.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="ThreadPool.SizedThreadPool.html" title="interface in org.eclipse.jetty.util.thread">ThreadPool.SizedThreadPool</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Specialized sub-interface of ThreadPool that allows to get/set
the minimum and maximum number of threads of the pool.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ThreadPoolBudget.html" title="class in org.eclipse.jetty.util.thread">ThreadPoolBudget</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A budget of required thread usage, used to warn or error for insufficient configured threads.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="ThreadPoolBudget.Lease.html" title="interface in org.eclipse.jetty.util.thread">ThreadPoolBudget.Lease</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="TimerScheduler.html" title="class in org.eclipse.jetty.util.thread">TimerScheduler</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A scheduler based on the the JVM Timer class</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="TryExecutor.html" title="interface in org.eclipse.jetty.util.thread">TryExecutor</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">A variation of Executor that can confirm if a thread is available immediately</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="TryExecutor.NoTryExecutor.html" title="class in org.eclipse.jetty.util.thread">TryExecutor.NoTryExecutor</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
</div>
</div>
</div>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 1995&#x2013;2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>