RubyGems - siffer - Versions diffs - 0.0.4 - Mend

siffer 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (91) hide show

data/LICENSE +20 -0
data/README.rdoc +65 -0
data/Rakefile +64 -0
data/bin/siffer +71 -0
data/doc/SIF ImplementationSpecification.pdf +0 -0
data/doc/rdoc/classes/Siffer.html +374 -0
data/doc/rdoc/classes/Siffer/Agent.html +296 -0
data/doc/rdoc/classes/Siffer/Container.html +286 -0
data/doc/rdoc/classes/Siffer/Messages.html +141 -0
data/doc/rdoc/classes/Siffer/Messages/Ack.html +216 -0
data/doc/rdoc/classes/Siffer/Messages/Acl.html +160 -0
data/doc/rdoc/classes/Siffer/Messages/Error.html +248 -0
data/doc/rdoc/classes/Siffer/Messages/Message.html +359 -0
data/doc/rdoc/classes/Siffer/Messages/Message/Header.html +181 -0
data/doc/rdoc/classes/Siffer/Messages/Register.html +257 -0
data/doc/rdoc/classes/Siffer/Messages/RequestBody.html +300 -0
data/doc/rdoc/classes/Siffer/Messages/Status.html +269 -0
data/doc/rdoc/classes/Siffer/Messaging.html +331 -0
data/doc/rdoc/classes/Siffer/Protocol.html +388 -0
data/doc/rdoc/classes/Siffer/Protocol/NonPostRequest.html +111 -0
data/doc/rdoc/classes/Siffer/Protocol/UnknownPath.html +111 -0
data/doc/rdoc/classes/Siffer/Registration.html +391 -0
data/doc/rdoc/classes/Siffer/Request.html +209 -0
data/doc/rdoc/classes/Siffer/RequestLogger.html +211 -0
data/doc/rdoc/classes/Siffer/Response.html +182 -0
data/doc/rdoc/classes/Siffer/Server.html +242 -0
data/doc/rdoc/created.rid +1 -0
data/doc/rdoc/files/LICENSE.html +129 -0
data/doc/rdoc/files/README_rdoc.html +184 -0
data/doc/rdoc/files/lib/agent_rb.html +101 -0
data/doc/rdoc/files/lib/container_rb.html +108 -0
data/doc/rdoc/files/lib/messages/ack_rb.html +101 -0
data/doc/rdoc/files/lib/messages/acl_rb.html +101 -0
data/doc/rdoc/files/lib/messages/error_rb.html +101 -0
data/doc/rdoc/files/lib/messages/message_rb.html +101 -0
data/doc/rdoc/files/lib/messages/register_rb.html +101 -0
data/doc/rdoc/files/lib/messages/request_body_rb.html +101 -0
data/doc/rdoc/files/lib/messages/status_rb.html +101 -0
data/doc/rdoc/files/lib/messages_rb.html +114 -0
data/doc/rdoc/files/lib/messaging_rb.html +101 -0
data/doc/rdoc/files/lib/protocol_rb.html +101 -0
data/doc/rdoc/files/lib/registration_rb.html +101 -0
data/doc/rdoc/files/lib/request_logger_rb.html +101 -0
data/doc/rdoc/files/lib/request_rb.html +101 -0
data/doc/rdoc/files/lib/response_rb.html +101 -0
data/doc/rdoc/files/lib/server_rb.html +101 -0
data/doc/rdoc/files/lib/siffer_rb.html +115 -0
data/doc/rdoc/fr_class_index.html +47 -0
data/doc/rdoc/fr_file_index.html +46 -0
data/doc/rdoc/fr_method_index.html +96 -0
data/doc/rdoc/index.html +24 -0
data/doc/rdoc/rdoc-style.css +208 -0
data/lib/agent.rb +43 -0
data/lib/container.rb +96 -0
data/lib/messages.rb +7 -0
data/lib/messages/ack.rb +43 -0
data/lib/messages/acl.rb +25 -0
data/lib/messages/error.rb +174 -0
data/lib/messages/message.rb +71 -0
data/lib/messages/register.rb +60 -0
data/lib/messages/request_body.rb +66 -0
data/lib/messages/status.rb +55 -0
data/lib/messaging.rb +96 -0
data/lib/protocol.rb +159 -0
data/lib/registration.rb +87 -0
data/lib/request.rb +25 -0
data/lib/request_logger.rb +31 -0
data/lib/response.rb +26 -0
data/lib/server.rb +40 -0
data/lib/siffer.rb +44 -0
data/spec/agent_spec.rb +53 -0
data/spec/cli_spec.rb +40 -0
data/spec/container_spec.rb +103 -0
data/spec/default_agent +6 -0
data/spec/default_server +5 -0
data/spec/message_specs/ack_spec.rb +28 -0
data/spec/message_specs/error_spec.rb +24 -0
data/spec/message_specs/header_spec.rb +25 -0
data/spec/message_specs/message_spec.rb +57 -0
data/spec/message_specs/register_spec.rb +86 -0
data/spec/message_specs/request_body_spec.rb +58 -0
data/spec/message_specs/status_spec.rb +25 -0
data/spec/messaging_spec.rb +88 -0
data/spec/protocol_spec.rb +49 -0
data/spec/registration_spec.rb +33 -0
data/spec/request_logger_spec.rb +15 -0
data/spec/request_spec.rb +10 -0
data/spec/response_spec.rb +24 -0
data/spec/server_spec.rb +35 -0
data/spec/spec_helper.rb +26 -0
metadata +191 -0

data/doc/rdoc/classes/Siffer/Messages/Error.html ADDED

@@ -0,0 +1,248 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Siffer::Messages::Error</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Siffer::Messages::Error</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../files/lib/messages/error_rb.html">
+                lib/messages/error.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000029">new</a>&nbsp;&nbsp;
+      <a href="#M000030">read</a>&nbsp;&nbsp;
+      <a href="#M000031">to_str</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <div id="constants-list">
+      <h3 class="section-bar">Constants</h3>
+      <div class="name-list">
+        <table summary="Constants">
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">CATEGORY</td>
+          <td>=</td>
+          <td class="context-item-value">[         &quot;Unknown (This should NEVER be used if possible)&quot;,         &quot;XML Validation&quot;,         &quot;Encryption&quot;,         &quot;Authentication&quot;,         &quot;Access and Permissions&quot;,         &quot;Registration&quot;,         &quot;Provision&quot;,         &quot;Subscription&quot;,         &quot;Request and Response&quot;,         &quot;Event Reporting and Processing&quot;,         &quot;Transport&quot;,         &quot;System (OS, Database, Vendor localized, etc.)&quot;,         &quot;Generic Message Handling&quot;,         &quot;SMB Handling&quot;</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+Categories of Errors specified by SIF
+</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">CODE</td>
+          <td>=</td>
+          <td class="context-item-value">{         CATEGORY[1] =&gt; [ # Xml Validation           &quot;&quot;,           &quot;Generic error&quot;,           &quot;Message is not well-formed&quot;,           &quot;Generic validation error&quot;,           &quot;Invalid value for element/attribute&quot;,           &quot;&quot;,           &quot;Missing mandatory element/attribute&quot;</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+Codes related to CATEGORY Some codes are blank to match the SIF Spec
+</td>
+        </tr>
+        </table>
+      </div>
+    </div>
+    <div id="attribute-list">
+      <h3 class="section-bar">Attributes</h3>
+      <div class="name-list">
+        <table>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">category</td>
+          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">code</td>
+          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">description</td>
+          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        </table>
+      </div>
+    </div>
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+      <div id="method-M000029" class="method-detail">
+        <a name="M000029"></a>
+        <div class="method-heading">
+          <a href="#M000029" class="method-signature">
+          <span class="method-name">new</span><span class="method-args">(category, code, desc = nil)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000029-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000029-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/messages/error.rb, line 7</span>
+ 7:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">category</span>, <span class="ruby-identifier">code</span>, <span class="ruby-identifier">desc</span> = <span class="ruby-keyword kw">nil</span>)
+ 8:         <span class="ruby-ivar">@category</span> = <span class="ruby-constant">CATEGORY</span>[<span class="ruby-identifier">category</span>]
+ 9:         <span class="ruby-ivar">@category_index</span> = <span class="ruby-identifier">category</span>
+10:         <span class="ruby-ivar">@code</span> = <span class="ruby-constant">CODE</span>[<span class="ruby-ivar">@category</span>][<span class="ruby-identifier">code</span>]
+11:         <span class="ruby-ivar">@code_index</span> = <span class="ruby-identifier">code</span>
+12:         <span class="ruby-ivar">@description</span> = <span class="ruby-identifier">desc</span>
+13:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000030" class="method-detail">
+        <a name="M000030"></a>
+        <div class="method-heading">
+          <a href="#M000030" class="method-signature">
+          <span class="method-name">read</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000030-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000030-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/messages/error.rb, line 15</span>
+15:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">read</span>
+16:         <span class="ruby-identifier">xml</span> = <span class="ruby-constant">Builder</span><span class="ruby-operator">::</span><span class="ruby-constant">XmlMarkup</span>.<span class="ruby-identifier">new</span>
+17:         <span class="ruby-identifier">xml</span>.<span class="ruby-constant">SIF_Error</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">error</span><span class="ruby-operator">|</span>
+18:           <span class="ruby-identifier">error</span>.<span class="ruby-constant">SIF_Category</span>(<span class="ruby-ivar">@category_index</span>)
+19:           <span class="ruby-identifier">error</span>.<span class="ruby-constant">SIF_Code</span>(<span class="ruby-ivar">@code_index</span>)
+20:           <span class="ruby-identifier">error</span>.<span class="ruby-constant">SIF_Desc</span>(<span class="ruby-ivar">@code</span>)
+21:           <span class="ruby-identifier">error</span>.<span class="ruby-constant">SIF_ExtendedDesc</span>(<span class="ruby-ivar">@description</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@description</span>.<span class="ruby-identifier">nil?</span>
+22:         }
+23:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000031" class="method-detail">
+        <a name="M000031"></a>
+        <div class="method-heading">
+          <span class="method-name">to_str</span><span class="method-args">()</span>
+        </div>
+        <div class="method-description">
+          <p>
+Alias for <a href="Error.html#M000030">read</a>
+</p>
+        </div>
+      </div>
+    </div>
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>

data/doc/rdoc/classes/Siffer/Messages/Message.html ADDED

@@ -0,0 +1,359 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Siffer::Messages::Message</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Siffer::Messages::Message</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../files/lib/messages/message_rb.html">
+                lib/messages/message.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+Base class for all <a href="../Messages.html">Messages</a> in the
+framework. Embeds the XMLNS as well as the version of SIF implemented.
+</p>
+    </div>
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000021">body</a>&nbsp;&nbsp;
+      <a href="#M000018">content</a>&nbsp;&nbsp;
+      <a href="#M000020">msg_id</a>&nbsp;&nbsp;
+      <a href="#M000017">new</a>&nbsp;&nbsp;
+      <a href="#M000022">put_header_into</a>&nbsp;&nbsp;
+      <a href="#M000023">read</a>&nbsp;&nbsp;
+      <a href="#M000019">source_id</a>&nbsp;&nbsp;
+      <a href="#M000024">to_str</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <div id="class-list">
+      <h3 class="section-bar">Classes and Modules</h3>
+      Class <a href="Message/Header.html" class="link">Siffer::Messages::Message::Header</a><br />
+    </div>
+    <div id="attribute-list">
+      <h3 class="section-bar">Attributes</h3>
+      <div class="name-list">
+        <table>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">header</td>
+          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">version</td>
+          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">xmlns</td>
+          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        </table>
+      </div>
+    </div>
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+      <div id="method-M000017" class="method-detail">
+        <a name="M000017"></a>
+        <div class="method-heading">
+          <a href="#M000017" class="method-signature">
+          <span class="method-name">new</span><span class="method-args">(source, options = {})</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+source parameter is required (string describing the original sender)
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000017-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000017-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/messages/message.rb, line 11</span>
+11:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">source</span>, <span class="ruby-identifier">options</span> = {})
+12:         <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">&quot;Source not provided.&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">source</span>.<span class="ruby-identifier">nil?</span>
+13:         <span class="ruby-ivar">@xmlns</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:xmlns</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">Siffer</span>.<span class="ruby-identifier">sif_xmlns</span>
+14:         <span class="ruby-ivar">@version</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:version</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">Siffer</span>.<span class="ruby-identifier">sif_version</span>
+15:         <span class="ruby-ivar">@header</span> = <span class="ruby-constant">Header</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">source</span>)
+16:         <span class="ruby-ivar">@body</span> = <span class="ruby-constant">Builder</span><span class="ruby-operator">::</span><span class="ruby-constant">XmlMarkup</span>.<span class="ruby-identifier">new</span>
+17:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000021" class="method-detail">
+        <a name="M000021"></a>
+        <div class="method-heading">
+          <span class="method-name">body</span><span class="method-args">()</span>
+        </div>
+        <div class="method-description">
+          <p>
+Alias for <a href="Message.html#M000018">content</a>
+</p>
+        </div>
+      </div>
+      <div id="method-M000018" class="method-detail">
+        <a name="M000018"></a>
+        <div class="method-heading">
+          <a href="#M000018" class="method-signature">
+          <span class="method-name">content</span><span class="method-args">() {|xml if block_given?| ...}</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Builds the xml for this message. Accepts a block if nested elements are
+required.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000018-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000018-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/messages/message.rb, line 21</span>
+21:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">content</span>
+22:         <span class="ruby-ivar">@xml</span> <span class="ruby-operator">||=</span> <span class="ruby-ivar">@body</span>.<span class="ruby-constant">SIF_Message</span>(<span class="ruby-identifier">:version</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@version</span>, <span class="ruby-identifier">:xmlns</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@xmlns</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">xml</span><span class="ruby-operator">|</span>
+23:           <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">xml</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
+24:         }
+25:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000020" class="method-detail">
+        <a name="M000020"></a>
+        <div class="method-heading">
+          <a href="#M000020" class="method-signature">
+          <span class="method-name">msg_id</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Alias method to the <a href="Message/Header.html">Header</a> MsgId
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000020-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000020-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/messages/message.rb, line 30</span>
+30:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">msg_id</span>() <span class="ruby-identifier">header</span>.<span class="ruby-identifier">msg_id</span>; <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000022" class="method-detail">
+        <a name="M000022"></a>
+        <div class="method-heading">
+          <a href="#M000022" class="method-signature">
+          <span class="method-name">put_header_into</span><span class="method-args">(xml)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000022-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000022-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/messages/message.rb, line 36</span>
+36:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">put_header_into</span>(<span class="ruby-identifier">xml</span>)
+37:         <span class="ruby-identifier">xml</span>.<span class="ruby-constant">SIF_Header</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">head</span><span class="ruby-operator">|</span>
+38:           <span class="ruby-identifier">head</span>.<span class="ruby-constant">SIF_MsgId</span>(<span class="ruby-ivar">@header</span>.<span class="ruby-identifier">msg_id</span>)
+39:           <span class="ruby-identifier">head</span>.<span class="ruby-constant">SIF_Timestamp</span>(<span class="ruby-ivar">@header</span>.<span class="ruby-identifier">timestamp</span>)
+40:           <span class="ruby-identifier">head</span>.<span class="ruby-constant">SIF_SourceId</span>(<span class="ruby-ivar">@header</span>.<span class="ruby-identifier">source_id</span>)
+41:         }
+42:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000023" class="method-detail">
+        <a name="M000023"></a>
+        <div class="method-heading">
+          <a href="#M000023" class="method-signature">
+          <span class="method-name">read</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns the <a href="Message.html#M000018">content</a> of the message
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000023-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000023-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/messages/message.rb, line 45</span>
+45:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">read</span>
+46:         <span class="ruby-comment cmt"># this construct prevents the xml from being built</span>
+47:         <span class="ruby-comment cmt"># over and over again for every read made to this</span>
+48:         <span class="ruby-comment cmt"># message.</span>
+49:         <span class="ruby-ivar">@xml</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">content</span>
+50:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000019" class="method-detail">
+        <a name="M000019"></a>
+        <div class="method-heading">
+          <a href="#M000019" class="method-signature">
+          <span class="method-name">source_id</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Alias method to the <a href="Message/Header.html">Header</a> SourceId
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000019-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000019-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/messages/message.rb, line 28</span>
+28:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">source_id</span>() <span class="ruby-identifier">header</span>.<span class="ruby-identifier">source_id</span>; <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000024" class="method-detail">
+        <a name="M000024"></a>
+        <div class="method-heading">
+          <span class="method-name">to_str</span><span class="method-args">()</span>
+        </div>
+        <div class="method-description">
+          <p>
+Alias for <a href="Message.html#M000023">read</a>
+</p>
+        </div>
+      </div>
+    </div>
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>