docs/reference/module-plugin-Plugin.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Class: Plugin</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: Plugin</h1>

    
<section>

<header>
    
        <h2><span class="attribs"><span class="type-signature"></span></span>
            <span class="ancestors"><a href="module-plugin.html">plugin</a>~</span>Plugin<span class="signature">(node)</span><span class="type-signature"></span></h2>
        
            <div class="class-description"><p>Plugin</p></div>
        
    
</header>

<article>
    <div class="container-overview">
    
        
    <h2>Constructor</h2>
    

    <h4 class="name" id="Plugin"><span class="type-signature"></span>new Plugin<span class="signature">(node)</span><span class="type-signature"></span></h4>
    

<div class="description">
    <p>Create a plugin.</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>node</code></td>
            

            <td class="type">
            
                
<span class="param-type">Node</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="plugin.js.html">plugin.js</a>, <a href="plugin.js.html#line22">line 22</a>
    </li></ul></dd>
    

</dl>


    </div>

    
        <h3 class="subsection-title">Extends</h3>

        
    <ul>
        <li><a href="DSNP.html">DSNP</a></li>
    </ul>


        <h3 class="subsection-title">Methods</h3>

        
    <h4 class="name" id="init"><span class="type-signature"></span>init<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    <p>initialize signaling services</p>
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="DSNP.html#init">DSNP#init</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="dsnp.js.html">dsnp.js</a>, <a href="dsnp.js.html#line29">line 29</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="initHttpServer"><span class="type-signature"></span>initHttpServer<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    <p>initialize the http server for healthcheck/static content</p>
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="DSNP.html#initHttpServer">DSNP#initHttpServer</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="dsnp.js.html">dsnp.js</a>, <a href="dsnp.js.html#line40">line 40</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="initWebSocketServer"><span class="type-signature"></span>initWebSocketServer<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    <p>initialize the web socket server for signaling</p>
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="DSNP.html#initWebSocketServer">DSNP#initWebSocketServer</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="dsnp.js.html">dsnp.js</a>, <a href="dsnp.js.html#line53">line 53</a>
    </li></ul></dd>
    

</dl>


</article>

</section>


</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-plugin.html">plugin</a></li></ul><h3>Classes</h3><ul><li><a href="DSNP.html">DSNP</a></li><li><a href="module-plugin-Plugin.html">Plugin</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Apr 08 2018 15:56:16 GMT-0700 (PDT)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>