diff options
Diffstat (limited to 'tools/node_modules/nodemailer/node_modules/simplesmtp/node_modules/rai/jsdoc/symbols/RAIServer.html')
-rw-r--r-- | tools/node_modules/nodemailer/node_modules/simplesmtp/node_modules/rai/jsdoc/symbols/RAIServer.html | 565 |
1 files changed, 565 insertions, 0 deletions
diff --git a/tools/node_modules/nodemailer/node_modules/simplesmtp/node_modules/rai/jsdoc/symbols/RAIServer.html b/tools/node_modules/nodemailer/node_modules/simplesmtp/node_modules/rai/jsdoc/symbols/RAIServer.html new file mode 100644 index 0000000..3e91613 --- /dev/null +++ b/tools/node_modules/nodemailer/node_modules/simplesmtp/node_modules/rai/jsdoc/symbols/RAIServer.html @@ -0,0 +1,565 @@ + +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="generator" content="JsDoc Toolkit" /> + <title>RAIServer | JsDoc Reference</title> + + <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0" /> + <meta name="mobileoptimized" content="0" /> + + <link rel="stylesheet" href="../css/all.css" media="all" /> + <link rel="stylesheet" href="../css/handheld.css" media="only screen and (max-width: 660px)" /> + <link rel="stylesheet" href="../css/handheld.css" media="handheld" /> + <link rel="stylesheet" href="../css/screen.css" media="screen and (min-width: 661px)" /> + + <script src="../javascript/all.js"></script> + <!--[if lt IE 9]> + <script src="../javascript/html5.js"></script> + <![endif]--> + </head> + + <body> + +<div class="index"> + <div class="menu"> + <div class="indexLinks"> + <a href="../index.html">Classes</a> + <a href="../files.html">Files</a> + </div> + + <h2 class="heading1">Classes</h2> + + <input type="text" name="classFilter" class="classFilter" id="ClassFilter" placeholder="Filter"></input> + + <nav> + <ul class="classList" id="ClassList"> + + <li><a href="../symbols/_global_.html">_global_</a></li> + + <li><a href="../symbols/mockup.html">mockup</a></li> + + <li><a href="../symbols/RAIServer.html">RAIServer</a></li> + + <li><a href="../symbols/RAISocket.html">RAISocket</a></li> + + <li><a href="../symbols/starttls.html">starttls</a></li> + + </ul> + </nav> + </div> + <div class="fineprint" style="clear:both"> + <footer> + + Documentation generator: <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0<br /> + Template: <a href="http://www.thebrightlines.com/2010/05/06/new-template-for-jsdoctoolkit-codeview/" target="_blank">Codeview</a> 1.2<br /> + Generated on: + <time datetime='2012-0-22' pubdate>2012-0-22 12:15</time> + </footer> + </div> +</div> + +<div class="index indexStatic"></div> + +<div class="content"> + <div class="innerContent"> + <article> + <header> + <h1 class="classTitle"> + + Class <span>RAIServer</span> + </h1> + + <div class="intro"> + <p class="description summary"> + + </p> + + + <ul class="summary"> + + + + <li>Defined in: <a href="../symbols/src/RAI_lib_rai.js.html">rai.js</a></li> + + + </ul> + + </div> + </header> + + + <section> + <div class="props"> + <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class RAIServer."> + <caption class="sectionTitle">Class Summary</caption> + <thead> + <tr> + <th scope="col">Constructor Attributes</th> + <th scope="col">Constructor Name and Description</th> + </tr> + </thead> + <tbody> + <tr> + <td class="attributes"> </td> + <td class="nameDescription" > + <div class="fixedFont"> + <b><a href="../symbols/RAIServer.html#constructor">RAIServer</a></b>(options) + </div> + <div class="description"><p>Creates instance of RAIServer</p> + +<p>Options object has the following properties:</p> + +<ul> + <li><b>debug</b> - if set to true print traffic to console</li> + <li><b>disconnectOnTimeout</b> - if set to true close the connection on disconnect</li> + <li><b>timeout</b> - timeout in milliseconds for disconnecting the client, + defaults to 0 (no timeout)</li> +</ul> + +<p><b>Events</b></p> + +<ul> + <li><b>'connect'</b> - emitted if a client connects to the server, param + is a client (<a href="../symbols/RAISocket.html">RAISocket</a>) object</li> + <li><b>'error'</b> - emitted on error, has an error object as a param</li> +</ul></div> + </td> + </tr> + </tbody> + </table> + </div> + </section> + + + + <!-- + #### METHODS SUMMARY + --> + + <section> + + + <div class="props"> + <h2 class="sectionTitle">Method Summary</h2> + + + <nav> + <table class="summaryTable" id="MethodsList" cellspacing="0" summary="A summary of the methods documented in the class RAIServer."> + <thead> + <tr> + <th scope="col">Method Attributes</th> + <th scope="col">Method Name and Description</th> + </tr> + </thead> + + <tbody> + + + <tr + class='item0' + > + <td class="attributes"><private> </td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/RAIServer.html#_createServer">_createServer</a></b>() + </div> + <div class="description"><p>Creates a server with listener callback</p></div> + </td> + </tr> + + <tr + class='item1' + > + <td class="attributes"><private> </td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/RAIServer.html#_serverListener">_serverListener</a></b>(socket) + </div> + <div class="description"><p>Server listener that is run on client connection</p> + +<p><a href="../symbols/RAISocket.html">RAISocket</a> object instance is created based on the client socket + and a <code>'connection'</code> event is emitted</p></div> + </td> + </tr> + + <tr + class='item2' + > + <td class="attributes"> </td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/RAIServer.html#end">end</a></b>(callback) + </div> + <div class="description"><p>Stops the server</p></div> + </td> + </tr> + + <tr + class='item3' + > + <td class="attributes"> </td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/RAIServer.html#listen">listen</a></b>(port, host, callback) + </div> + <div class="description"><p>Starts listening on selected port</p></div> + </td> + </tr> + + </tbody> + </table> + </nav> + + + + </div> + </section> + + + <!-- + #### EVENTS SUMMARY + --> + + + <section> + + <nav> + <div class="props"> + <table class="summaryTable" cellspacing="0" summary="A summary of the events documented in the class RAIServer."> + <caption class="sectionTitle">Event Summary</caption> + + <thead> + <tr> + <th scope="col">Event Attributes</th> + <th scope="col">Event Name and Description</th> + </tr> + </thead> + + <tbody> + + <tr> + <td class="attributes"><private> </td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/RAIServer.html#event:_onError">_onError</a></b>(err) + </div> + <div class="description"><p>Listens for errors</p></div> + </td> + </tr> + + </tbody> + </table> + </div> + </nav> + + + + </section> + + <!-- + #### CONSTRUCTOR DETAILS + --> + + <section> + <div class="details props"> + <div class="innerProps"> + <h2 class="sectionTitle" id="constructor"> + Class Detail + </h2> + + <div class="fixedFont"> + <b>RAIServer</b>(options) + </div> + + <div class="description"> + <p>Creates instance of RAIServer</p> + +<p>Options object has the following properties:</p> + +<ul> + <li><b>debug</b> - if set to true print traffic to console</li> + <li><b>disconnectOnTimeout</b> - if set to true close the connection on disconnect</li> + <li><b>timeout</b> - timeout in milliseconds for disconnecting the client, + defaults to 0 (no timeout)</li> +</ul> + +<p><b>Events</b></p> + +<ul> + <li><b>'connect'</b> - emitted if a client connects to the server, param + is a client (<a href="../symbols/RAISocket.html">RAISocket</a>) object</li> + <li><b>'error'</b> - emitted on error, has an error object as a param</li> +</ul> + + </div> + + + + + <dl class="detailList params"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{Object}</span> <b>options</b> + <i>Optional</i> + </dt> + <dd>Optional options object</dd> + + </dl> + + + + </div> + </div> + </section> + + <!-- + #### FIELD DETAILS + --> + + <!-- + #### METHOD DETAILS + --> + + <section> + <div class="details props"> + <div class="innerProps"> + <h2 class="sectionTitle"> + Method Detail + </h2> + + <ul class="methodDetail" id="MethodDetail"> + + + <li + class='item0' + > + <div class="fixedFont heading" id="_createServer"> + <span class='lighter'> + <private> + </span> + + + + <b>_createServer</b>() + </div> + + <div class="description"> + <p>Creates a server with listener callback</p> + + + + + </div> + + + + + + + <div class="hr"></div> + </li> + + <li + class='item1' + > + <div class="fixedFont heading" id="_serverListener"> + <span class='lighter'> + <private> + </span> + + + + <b>_serverListener</b>(socket) + </div> + + <div class="description"> + <p>Server listener that is run on client connection</p> + +<p><a href="../symbols/RAISocket.html">RAISocket</a> object instance is created based on the client socket + and a <code>'connection'</code> event is emitted</p> + + + + + </div> + + + + + <dl class="detailList params"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{Object}</span> <b>socket</b> + + </dt> + <dd>The socket to the client</dd> + + </dl> + + + + <div class="hr"></div> + </li> + + <li + class='item2' + > + <div class="fixedFont heading" id="end"> + <span class='lighter'> + + </span> + + + + <b>end</b>(callback) + </div> + + <div class="description"> + <p>Stops the server</p> + + + + + </div> + + + + + <dl class="detailList params"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{Function}</span> <b>callback</b> + + </dt> + <dd>Is run when the server is closed</dd> + + </dl> + + + + <div class="hr"></div> + </li> + + <li + class='item3' + > + <div class="fixedFont heading" id="listen"> + <span class='lighter'> + + </span> + + + + <b>listen</b>(port, host, callback) + </div> + + <div class="description"> + <p>Starts listening on selected port</p> + + + + + </div> + + + + + <dl class="detailList params"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{Number}</span> <b>port</b> + + </dt> + <dd>The port to listen</dd> + + <dt> + <span class="light fixedFont">{String}</span> <b>host</b> + <i>Optional</i> + </dt> + <dd>The IP address to listen</dd> + + <dt> + <span class="light fixedFont">{Function}</span> <b>callback</b> + + </dt> + <dd>The callback function to be run after the server +is listening, the only param is an error message if the operation failed</dd> + + </dl> + + + + + </li> + + </ul> + </div> + </div> + </section> + + + <!-- + #### EVENT DETAILS + --> + + <section> + <div class="details props"> + <div class="innerProps"> + <h2 class="sectionTitle"> + Event Detail + </h2> + + + <div class="fixedFont heading" id="event:_onError"> + <span class='lighter'> + <private> + </span> + + + + <b>_onError</b>(err) + </div> + + <div class="description"> + <p>Listens for errors</p> + + + + + </div> + + + + + <dl class="detailList params"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{Object}</span> <b>err</b> + + </dt> + <dd>Error object</dd> + + </dl> + + + + + + + </div> + </div> + </section> + + </article> + </div> +</div> + + <script type="text/javascript"> + wbos.CssTools.MediaQueryFallBack.LoadCss('../css/screen.css', '../css/handheld.css', 660) + codeview.classFilter.Init() + </script> + </body> +</html> + |