webgme-engine
Version:
WebGME server and Client API without a GUI
885 lines (211 loc) • 13.3 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: WebsocketRouter</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: WebsocketRouter</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>WebsocketRouter<span class="signature">(websocket, routerId)</span><span class="type-signature"></span></h2>
<div class="class-description"><p>Class for websocket funcionalities associated with routers.</p></div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="WebsocketRouter"><span class="type-signature"></span>new WebsocketRouter<span class="signature">(websocket, routerId)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Create a WebsocketRouter.</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>websocket</code></td>
<td class="type">
<span class="param-type"><a href="global.html#object">object</a></span>
</td>
<td class="description last"><p>The websocket server that the router will be attahced to.</p></td>
</tr>
<tr>
<td class="name"><code>routerId</code></td>
<td class="type">
<span class="param-type"><a href="global.html#string">string</a></span>
</td>
<td class="description last"><p>The id of the router 'usually its name'.
Had to be known by the client user to be able to sucessfully connect.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="server_middleware_websocket-router_WebsocketRouter.js.html">server/middleware/websocket-router/WebsocketRouter.js</a>, <a href="server_middleware_websocket-router_WebsocketRouter.js.html#line74">line 74</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="disconnect"><span class="type-signature"></span>disconnect<span class="signature">(error)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Forcefully disconnects all connected users (they got a notification).</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>error</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Error">Error</a></span>
</td>
<td class="description last"><p>The error that describes the reason for disconnect.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="server_middleware_websocket-router_WebsocketRouter.js.html">server/middleware/websocket-router/WebsocketRouter.js</a>, <a href="server_middleware_websocket-router_WebsocketRouter.js.html#line136">line 136</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getRoomId"><span class="type-signature"></span>getRoomId<span class="signature">()</span><span class="type-signature"> → {<a href="global.html#string">string</a>}</span></h4>
<div class="description">
<p>Returns the websocket room id.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="server_middleware_websocket-router_WebsocketRouter.js.html">server/middleware/websocket-router/WebsocketRouter.js</a>, <a href="server_middleware_websocket-router_WebsocketRouter.js.html#line154">line 154</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The full id of the websocket room that is used
to separate users of this router.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="global.html#string">string</a></span>
</dd>
</dl>
<h4 class="name" id="getRouterId"><span class="type-signature"></span>getRouterId<span class="signature">()</span><span class="type-signature"> → {<a href="global.html#string">string</a>}</span></h4>
<div class="description">
<p>Returns the websocket router id.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="server_middleware_websocket-router_WebsocketRouter.js.html">server/middleware/websocket-router/WebsocketRouter.js</a>, <a href="server_middleware_websocket-router_WebsocketRouter.js.html#line162">line 162</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The router id of the router.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="global.html#string">string</a></span>
</dd>
</dl>
<h4 class="name" id="onConnect"><span class="type-signature"></span>onConnect<span class="signature">(handleFn)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Sets the event handling function of user connect.</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>handleFn</code></td>
<td class="type">
<span class="param-type"><a href="global.html#function">function</a></span>
</td>
<td class="description last"><p>The function that needs to be called when a user connects.
The function should handle two arguments. The first will be a WebsocketRouterUser object,
while the second is a callback (highlighting with an error object if we accept the connection).</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="server_middleware_websocket-router_WebsocketRouter.js.html">server/middleware/websocket-router/WebsocketRouter.js</a>, <a href="server_middleware_websocket-router_WebsocketRouter.js.html#line116">line 116</a>
</li></ul></dd>
</dl>
<h4 class="name" id="send"><span class="type-signature"></span>send<span class="signature">(payload)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Broadcasts a message to all connected users.</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>payload</code></td>
<td class="type">
<span class="param-type"><a href="global.html#object">object</a></span>
</td>
<td class="description last"><p>The content object of the message (has to be stringifiable!).</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="server_middleware_websocket-router_WebsocketRouter.js.html">server/middleware/websocket-router/WebsocketRouter.js</a>, <a href="server_middleware_websocket-router_WebsocketRouter.js.html#line124">line 124</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="Server_GMEAuth.html">Server:GMEAuth</a></li><li><a href="Server_SafeStorage.html">Server:SafeStorage</a></li><li><a href="Server_UserProject.html">Server:UserProject</a></li><li><a href="module-Core.html">Core</a></li><li><a href="module-Storage.html">Storage</a></li><li><a href="module-crosscuts.html">crosscuts</a></li><li><a href="module-serialization.html">serialization</a></li></ul><h3>Externals</h3><ul><li><a href="external-Promise.html">Promise</a></li></ul><h3>Classes</h3><ul><li><a href="AddOnBase.html">AddOnBase</a></li><li><a href="AddOnUpdateResult.html">AddOnUpdateResult</a></li><li><a href="Artifact.html">Artifact</a></li><li><a href="BlobClient.html">BlobClient</a></li><li><a href="BlobMetadata.html">BlobMetadata</a></li><li><a href="BlobRunPluginClient.html">BlobRunPluginClient</a></li><li><a href="Client.html">Client</a></li><li><a href="Core.html">Core</a></li><li><a href="ExecutorClient.html">ExecutorClient</a></li><li><a href="GMENode.html">GMENode</a></li><li><a href="GmeLogger.html">GmeLogger</a></li><li><a href="InterPluginResult.html">InterPluginResult</a></li><li><a href="JobInfo.html">JobInfo</a></li><li><a href="OutputInfo.html">OutputInfo</a></li><li><a href="PluginBase.html">PluginBase</a></li><li><a href="PluginConfig.html">PluginConfig</a></li><li><a href="PluginMessage.html">PluginMessage</a></li><li><a href="PluginNodeDescription.html">PluginNodeDescription</a></li><li><a href="PluginResult.html">PluginResult</a></li><li><a href="Project.html">Project</a></li><li><a href="ProjectInterface.html">ProjectInterface</a></li><li><a href="Server_GMEAuth-GMEAuth.html">GMEAuth</a></li><li><a href="Server_SafeStorage-SafeStorage.html">SafeStorage</a></li><li><a href="Server_UserProject-UserProject.html">UserProject</a></li><li><a href="WebsocketRouter.html">WebsocketRouter</a></li><li><a href="WebsocketRouterUser.html">WebsocketRouterUser</a></li></ul><h3>Events</h3><ul><li><a href="Client.html#event:BRANCH_CHANGED">BRANCH_CHANGED</a></li><li><a href="Client.html#event:BRANCH_CLOSED">BRANCH_CLOSED</a></li><li><a href="Client.html#event:BRANCH_OPENED">BRANCH_OPENED</a></li><li><a href="Client.html#event:BRANCH_STATUS_CHANGED">BRANCH_STATUS_CHANGED</a></li><li><a href="Client.html#event:CONNECTED_USERS_CHANGED">CONNECTED_USERS_CHANGED</a></li><li><a href="Client.html#event:NETWORK_STATUS_CHANGED">NETWORK_STATUS_CHANGED</a></li><li><a href="Client.html#event:NOTIFICATION">NOTIFICATION</a></li><li><a href="Client.html#event:PLUGIN_FINISHED">PLUGIN_FINISHED</a></li><li><a href="Client.html#event:PLUGIN_INITIATED">PLUGIN_INITIATED</a></li><li><a href="Client.html#event:PLUGIN_NOTIFICATION">PLUGIN_NOTIFICATION</a></li><li><a href="Client.html#event:PROJECT_CLOSED">PROJECT_CLOSED</a></li><li><a href="Client.html#event:PROJECT_OPENED">PROJECT_OPENED</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Fri Jun 21 2024 09:43:40 GMT-0400 (Eastern Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>