concern
Version:
A library for seperating your application logic into concerns.
981 lines (558 loc) • 23.3 kB
HTML
<html>
<head>
<meta charset="utf-8">
<title>Class: MessageDispatcher</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<script src="scripts/jquery.min.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/bootstrap.min.css">
<link type="text/css" rel="stylesheet" href="styles/jaguar.css">
<script>
var config = {"monospaceLinks":false,"cleverLinks":false,"default":{}};
</script>
</head>
<body>
<div id="wrap" class="clearfix">
<div class="navigation">
<h3 class="applicationName"><a href="index.html"></a></h3>
<div class="search">
<input id="search" type="text" class="form-control input-sm" placeholder="Search Documentations">
</div>
<ul class="list">
<li class="item" data-name="Active">
<span class="title">
<a href="Active.html">Active</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="Address">
<span class="title">
<a href="Address.html">Address</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
<span class="subtitle">Methods</span>
<li data-name="Address#is"><a href="Address.html#is">is</a></li>
<li data-name="Address#isAbove"><a href="Address.html#isAbove">isAbove</a></li>
<li data-name="Address#isBelow"><a href="Address.html#isBelow">isBelow</a></li>
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="ChildActiveState">
<span class="title">
<a href="ChildActiveState.html">ChildActiveState</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="ChildReference">
<span class="title">
<a href="ChildReference.html">ChildReference</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="ChildReferenceProvider">
<span class="title">
<a href="ChildReferenceProvider.html">ChildReferenceProvider</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
<span class="subtitle">Methods</span>
<li data-name="ChildReferenceProvider#getProcessList"><a href="ChildReferenceProvider.html#getProcessList">getProcessList</a></li>
<li data-name="ChildReferenceProvider#reselect"><a href="ChildReferenceProvider.html#reselect">reselect</a></li>
<li data-name="ChildReferenceProvider#select"><a href="ChildReferenceProvider.html#select">select</a></li>
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="ChildStateProvider">
<span class="title">
<a href="ChildStateProvider.html">ChildStateProvider</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
<span class="subtitle">Methods</span>
<li data-name="ChildStateProvider#provide"><a href="ChildStateProvider.html#provide">provide</a></li>
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="IgnoredMessage">
<span class="title">
<a href="IgnoredMessage.html">IgnoredMessage</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="InvalidMessageError">
<span class="title">
<a href="InvalidMessageError.html">InvalidMessageError</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="MemoryStateProvider">
<span class="title">
<a href="MemoryStateProvider.html">MemoryStateProvider</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
<span class="subtitle">Methods</span>
<li data-name="MemoryStateProvider#provide"><a href="MemoryStateProvider.html#provide">provide</a></li>
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="MessageDispatcher">
<span class="title">
<a href="MessageDispatcher.html">MessageDispatcher</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
<span class="subtitle">Methods</span>
<li data-name="MessageDispatcher#onEnqueue"><a href="MessageDispatcher.html#onEnqueue">onEnqueue</a></li>
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="ParentReference">
<span class="title">
<a href="ParentReference.html">ParentReference</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="Pause">
<span class="title">
<a href="Pause.html">Pause</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="Paused">
<span class="title">
<a href="Paused.html">Paused</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="ProcessRouter">
<span class="title">
<a href="ProcessRouter.html">ProcessRouter</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="Ready">
<span class="title">
<a href="Ready.html">Ready</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="ReceiveError">
<span class="title">
<a href="ReceiveError.html">ReceiveError</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="Reference">
<span class="title">
<a href="Reference.html">Reference</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
<span class="subtitle">Methods</span>
<li data-name="Reference#path"><a href="Reference.html#path">path</a></li>
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="RefState">
<span class="title">
<a href="RefState.html">RefState</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="RemoteMessage">
<span class="title">
<a href="RemoteMessage.html">RemoteMessage</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
<span class="subtitle">Methods</span>
<li data-name="RemoteMessage.is"><a href="RemoteMessage.html#.is">is</a></li>
<li data-name="RemoteMessage#asString"><a href="RemoteMessage.html#asString">asString</a></li>
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="RemoteteTerminatedError">
<span class="title">
<a href="RemoteteTerminatedError.html">RemoteteTerminatedError</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="Resume">
<span class="title">
<a href="Resume.html">Resume</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="Signal">
<span class="title">
<a href="Signal.html">Signal</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="SimpleMailBox">
<span class="title">
<a href="SimpleMailBox.html">SimpleMailBox</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
<span class="subtitle">Methods</span>
<li data-name="SimpleMailBox#dequeue"><a href="SimpleMailBox.html#dequeue">dequeue</a></li>
<li data-name="SimpleMailBox#enqueue"><a href="SimpleMailBox.html#enqueue">enqueue</a></li>
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="SpawnChildProcessError">
<span class="title">
<a href="SpawnChildProcessError.html">SpawnChildProcessError</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="Start">
<span class="title">
<a href="Start.html">Start</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="Stop">
<span class="title">
<a href="Stop.html">Stop</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="Stopped">
<span class="title">
<a href="Stopped.html">Stopped</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="StoppedConcernError">
<span class="title">
<a href="StoppedConcernError.html">StoppedConcernError</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="System">
<span class="title">
<a href="System.html">System</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
<span class="subtitle">Methods</span>
<li data-name="System.create"><a href="System.html#.create">create</a></li>
<li data-name="System#concernOf"><a href="System.html#concernOf">concernOf</a></li>
<li data-name="System#publish"><a href="System.html#publish">publish</a></li>
<li data-name="System#select"><a href="System.html#select">select</a></li>
<li data-name="System#setEventBus"><a href="System.html#setEventBus">setEventBus</a></li>
<li data-name="System#setReferenceProvider"><a href="System.html#setReferenceProvider">setReferenceProvider</a></li>
<li data-name="System#subscribe"><a href="System.html#subscribe">subscribe</a></li>
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="UnhandledMessage">
<span class="title">
<a href="UnhandledMessage.html">UnhandledMessage</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="Unknown">
<span class="title">
<a href="Unknown.html">Unknown</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
</ul>
<ul class="events itemMembers">
</ul>
</li>
</ul>
</div>
<div class="main">
<h1 class="page-title" data-filename="MessageDispatcher.html">Class: MessageDispatcher</h1>
<section>
<header>
<h2>
MessageDispatcher
</h2>
<div class="class-description"><p>MessageDispatcher handles the actual delivery of messages to
Concerns from their MailBox.</p></div>
</header>
<article>
<div class="container-overview">
<dt>
<div class="nameContainer">
<h4 class="name" id="MessageDispatcher">
new MessageDispatcher<span class="signature">(concern)</span>
</h4>
<div class="tag-source">
mailbox/MessageDispatcher.js, line 8
</div>
</div>
</dt>
<dd>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>concern</code></td>
<td class="type">
<span class="param-type"><a href="Concern.html">Concern</a></span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
</div>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<div class="nameContainer">
<h4 class="name" id="onEnqueue">
onEnqueue<span class="signature">(box)</span>
</h4>
<div class="tag-source">
mailbox/MailBox.js, line 51
</div>
</div>
</dt>
<dd>
<div class="description">
<p>onEnqueue is called when a new item has been enqueued by
the MailBox.</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>box</code></td>
<td class="type">
<span class="param-type"><a href="MailBox.html">MailBox</a></span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
</dl>
</article>
</section>
<footer>
Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.0-dev</a> on Sun Sep 25 2016 10:19:48 GMT-0400 (AST)
</footer>
</div>
</div>
<script>prettyPrint();</script>
<script src="scripts/jaguar.js"></script>
</body>
</html>