nmos-ledger
Version:
NMOS discovery and registration APIs
1,099 lines (281 loc) • 15.1 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: NodeRAMStore</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">Class: NodeRAMStore</h1>
<section>
<header>
<h2>NodeRAMStore</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="NodeRAMStore"><span class="type-signature"></span>new NodeRAMStore<span class="signature">(self)</span><span class="type-signature"></span></h4>
<div class="description">
In RAM store representing the state of a <a href="Node.html">node</a>. Immutable value.
</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>self</code></td>
<td class="type">
<span class="param-type"><a href="Node.html">Node</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="implements">Implements:</dt>
<dd class="implements"><ul>
<li><a href="NodeStore.html">NodeStore</a></li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api_NodeRAMStore.js.html">api/NodeRAMStore.js</a>, <a href="api_NodeRAMStore.js.html#line89">line 89</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="devices"><span class="type-signature">(readonly) </span>devices<span class="type-signature"> :Object.<string, <a href="Device.html">Device</a>></span></h4>
<div class="description">
Map of devices available at this <a href="Node.html">node</a>. Keys are UUIDs.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object.<string, <a href="Device.html">Device</a>></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api_NodeRAMStore.js.html">api/NodeRAMStore.js</a>, <a href="api_NodeRAMStore.js.html#line96">line 96</a>
</li></ul></dd>
</dl>
<h4 class="name" id="flows"><span class="type-signature">(readonly) </span>flows<span class="type-signature"> :Object.<string, <a href="Flow.html">Flow</a>></span></h4>
<div class="description">
Map of flows associated with this <a href="Node.html">node</a>. Keys are UUIDs.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object.<string, <a href="Flow.html">Flow</a>></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api_NodeRAMStore.js.html">api/NodeRAMStore.js</a>, <a href="api_NodeRAMStore.js.html#line108">line 108</a>
</li></ul></dd>
</dl>
<h4 class="name" id="receivers"><span class="type-signature">(readonly) </span>receivers<span class="type-signature"> :Object.<string, Receiver></span></h4>
<div class="description">
Map of receivers associated with this <a href="Node.html">node</a>. Keys are UUIDs.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object.<string, Receiver></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api_NodeRAMStore.js.html">api/NodeRAMStore.js</a>, <a href="api_NodeRAMStore.js.html#line120">line 120</a>
</li></ul></dd>
</dl>
<h4 class="name" id="senders"><span class="type-signature">(readonly) </span>senders<span class="type-signature"> :Object.<string, Sender></span></h4>
<div class="description">
Map of senders associated with this <a href="Node.html">node</a>. Keys are UUIDs.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object.<string, Sender></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api_NodeRAMStore.js.html">api/NodeRAMStore.js</a>, <a href="api_NodeRAMStore.js.html#line114">line 114</a>
</li></ul></dd>
</dl>
<h4 class="name" id="sources"><span class="type-signature">(readonly) </span>sources<span class="type-signature"> :Object.<string, Source></span></h4>
<div class="description">
Map of sources available at this <a href="Node.html">node</a>. Keys are UUIDs.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object.<string, Source></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api_NodeRAMStore.js.html">api/NodeRAMStore.js</a>, <a href="api_NodeRAMStore.js.html#line102">line 102</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="getDevice"><span class="type-signature"></span>getDevice<span class="signature">(id, cb)</span><span class="type-signature"></span></h4>
<div class="description">
Get the details of a specific device.
</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>id</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">Identity of the device being queried. String as UUID.</td>
</tr>
<tr>
<td class="name"><code>cb</code></td>
<td class="type">
<span class="param-type"><a href="NodeStore.html#~deviceCallback">NodeStore~deviceCallback</a></span>
</td>
<td class="description last">Callback with the device result.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="implements">Implements:</dt>
<dd class="implements"><ul>
<li><a href="NodeStore.html#getDevice">NodeStore#getDevice</a></li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api_NodeStore.js.html">api/NodeStore.js</a>, <a href="api_NodeStore.js.html#line101">line 101</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getDevices"><span class="type-signature"></span>getDevices<span class="signature">(skip<span class="signature-attributes">opt</span>, limit<span class="signature-attributes">opt</span>, cb)</span><span class="type-signature"></span></h4>
<div class="description">
Get all the devices available at this <a href="Node.html">node</a>.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>skip</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Number of devices to skip before starting the listing.</td>
</tr>
<tr>
<td class="name"><code>limit</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Limit the number of values returned.</td>
</tr>
<tr>
<td class="name"><code>cb</code></td>
<td class="type">
<span class="param-type"><a href="NodeStore.html#~devicesCallback">NodeStore~devicesCallback</a></span>
</td>
<td class="attributes">
</td>
<td class="description last">Callback providing the list of devlices.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="implements">Implements:</dt>
<dd class="implements"><ul>
<li><a href="NodeStore.html#getDevices">NodeStore#getDevices</a></li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api_NodeStore.js.html">api/NodeStore.js</a>, <a href="api_NodeStore.js.html#line81">line 81</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getSelf"><span class="type-signature"></span>getSelf<span class="signature">(cb)</span><span class="type-signature"></span></h4>
<div class="description">
Retrieve details of the node as the result of the callback.
</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>cb</code></td>
<td class="type">
<span class="param-type"><a href="NodeStore.html#~nodeCallback">NodeStore~nodeCallback</a></span>
</td>
<td class="description last">Callback with the node result.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="implements">Implements:</dt>
<dd class="implements"><ul>
<li><a href="NodeStore.html#getSelf">NodeStore#getSelf</a></li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api_NodeStore.js.html">api/NodeStore.js</a>, <a href="api_NodeStore.js.html#line47">line 47</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Device.html">Device</a></li><li><a href="Flow.html">Flow</a></li><li><a href="Node.html">Node</a></li><li><a href="NodeAPI.html">NodeAPI</a></li><li><a href="NodeRAMStore.html">NodeRAMStore</a></li><li><a href="Versionned.html">Versionned</a></li></ul><h3>Interfaces</h3><ul><li><a href="NodeStore.html">NodeStore</a></li></ul><h3>Global</h3><ul><li><a href="global.html#capabilities">capabilities</a></li><li><a href="global.html#deviceTypes">deviceTypes</a></li><li><a href="global.html#formats">formats</a></li><li><a href="global.html#statusError">statusError</a></li><li><a href="global.html#transports">transports</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Dec 21 2015 17:19:50 GMT+0000 (GMT)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>