concern
Version:
A library for seperating your application logic into concerns.
547 lines (141 loc) • 8.19 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Interface: MailBox</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Interface: MailBox</h1>
<section>
<header>
<h2>MailBox</h2>
<div class="class-description"><p>MailBox interface representing a queue where messages
are stored for Concerns before they are processed.</p></div>
</header>
<article>
<div class="container-overview">
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="msg_MailBox.js.html">msg/MailBox.js</a>, <a href="msg_MailBox.js.html#line6">line 6</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="dequeue"><span class="type-signature"></span>dequeue<span class="signature">()</span><span class="type-signature"> → {<a href="Envelope.html">Envelope</a>}</span></h4>
<div class="description">
<p>dequeue furnishes the next message to be processed.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="msg_MailBox.js.html">msg/MailBox.js</a>, <a href="msg_MailBox.js.html#line35">line 35</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Envelope.html">Envelope</a></span>
</dd>
</dl>
<h4 class="name" id="enqueue"><span class="type-signature"></span>enqueue<span class="signature">(to, from, message)</span><span class="type-signature"></span></h4>
<div class="description">
<p>enqueue puts a message into the queue and alerts the
listener of the change. Messages may be stringified for
remote storage.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>to</code></td>
<td class="type">
<span class="param-type"><a href="Concern.html">Concern</a></span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>from</code></td>
<td class="type">
<span class="param-type"><a href="Reference.html">Reference</a></span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>message</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="msg_MailBox.js.html">msg/MailBox.js</a>, <a href="msg_MailBox.js.html#line26">line 26</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setEnqueListener"><span class="type-signature"></span>setEnqueListener<span class="signature">(listener)</span><span class="type-signature"></span></h4>
<div class="description">
<p>setEnqueueListener sets the EnqueueListener for this MailBox.
The EnqueueListener is expected to be a Dispatcher that will
react to new messages being put on the mail queue.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>listener</code></td>
<td class="type">
<span class="param-type"><a href="EnqueueListener.html">EnqueueListener</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="msg_MailBox.js.html">msg/MailBox.js</a>, <a href="msg_MailBox.js.html#line14">line 14</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Active.html">Active</a></li><li><a href="Address.html">Address</a></li><li><a href="ChildActiveState.html">ChildActiveState</a></li><li><a href="ChildReference.html">ChildReference</a></li><li><a href="ChildReferenceProvider.html">ChildReferenceProvider</a></li><li><a href="ChildStateProvider.html">ChildStateProvider</a></li><li><a href="Envelope.html">Envelope</a></li><li><a href="IgnoredMessage.html">IgnoredMessage</a></li><li><a href="InvalidMessageError.html">InvalidMessageError</a></li><li><a href="MailDispatcher.html">MailDispatcher</a></li><li><a href="MemoryStateProvider.html">MemoryStateProvider</a></li><li><a href="ParentReference.html">ParentReference</a></li><li><a href="Pause.html">Pause</a></li><li><a href="Paused.html">Paused</a></li><li><a href="ProcessRouter.html">ProcessRouter</a></li><li><a href="Ready.html">Ready</a></li><li><a href="ReceiveError.html">ReceiveError</a></li><li><a href="Reference.html">Reference</a></li><li><a href="RefState.html">RefState</a></li><li><a href="RemoteMessage.html">RemoteMessage</a></li><li><a href="RemoteteTerminatedError.html">RemoteteTerminatedError</a></li><li><a href="Resume.html">Resume</a></li><li><a href="Signal.html">Signal</a></li><li><a href="SimpleMailBox.html">SimpleMailBox</a></li><li><a href="SpawnChildProcessError.html">SpawnChildProcessError</a></li><li><a href="Start.html">Start</a></li><li><a href="Stop.html">Stop</a></li><li><a href="Stopped.html">Stopped</a></li><li><a href="StoppedConcernError.html">StoppedConcernError</a></li><li><a href="System.html">System</a></li><li><a href="UnhandledMessage.html">UnhandledMessage</a></li><li><a href="Unknown.html">Unknown</a></li></ul><h3>Interfaces</h3><ul><li><a href="Concern.html">Concern</a></li><li><a href="Context.html">Context</a></li><li><a href="EnqueueListener.html">EnqueueListener</a></li><li><a href="MailBox.html">MailBox</a></li><li><a href="ReferenceProvider.html">ReferenceProvider</a></li><li><a href="StateProvider.html">StateProvider</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.0-dev</a> on Mon Sep 26 2016 02:55:49 GMT-0400 (AST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>