diff options
Diffstat (limited to 'tools/node_modules/nodemailer/node_modules/simplesmtp/node_modules/rai/jsdoc/symbols/RAISocket.html')
| -rw-r--r-- | tools/node_modules/nodemailer/node_modules/simplesmtp/node_modules/rai/jsdoc/symbols/RAISocket.html | 826 |
1 files changed, 826 insertions, 0 deletions
diff --git a/tools/node_modules/nodemailer/node_modules/simplesmtp/node_modules/rai/jsdoc/symbols/RAISocket.html b/tools/node_modules/nodemailer/node_modules/simplesmtp/node_modules/rai/jsdoc/symbols/RAISocket.html new file mode 100644 index 0000000..15cad38 --- /dev/null +++ b/tools/node_modules/nodemailer/node_modules/simplesmtp/node_modules/rai/jsdoc/symbols/RAISocket.html @@ -0,0 +1,826 @@ + +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="generator" content="JsDoc Toolkit" /> + <title>RAISocket | 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>RAISocket</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 RAISocket."> + <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/RAISocket.html#constructor">RAISocket</a></b>(socket, options) + </div> + <div class="description"><p>Creates a instance for interacting with a client (socket)</p> + +<p>Optional options object is the same that is passed to the parent +<a href="../symbols/RAIServer.html">RAIServer</a> object</p> + +<p><b>Events</b></p> + +<ul> + <li><b>'command'</b> - emitted if a client sends a command.</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 RAISocket."> + <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/RAISocket.html#_destroy">_destroy</a></b>() + </div> + <div class="description"><p>Called when the connection is or is going to be ended</p></div> + </td> + </tr> + + <tr + class='item1' + > + <td class="attributes"><private> </td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/RAISocket.html#_processData">_processData</a></b>(str) + </div> + <div class="description"><p>Processed incoming command lines and emits found data as +<code>'command'</code> with the command name as the first param and the rest +of the data as second (Buffer)</p></div> + </td> + </tr> + + <tr + class='item2' + > + <td class="attributes"> </td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/RAISocket.html#end">end</a></b>() + </div> + <div class="description"><p>Closes the connection to the client</p></div> + </td> + </tr> + + <tr + class='item3' + > + <td class="attributes"> </td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/RAISocket.html#send">send</a></b>(data) + </div> + <div class="description"><p>Sends some data to the client.</div> + </td> + </tr> + + <tr + class='item4' + > + <td class="attributes"> </td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/RAISocket.html#startDataMode">startDataMode</a></b>(sequence) + </div> + <div class="description"><p>Instructs the server to be listening for mixed data instead of line based + commands</p></div> + </td> + </tr> + + <tr + class='item5' + > + <td class="attributes"> </td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/RAISocket.html#startTLS">startTLS</a></b>(credentials, callback) + </div> + <div class="description"><p>Instructs the server to upgrade the connection to secure TLS connection</p> + +<p>Fires <code>callback</code> on successful connection upgrade if set, +otherwise emits <code>'tls'</code></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 RAISocket."> + <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/RAISocket.html#event:_onClose">_onClose</a></b>(hadError) + </div> + <div class="description"><p>Called when the connection is closed</p></div> + </td> + </tr> + + <tr> + <td class="attributes"><private> </td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/RAISocket.html#event:_onEnd">_onEnd</a></b>() + </div> + <div class="description"><p>Called when the connection is ended.</div> + </td> + </tr> + + <tr> + <td class="attributes"><private> </td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/RAISocket.html#event:_onError">_onError</a></b>(err) + </div> + <div class="description"><p>Called when an error has appeared.</div> + </td> + </tr> + + <tr> + <td class="attributes"><private> </td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/RAISocket.html#event:_onReceiveData">_onReceiveData</a></b>(chunk) + </div> + <div class="description"><p>Called when a chunk of data arrives from the client.</div> + </td> + </tr> + + <tr> + <td class="attributes"><private> </td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/RAISocket.html#event:_onTimeout">_onTimeout</a></b>() + </div> + <div class="description"><p>Called when a timeout has occured.</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>RAISocket</b>(socket, options) + </div> + + <div class="description"> + <p>Creates a instance for interacting with a client (socket)</p> + +<p>Optional options object is the same that is passed to the parent +<a href="../symbols/RAIServer.html">RAIServer</a> object</p> + +<p><b>Events</b></p> + +<ul> + <li><b>'command'</b> - emitted if a client sends a command. Gets two + params - command (String) and payload (Buffer)</li> + <li><b>'data'</b> - emitted when a chunk is received in data mode, the + param being the payload (Buffer)</li> + <li><b>'ready'</b> - emitted when data stream ends and normal command + flow is recovered</li> + <li><b>'tls'</b> - emitted when the connection is secured by TLS</li> + <li><b>'error'</b> - emitted when an error occurs. Connection to the + client is disconnected automatically. Param is an error object.</l> + <li><b>'timeout'</b> - emitted when a timeout occurs. Connection to the + client is disconnected automatically if disconnectOnTimeout option + is set to true.</l> + <li><b>'end'</b> - emitted when the client disconnects</l> +</ul> + + </div> + + + + + <dl class="detailList params"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{Object}</span> <b>socket</b> + + </dt> + <dd>Socket for the client</dd> + + <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="_destroy"> + <span class='lighter'> + <private> + </span> + + + + <b>_destroy</b>() + </div> + + <div class="description"> + <p>Called when the connection is or is going to be ended</p> + + + + + </div> + + + + + + + <div class="hr"></div> + </li> + + <li + class='item1' + > + <div class="fixedFont heading" id="_processData"> + <span class='lighter'> + <private> + </span> + + + + <b>_processData</b>(str) + </div> + + <div class="description"> + <p>Processed incoming command lines and emits found data as +<code>'command'</code> with the command name as the first param and the rest +of the data as second (Buffer)</p> + + + + + </div> + + + + + <dl class="detailList params"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{String}</span> <b>str</b> + + </dt> + <dd>Binary string to be processed</dd> + + </dl> + + + + <div class="hr"></div> + </li> + + <li + class='item2' + > + <div class="fixedFont heading" id="end"> + <span class='lighter'> + + </span> + + + + <b>end</b>() + </div> + + <div class="description"> + <p>Closes the connection to the client</p> + + + + + </div> + + + + + + + <div class="hr"></div> + </li> + + <li + class='item3' + > + <div class="fixedFont heading" id="send"> + <span class='lighter'> + + </span> + + + + <b>send</b>(data) + </div> + + <div class="description"> + <p>Sends some data to the client. <code><CR><LF></code> is automatically appended to + the data</p> + + + + + </div> + + + + + <dl class="detailList params"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{String|Buffer}</span> <b>data</b> + + </dt> + <dd>Data to be sent to the client</dd> + + </dl> + + + + <div class="hr"></div> + </li> + + <li + class='item4' + > + <div class="fixedFont heading" id="startDataMode"> + <span class='lighter'> + + </span> + + + + <b>startDataMode</b>(sequence) + </div> + + <div class="description"> + <p>Instructs the server to be listening for mixed data instead of line based + commands</p> + + + + + </div> + + + + + <dl class="detailList params"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{String}</span> <b>sequence</b> + <i>Optional, Default: "."</i> + </dt> + <dd>- optional sequence on separate line for + matching the data end</dd> + + </dl> + + + + <div class="hr"></div> + </li> + + <li + class='item5' + > + <div class="fixedFont heading" id="startTLS"> + <span class='lighter'> + + </span> + + + + <b>startTLS</b>(credentials, callback) + </div> + + <div class="description"> + <p>Instructs the server to upgrade the connection to secure TLS connection</p> + +<p>Fires <code>callback</code> on successful connection upgrade if set, +otherwise emits <code>'tls'</code></p> + + + + + </div> + + + + + <dl class="detailList params"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{Object}</span> <b>credentials</b> + <i>Optional</i> + </dt> + <dd>An object with PEM encoded key and + certificate <code>{key:"---BEGIN...", cert:"---BEGIN..."}</code>, + if not set autogenerated values will be used.</dd> + + <dt> + <span class="light fixedFont">{Function}</span> <b>callback</b> + <i>Optional</i> + </dt> + <dd>If calback is set fire it after successful connection + upgrade, otherwise <code>'tls'</code> is emitted</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:_onClose"> + <span class='lighter'> + <private> + </span> + + + + <b>_onClose</b>(hadError) + </div> + + <div class="description"> + <p>Called when the connection is closed</p> + + + + + </div> + + + + + <dl class="detailList params"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{Boolean}</span> <b>hadError</b> + + </dt> + <dd>did the connection end because of an error?</dd> + + </dl> + + + + + <div class="hr"></div> + + <div class="fixedFont heading" id="event:_onEnd"> + <span class='lighter'> + <private> + </span> + + + + <b>_onEnd</b>() + </div> + + <div class="description"> + <p>Called when the connection is ended. Emits <code>'end'</code></p> + + + + + </div> + + + + + + + + <div class="hr"></div> + + <div class="fixedFont heading" id="event:_onError"> + <span class='lighter'> + <private> + </span> + + + + <b>_onError</b>(err) + </div> + + <div class="description"> + <p>Called when an error has appeared. Emits <code>'error'</code> with +the error object as a parameter.</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 class="hr"></div> + + <div class="fixedFont heading" id="event:_onReceiveData"> + <span class='lighter'> + <private> + </span> + + + + <b>_onReceiveData</b>(chunk) + </div> + + <div class="description"> + <p>Called when a chunk of data arrives from the client. If currently in data +mode, transmit the data otherwise send it to <code>_processData</code></p> + + + + + </div> + + + + + <dl class="detailList params"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{Buffer|String}</span> <b>chunk</b> + + </dt> + <dd>Data sent by the client</dd> + + </dl> + + + + + <div class="hr"></div> + + <div class="fixedFont heading" id="event:_onTimeout"> + <span class='lighter'> + <private> + </span> + + + + <b>_onTimeout</b>() + </div> + + <div class="description"> + <p>Called when a timeout has occured. Connection will be closed and +<code>'timeout'</code> is emitted.</p> + + + + + </div> + + + + + + + + + + </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> + |