lcars-library-node
Version:
NodeJS module for creating a library for the LCARS dashboard system
498 lines (335 loc) • 16.8 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>LCARSServer - lcars-library-node</title>
<link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="icon" href="../assets/favicon.ico">
<script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">
<div id="doc">
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><img src="../assets/css/logo.png" title="lcars-library-node" width="117" height="52"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.0.0</em>
</div>
</div>
<div id="bd" class="yui3-g">
<div class="yui3-u-1-4">
<div id="docs-sidebar" class="sidebar apidocs">
<div id="api-list">
<h2 class="off-left">APIs</h2>
<div id="api-tabview" class="tabview">
<ul class="tabs">
<li><a href="#api-classes">Classes</a></li>
<li><a href="#api-modules">Modules</a></li>
</ul>
<div id="api-tabview-filter">
<input type="search" id="api-filter" placeholder="Type to filter APIs">
</div>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="../classes/Circulation.html">Circulation</a></li>
<li><a href="../classes/Distress.html">Distress</a></li>
<li><a href="../classes/Edge.html">Edge</a></li>
<li><a href="../classes/Element.html">Element</a></li>
<li><a href="../classes/Event.html">Event</a></li>
<li><a href="../classes/Exception.html">Exception</a></li>
<li><a href="../classes/External.html">External</a></li>
<li><a href="../classes/LCARSLibrary.html">LCARSLibrary</a></li>
<li><a href="../classes/LCARSServer.html">LCARSServer</a></li>
<li><a href="../classes/Modification.html">Modification</a></li>
<li><a href="../classes/Random.html">Random</a></li>
<li><a href="../classes/Search.html">Search</a></li>
<li><a href="../classes/Session.html">Session</a></li>
<li><a href="../classes/Set.html">Set</a></li>
<li><a href="../classes/Storage.html">Storage</a></li>
<li><a href="../classes/Terminal.html">Terminal</a></li>
<li><a href="../classes/User.html">User</a></li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a href="../modules/Connections.html">Connections</a></li>
<li><a href="../modules/Elements.html">Elements</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui3-u-3-4">
<div id="api-options">
Show:
<label for="api-show-inherited">
<input type="checkbox" id="api-show-inherited" checked>
Inherited
</label>
<label for="api-show-protected">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</div>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1>LCARSServer Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/library_x-beta.js.html#l3"><code>library\x-beta.js:3</code></a>
</div>
Module: <a href="../modules/Elements.html">Elements</a>
</div>
<div class="box intro">
<p>General Library Access/Retrieval Server for the LCARS Library</p>
<p>The library serves as an endpoint for specific collections as designated by the
configuration. A websocket is used to synchronize collections being provided to
various registrations, allowing for multiple displays to synchronize displayed
data.</p>
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_LCARSServer" class="method item">
<h3 class="name"><code>LCARSServer</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>handler</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/library_x-beta.js.html#l3"><code>library\x-beta.js:3</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">handler</code>
<span class="type">Handler</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
</div>
<div id="classdocs" class="tabview">
<ul class="api-class-tabs">
<li class="api-class-tab index"><a href="#index">Index</a></li>
<li class="api-class-tab methods"><a href="#methods">Methods</a></li>
<li class="api-class-tab events"><a href="#events">Events</a></li>
</ul>
<div>
<div id="index" class="api-class-tabpanel index">
<h2 class="off-left">Item Index</h2>
<div class="index-section methods">
<h3>Methods</h3>
<ul class="index-list methods">
<li class="index-item method">
<a href="#method_broadcast">broadcast</a>
</li>
<li class="index-item method">
<a href="#method_terminate">terminate</a>
</li>
</ul>
</div>
<div class="index-section events">
<h3>Events</h3>
<ul class="index-list events">
<li class="index-item event">
<a href="#event_establish">establish</a>
</li>
<li class="index-item event">
<a href="#event_fault">fault</a>
</li>
<li class="index-item event">
<a href="#event_malformed">malformed</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method_broadcast" class="method item">
<h3 class="name"><code>broadcast</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>message</code>
</li>
<li class="arg">
<code class="optional">[] [sessions]</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/library_x-beta.js.html#l130"><code>library\x-beta.js:130</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">message</code>
<span class="type">Object</span>
<div class="param-description">
<p>The message to send to indicated connections.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[] [sessions]</code>
<span class="type">String</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>When specified, only the indicated sessions
will receive the message.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_terminate" class="method item">
<h3 class="name"><code>terminate</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>session</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/library_x-beta.js.html#l141"><code>library\x-beta.js:141</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">session</code>
<span class="type">String</span>
<div class="param-description">
<p>The identifier for the session to be terminated.</p>
</div>
</li>
</ul>
</div>
</div>
</div>
<div id="events" class="api-class-tabpanel">
<h2 class="off-left">Events</h2>
<div id="event_establish" class="events item">
<h3 class="name"><code>establish</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<a href="../files/library_x-beta.js.html#l102"><code>library\x-beta.js:102</code></a>
</p>
</div>
<div class="description">
<p>Occurs when a Petition connects to an AccessSet successfully.</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">data</code>
<span class="type">Petition</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="event_fault" class="events item">
<h3 class="name"><code>fault</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<a href="../files/library_x-beta.js.html#l121"><code>library\x-beta.js:121</code></a>
</p>
</div>
<div class="description">
<p>Occurs when a Petition is received with an unknown event key.</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">data</code>
<span class="type">Petition</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="event_malformed" class="events item">
<h3 class="name"><code>malformed</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<a href="../files/library_x-beta.js.html#l112"><code>library\x-beta.js:112</code></a>
</p>
</div>
<div class="description">
<p>Occurs when a Petition appears valid but suffers an exception.</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">data</code>
<span class="type">Anomaly</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>