mirror of https://github.com/reiseburo/whoas
367 lines
17 KiB
HTML
367 lines
17 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!-- **************************************************************** -->
|
|
<!-- * PLEASE KEEP COMPLICATED EXPRESSIONS OUT OF THESE TEMPLATES, * -->
|
|
<!-- * i.e. only iterate & print data where possible. Thanks, Jez. * -->
|
|
<!-- **************************************************************** -->
|
|
|
|
<html>
|
|
<head>
|
|
<!-- Generated by groovydoc (2.4.0) on Wed Mar 25 11:06:39 PDT 2015 -->
|
|
<title>InMemoryQueue (whoas 0.2.0 API)</title>
|
|
<meta name="date" content="2015-03-25">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<link href="../../../../groovy.ico" type="image/x-icon" rel="shortcut icon">
|
|
<link href="../../../../groovy.ico" type="image/x-icon" rel="icon">
|
|
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
|
|
|
<body class="center">
|
|
<script type="text/javascript"><!--
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="InMemoryQueue (whoas 0.2.0 API)";
|
|
}
|
|
//-->
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a name="navbar_top">
|
|
<!-- -->
|
|
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../overview-summary.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="../../../../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">
|
|
<div>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?com/github/lookout/whoas/InMemoryQueue" target="_top">Frames</a></li>
|
|
<li><a href="InMemoryQueue.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
Nested Field <li><a href="#constructor_summary">Constructor</a></li> <li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li> | Detail: </li>
|
|
Field <li><a href="#constructor_detail">Constructor</a></li> <li><a href="#method_detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip-navbar_top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
|
|
<div class="subTitle">Package: <strong>com.github.lookout.whoas</strong></div>
|
|
|
|
<h2 title="[Groovy] Class InMemoryQueue" class="title">[Groovy] Class InMemoryQueue</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li><ul class="inheritance"></ul></li><li><ul class="inheritance"></ul></li><li>com.github.lookout.whoas.InMemoryQueue
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
|
|
|
|
|
|
<p> A simple in-memory queue that offers no persistence between process restarts
|
|
</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- =========== NESTED CLASS SUMMARY =========== -->
|
|
|
|
|
|
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
|
|
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="field_summary"><!-- --></a>
|
|
<ul class="blockList">
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Inherited fields summary table">
|
|
<caption><span>Inherited fields</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Fields inherited from class</th>
|
|
<th class="colLast" scope="col">Fields</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><strong><code>class <a href='../../../../com/github/lookout/whoas/AbstractHookQueue.html'>AbstractHookQueue</a></code></strong></td>
|
|
<td class="colLast"><code><a href='../../../../com/github/lookout/whoas/AbstractHookQueue.html#started'>started</a></code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</ul>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
<!-- =========== PROPERTY SUMMARY =========== -->
|
|
|
|
|
|
<!-- =========== ELEMENT SUMMARY =========== -->
|
|
|
|
|
|
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor_summary"><!-- --></a>
|
|
<h3>Constructor Summary</h3>
|
|
<ul class="blockList">
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructors Summary table">
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Constructor and description</th>
|
|
</tr>
|
|
|
|
<tr class="altColor">
|
|
<td class="colFirst">
|
|
<code><a href="#InMemoryQueue(com.github.lookout.whoas.WhoasQueueConfig)">InMemoryQueue</a></strong>
|
|
(<a href='../../../../com/github/lookout/whoas/WhoasQueueConfig.html'>WhoasQueueConfig</a> queueConfig)</code><br>Create the InMemoryQueue from configuration</td>
|
|
</tr>
|
|
|
|
<tr class="rowColor">
|
|
<td class="colFirst">
|
|
<code><a href="#InMemoryQueue()">InMemoryQueue</a></strong>
|
|
()</code><br>Default constructor</td>
|
|
</tr>
|
|
|
|
<tr class="altColor">
|
|
<td class="colFirst">
|
|
<code><a href="#InMemoryQueue(Queue<HookRequest>)">InMemoryQueue</a></strong>
|
|
(java.util.Queue<<a href='../../../../com/github/lookout/whoas/HookRequest.html' title='HookRequest'>HookRequest</a>> queue)</code><br>Create the InMemoryQueue with the given Queue object</td>
|
|
</tr>
|
|
|
|
</table>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
|
|
<li class="blockList"><a name="method_summary"><!-- --></a>
|
|
<h3>Methods Summary</h3>
|
|
<ul class="blockList">
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Methods Summary table">
|
|
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Type</th>
|
|
<th class="colLast" scope="col">Name and description</th>
|
|
</tr>
|
|
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>java.lang.Long</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#getSize()">getSize</a></strong>()</code><br>Return the number of elements in the queue</td>
|
|
</tr>
|
|
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>void</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#pop(groovy.lang.Closure)">pop</a></strong>(groovy.lang.Closure action)</code><br>Performs a blocking pop on the queue and invokes the closure with the
|
|
item popped from the queue</td>
|
|
</tr>
|
|
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>java.lang.Boolean</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#push(com.github.lookout.whoas.HookRequest)">push</a></strong>(<a href='../../../../com/github/lookout/whoas/HookRequest.html'>HookRequest</a> request)</code><br>Attempt to insert the request into the queue</td>
|
|
</tr>
|
|
|
|
</table>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="blockList"><a name="method_summary"><!-- --></a>
|
|
<h3>Inherited Methods Summary</h3>
|
|
<ul class="blockList">
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Inherited Methods Summary table">
|
|
<caption><span>Inherited Methods</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Methods inherited from class</th>
|
|
<th class="colLast" scope="col">Name</th>
|
|
</tr>
|
|
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>class <a href='../../../../com/github/lookout/whoas/AbstractHookQueue.html'>AbstractHookQueue</a></strong></code></td>
|
|
<td class="colLast"><code><a href='../../../../com/github/lookout/whoas/AbstractHookQueue.html#getSize()'>getSize</a>, <a href='../../../../com/github/lookout/whoas/AbstractHookQueue.html#pop(groovy.lang.Closure)'>pop</a>, <a href='../../../../com/github/lookout/whoas/AbstractHookQueue.html#push(com.github.lookout.whoas.HookRequest)'>push</a>, <a href='../../../../com/github/lookout/whoas/AbstractHookQueue.html#start()'>start</a>, <a href='../../../../com/github/lookout/whoas/AbstractHookQueue.html#stop()'>stop</a></code></td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>class java.lang.Object</strong></code></td>
|
|
<td class="colLast"><code>java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()</code></td>
|
|
</tr>
|
|
</table>
|
|
</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="InMemoryQueue(com.github.lookout.whoas.WhoasQueueConfig)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4><strong>InMemoryQueue</strong>(<a href='../../../../com/github/lookout/whoas/WhoasQueueConfig.html'>WhoasQueueConfig</a> queueConfig)</h4>
|
|
<p> Create the InMemoryQueue from configuration
|
|
</p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="InMemoryQueue()"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4><strong>InMemoryQueue</strong>()</h4>
|
|
<p> Default constructor
|
|
</p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="InMemoryQueue(Queue<HookRequest>)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4><strong>InMemoryQueue</strong>(java.util.Queue<<a href='../../../../com/github/lookout/whoas/HookRequest.html' title='HookRequest'>HookRequest</a>> queue)</h4>
|
|
<p> Create the InMemoryQueue with the given Queue object
|
|
</p>
|
|
</li>
|
|
</ul>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<!-- =========== METHOD DETAIL =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
|
|
<a name="getSize()"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>java.lang.Long <strong>getSize</strong>()</h4>
|
|
<p> Return the number of elements in the queue
|
|
</p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="pop(groovy.lang.Closure)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>void <strong>pop</strong>(groovy.lang.Closure action)</h4>
|
|
<p> Performs a blocking pop on the queue and invokes the closure with the
|
|
item popped from the queue
|
|
|
|
If the Closure throws an exception, the dequeued item will be returned
|
|
to the tail end of the queue
|
|
</p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="push(com.github.lookout.whoas.HookRequest)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>java.lang.Boolean <strong>push</strong>(<a href='../../../../com/github/lookout/whoas/HookRequest.html'>HookRequest</a> request)</h4>
|
|
<p> Attempt to insert the request into the queue
|
|
|
|
If the request cannot be inserted, this method will return false,
|
|
otherwise true.
|
|
</p>
|
|
</li>
|
|
</ul>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a name="navbar_bottom">
|
|
<!-- -->
|
|
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../overview-summary.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="../../../../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">
|
|
<div>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?com/github/lookout/whoas/InMemoryQueue" target="_top">Frames</a></li>
|
|
<li><a href="InMemoryQueue.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
Nested Field <li><a href="#constructor_summary">Constructor</a></li> <li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li> | Detail: </li>
|
|
Field <li><a href="#constructor_detail">Constructor</a></li> <li><a href="#method_detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<p>Groovy Documentation</p>
|
|
<a name="skip-navbar_bottom">
|
|
<!-- -->
|
|
</a>
|
|
</div>
|
|
</div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|