stomp
Version:
Implementation of the STOMP protocol in node.js
82 lines (59 loc) • 10.8 kB
HTML
<html> <head> <title>frame.js</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="rocco.css" /> </head> <body> <div id="navbar"> <h3>stomp-js - Implementation of the STOMP protocol in node.js<em></em></h3> </div> <div id="container"> <div id="background"></div> <div id="jump_to"> Jump To … <div id="jump_wrapper"> <div id="jump_page"> <a class="source" href="index.html">Index</a> <a class="source" href="frame.html"> frame.js </a> <a class="source" href="index.html"> index.js </a> <a class="source" href="stomp.html"> stomp.js </a> <a class="source" href="stomp-utils.html"> stomp-utils.js </a> <a class="source" href="stomp-exceptions.html"> stomp-exceptions.js </a> </div> </div> </div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> frame.js </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">¶</a> </div> <h2>frame</h2>
<p>The <code>Frame</code> module provides an object representation of a <code>Stomp</code> frame.</p>
<h3>frame.Frame</h3>
<p>An instance of the <code>Frame</code> object.</p>
<pre><code>var frame = new frame.Frame();</code></pre>
<h3>frame.Frame.build_frame()</h3>
<p>Build a frame object from an object of arguments.</p>
<pre><code>var args = {
command: '',
headers: {},
body: ''
};
this_frame = frame.build_frame(args);</code></pre> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">¶</a> </div> <h2>Frame - Object representation of a STOMP frame</h2> </td> <td class="code"> <div class="highlight"><pre><span class="kd">function</span> <span class="nx">Frame</span><span class="p">()</span> <span class="p">{</span>
<span class="k">this</span><span class="p">.</span><span class="nx">command</span> <span class="o">=</span> <span class="kc">null</span><span class="p">;</span>
<span class="k">this</span><span class="p">.</span><span class="nx">headers</span> <span class="o">=</span> <span class="kc">null</span><span class="p">;</span>
<span class="k">this</span><span class="p">.</span><span class="nx">body</span> <span class="o">=</span> <span class="kc">null</span><span class="p">;</span>
<span class="p">};</span></pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">¶</a> </div> <h2>Frame.build<em>frame(args, want</em>receipt)</h2>
<p><strong>Build frame based on arguments provided</strong></p>
<p>Takes arguments object needed to build frame (command, headers, body?)</p>
<p>Takes boolean to indicate that you wish to get a receipt (set receipt header)</p>
<p>Returns an object representing a frame</p> </td> <td class="code"> <div class="highlight"><pre><span class="nx">Frame</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">build_frame</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">args</span><span class="p">,</span> <span class="nx">want_receipt</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">receipt_stamp</span> <span class="o">=</span> <span class="kc">null</span><span class="p">;</span>
<span class="k">this</span><span class="p">.</span><span class="nx">command</span> <span class="o">=</span> <span class="nx">args</span><span class="p">[</span><span class="s1">'command'</span><span class="p">];</span>
<span class="k">this</span><span class="p">.</span><span class="nx">headers</span> <span class="o">=</span> <span class="nx">args</span><span class="p">[</span><span class="s1">'headers'</span><span class="p">];</span>
<span class="k">this</span><span class="p">.</span><span class="nx">body</span> <span class="o">=</span> <span class="nx">args</span><span class="p">[</span><span class="s1">'body'</span><span class="p">];</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">want_receipt</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">_receipt</span> <span class="o">=</span> <span class="s1">''</span><span class="p">;</span>
<span class="nx">receipt_stamp</span> <span class="o">=</span> <span class="nb">Math</span><span class="p">.</span><span class="nx">floor</span><span class="p">(</span><span class="nb">Math</span><span class="p">.</span><span class="nx">random</span><span class="p">()</span><span class="o">*</span><span class="mi">99999999999</span><span class="p">).</span><span class="nx">toString</span><span class="p">();</span>
<span class="k">if</span> <span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">headers</span><span class="p">[</span><span class="s1">'session'</span><span class="p">]</span> <span class="o">!=</span> <span class="kc">undefined</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">_receipt</span> <span class="o">=</span> <span class="nx">receipt_stamp</span> <span class="o">+</span> <span class="s2">"-"</span> <span class="o">+</span> <span class="k">this</span><span class="p">.</span><span class="nx">headers</span><span class="p">[</span><span class="s1">'session'</span><span class="p">];</span>
<span class="p">}</span>
<span class="k">else</span> <span class="p">{</span>
<span class="nx">_receipt</span> <span class="o">=</span> <span class="nx">receipt_stamp</span><span class="p">;</span>
<span class="p">}</span>
<span class="k">this</span><span class="p">.</span><span class="nx">headers</span><span class="p">[</span><span class="s1">'receipt'</span><span class="p">]</span> <span class="o">=</span> <span class="nx">_receipt</span><span class="p">;</span>
<span class="p">}</span>
<span class="k">return</span> <span class="k">this</span><span class="p">;</span>
<span class="p">};</span></pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">¶</a> </div> <h2>Frame.as_string()</h2>
<p><strong>String representation of Frame object</strong></p>
<p>Returns <code>Frame</code> as string</p> </td> <td class="code"> <div class="highlight"><pre><span class="nx">Frame</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">as_string</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">header_strs</span> <span class="o">=</span> <span class="p">[],</span>
<span class="nx">frame</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
<span class="nx">command</span> <span class="o">=</span> <span class="k">this</span><span class="p">.</span><span class="nx">command</span><span class="p">,</span>
<span class="nx">headers</span> <span class="o">=</span> <span class="k">this</span><span class="p">.</span><span class="nx">headers</span><span class="p">,</span>
<span class="nx">body</span> <span class="o">=</span> <span class="k">this</span><span class="p">.</span><span class="nx">body</span><span class="p">;</span>
<span class="k">for</span> <span class="p">(</span><span class="kd">var</span> <span class="nx">header</span> <span class="k">in</span> <span class="nx">headers</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">header_strs</span><span class="p">.</span><span class="nx">push</span><span class="p">(</span><span class="nx">header</span> <span class="o">+</span> <span class="s1">':'</span> <span class="o">+</span> <span class="nx">headers</span><span class="p">[</span><span class="nx">header</span><span class="p">]);</span>
<span class="p">}</span>
<span class="nx">frame</span> <span class="o">+=</span> <span class="nx">command</span> <span class="o">+</span> <span class="s2">"\n"</span><span class="p">;</span>
<span class="nx">frame</span> <span class="o">+=</span> <span class="nx">header_strs</span><span class="p">.</span><span class="nx">join</span><span class="p">(</span><span class="s2">"\n"</span><span class="p">);</span>
<span class="nx">frame</span> <span class="o">+=</span> <span class="s2">"\n\n"</span><span class="p">;</span>
<span class="k">if</span><span class="p">(</span><span class="nx">body</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">frame</span> <span class="o">+=</span> <span class="nx">body</span><span class="p">;</span>
<span class="p">}</span>
<span class="nx">frame</span> <span class="o">+=</span> <span class="s1">'\x00'</span><span class="p">;</span>
<span class="k">return</span> <span class="nx">frame</span><span class="p">;</span>
<span class="p">};</span>
<span class="nx">module</span><span class="p">.</span><span class="nx">exports</span><span class="p">.</span><span class="nx">Frame</span> <span class="o">=</span> <span class="nx">Frame</span><span class="p">;</span>
</pre></div> </td> </tr> </tbody> </table> </div> </body> </html>