RubyGems - redsnow - Versions diffs - 0.3.1 → 0.3.2 - Mend

redsnow 0.3.1 → 0.3.2

Files changed (583) hide show

data/doc/RedSnow/TransactionExample.html ADDED

@@ -0,0 +1,700 @@
+<!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>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: RedSnow::TransactionExample
+    &mdash; Documentation by YARD 0.8.7.4
+</title>
+  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '../';
+  framesUrl = "../frames.html#!RedSnow/TransactionExample.html";
+</script>
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="../_index.html">Index (T)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../RedSnow.html" title="RedSnow (module)">RedSnow</a></span></span>
+     &raquo;
+    <span class="title">TransactionExample</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="../method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="../file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Class: RedSnow::TransactionExample
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName"><span class='object_link'><a href="NamedBlueprintNode.html" title="RedSnow::NamedBlueprintNode (class)">NamedBlueprintNode</a></span></span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next"><span class='object_link'><a href="BlueprintNode.html" title="RedSnow::BlueprintNode (class)">BlueprintNode</a></span></li>
+            <li class="next"><span class='object_link'><a href="NamedBlueprintNode.html" title="RedSnow::NamedBlueprintNode (class)">NamedBlueprintNode</a></span></li>
+            <li class="next">RedSnow::TransactionExample</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/redsnow/blueprint.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>Transaction example Blueprint AST node</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+  <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
+  <ul class="summary">
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#description-instance_method" title="#description (instance method)">- (String) <strong>description</strong> </a>
+  </span>
+    <span class="note title not_defined_here">
+      inherited
+      from <span class='object_link'><a href="NamedBlueprintNode.html#description-instance_method" title="RedSnow::NamedBlueprintNode#description (method)">NamedBlueprintNode</a></span>
+    </span>
+    <span class="summary_desc"><div class='inline'>
+<p>description of the node.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#name-instance_method" title="#name (instance method)">- (String) <strong>name</strong> </a>
+  </span>
+    <span class="note title not_defined_here">
+      inherited
+      from <span class='object_link'><a href="NamedBlueprintNode.html#name-instance_method" title="RedSnow::NamedBlueprintNode#name (method)">NamedBlueprintNode</a></span>
+    </span>
+    <span class="summary_desc"><div class='inline'>
+<p>name of the node.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#requests-instance_method" title="#requests (instance method)">- (Array&lt;Request&gt;) <strong>requests</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>example request payloads.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#response-instance_method" title="#response (instance method)">- (Array&lt;Response&gt;) <strong>response</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>example response payloads.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#responses-instance_method" title="#responses (instance method)">- (Object) <strong>responses</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute responses.</p>
+</div></span>
+</li>
+  </ul>
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (TransactionExample) <strong>initialize</strong>(sc_transaction_example_handle) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'>
+<p>A new instance of TransactionExample.</p>
+</div></span>
+</li>
+    </ul>
+  <div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+    - (<tt><span class='object_link'><a href="" title="RedSnow::TransactionExample (class)">TransactionExample</a></span></tt>) <strong>initialize</strong>(sc_transaction_example_handle)
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns a new instance of TransactionExample</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>sc_transaction_example_handle</span>
+        <span class='type'>(<tt>FFI::Pointer</tt>)</span>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+201
+202
+203
+204
+205
+206
+207
+208
+209
+210
+211
+212
+213
+214
+215
+216
+217
+218
+219
+220
+221
+222
+223
+224
+225
+226
+227</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/redsnow/blueprint.rb', line 201</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_sc_transaction_example_handle'>sc_transaction_example_handle</span><span class='rparen'>)</span>
+  <span class='ivar'>@name</span>  <span class='op'>=</span> <span class='const'>RedSnow</span><span class='op'>::</span><span class='const'>Binding</span><span class='period'>.</span><span class='id identifier rubyid_sc_transaction_example_name'>sc_transaction_example_name</span><span class='lparen'>(</span><span class='id identifier rubyid_sc_transaction_example_handle'>sc_transaction_example_handle</span><span class='rparen'>)</span>
+  <span class='ivar'>@description</span> <span class='op'>=</span> <span class='const'>RedSnow</span><span class='op'>::</span><span class='const'>Binding</span><span class='period'>.</span><span class='id identifier rubyid_sc_transaction_example_description'>sc_transaction_example_description</span><span class='lparen'>(</span><span class='id identifier rubyid_sc_transaction_example_handle'>sc_transaction_example_handle</span><span class='rparen'>)</span>
+  <span class='comment'># BP Resource Actions Examples Requests
+</span>  <span class='ivar'>@requests</span> <span class='op'>=</span> <span class='const'>Array</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
+  <span class='id identifier rubyid_sc_payload_collection_handle_requests'>sc_payload_collection_handle_requests</span> <span class='op'>=</span> <span class='const'>RedSnow</span><span class='op'>::</span><span class='const'>Binding</span><span class='period'>.</span><span class='id identifier rubyid_sc_payload_collection_handle_requests'>sc_payload_collection_handle_requests</span><span class='lparen'>(</span><span class='id identifier rubyid_sc_transaction_example_handle'>sc_transaction_example_handle</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_sc_payload_collection_size_requests'>sc_payload_collection_size_requests</span> <span class='op'>=</span> <span class='const'>RedSnow</span><span class='op'>::</span><span class='const'>Binding</span><span class='period'>.</span><span class='id identifier rubyid_sc_payload_collection_size'>sc_payload_collection_size</span><span class='lparen'>(</span><span class='id identifier rubyid_sc_payload_collection_handle_requests'>sc_payload_collection_handle_requests</span><span class='rparen'>)</span>
+  <span class='kw'>if</span> <span class='id identifier rubyid_sc_payload_collection_size_requests'>sc_payload_collection_size_requests</span> <span class='op'>&gt;</span> <span class='int'>0</span>
+    <span class='id identifier rubyid_requests_size'>requests_size</span> <span class='op'>=</span> <span class='id identifier rubyid_sc_payload_collection_size_requests'>sc_payload_collection_size_requests</span> <span class='op'>-</span> <span class='int'>1</span>
+    <span class='kw'>for</span> <span class='id identifier rubyid_index'>index</span> <span class='kw'>in</span> <span class='int'>0</span><span class='op'>..</span><span class='id identifier rubyid_requests_size'>requests_size</span> <span class='kw'>do</span>
+      <span class='id identifier rubyid_request'>request</span> <span class='op'>=</span> <span class='const'>Payload</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>RedSnow</span><span class='op'>::</span><span class='const'>Binding</span><span class='period'>.</span><span class='id identifier rubyid_sc_payload_handle'>sc_payload_handle</span><span class='lparen'>(</span><span class='id identifier rubyid_sc_payload_collection_handle_requests'>sc_payload_collection_handle_requests</span><span class='comma'>,</span> <span class='id identifier rubyid_index'>index</span><span class='rparen'>)</span><span class='rparen'>)</span>
+      <span class='ivar'>@requests</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_request'>request</span>
+    <span class='kw'>end</span>
+  <span class='kw'>end</span>
+  <span class='comment'># BP Resource Actions Examples Responses
+</span>  <span class='ivar'>@responses</span> <span class='op'>=</span> <span class='const'>Array</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
+  <span class='id identifier rubyid_sc_payload_collection_handle_responses'>sc_payload_collection_handle_responses</span> <span class='op'>=</span> <span class='const'>RedSnow</span><span class='op'>::</span><span class='const'>Binding</span><span class='period'>.</span><span class='id identifier rubyid_sc_payload_collection_handle_responses'>sc_payload_collection_handle_responses</span><span class='lparen'>(</span><span class='id identifier rubyid_sc_transaction_example_handle'>sc_transaction_example_handle</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_sc_payload_collection_size_responses'>sc_payload_collection_size_responses</span> <span class='op'>=</span> <span class='const'>RedSnow</span><span class='op'>::</span><span class='const'>Binding</span><span class='period'>.</span><span class='id identifier rubyid_sc_payload_collection_size'>sc_payload_collection_size</span><span class='lparen'>(</span><span class='id identifier rubyid_sc_payload_collection_handle_responses'>sc_payload_collection_handle_responses</span><span class='rparen'>)</span>
+  <span class='kw'>if</span> <span class='id identifier rubyid_sc_payload_collection_size_responses'>sc_payload_collection_size_responses</span> <span class='op'>&gt;</span> <span class='int'>0</span>
+    <span class='id identifier rubyid_responses_size'>responses_size</span> <span class='op'>=</span> <span class='id identifier rubyid_sc_payload_collection_size_responses'>sc_payload_collection_size_responses</span> <span class='op'>-</span> <span class='int'>1</span>
+    <span class='kw'>for</span> <span class='id identifier rubyid_index'>index</span> <span class='kw'>in</span> <span class='int'>0</span><span class='op'>..</span><span class='id identifier rubyid_responses_size'>responses_size</span> <span class='kw'>do</span>
+      <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>Payload</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>RedSnow</span><span class='op'>::</span><span class='const'>Binding</span><span class='period'>.</span><span class='id identifier rubyid_sc_payload_handle'>sc_payload_handle</span><span class='lparen'>(</span><span class='id identifier rubyid_sc_payload_collection_handle_responses'>sc_payload_collection_handle_responses</span><span class='comma'>,</span> <span class='id identifier rubyid_index'>index</span><span class='rparen'>)</span><span class='rparen'>)</span>
+      <span class='ivar'>@responses</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_response'>response</span>
+    <span class='kw'>end</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+</div>
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+      <span id="description=-instance_method"></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="description-instance_method">
+    - (<tt>String</tt>) <strong>description</strong>
+    <span class="not_defined_here">
+      Originally defined in class
+        <span class='object_link'><a href="NamedBlueprintNode.html#description-instance_method" title="RedSnow::NamedBlueprintNode#description (method)">NamedBlueprintNode</a></span>
+    </span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>description of the node</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>the current value of description</p>
+</div>
+    </li>
+</ul>
+</div>
+</div>
+      <span id="name=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="name-instance_method">
+    - (<tt>String</tt>) <strong>name</strong>
+    <span class="not_defined_here">
+      Originally defined in class
+        <span class='object_link'><a href="NamedBlueprintNode.html#name-instance_method" title="RedSnow::NamedBlueprintNode#name (method)">NamedBlueprintNode</a></span>
+    </span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>name of the node</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>the current value of name</p>
+</div>
+    </li>
+</ul>
+</div>
+</div>
+      <span id="requests=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="requests-instance_method">
+    - (<tt>Array&lt;Request&gt;</tt>) <strong>requests</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>example request payloads</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Array&lt;Request&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>the current value of requests</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+196
+197
+198</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/redsnow/blueprint.rb', line 196</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_requests'>requests</span>
+  <span class='ivar'>@requests</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="response=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="response-instance_method">
+    - (<tt>Array&lt;Response&gt;</tt>) <strong>response</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>example response payloads</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Array&lt;Response&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>the current value of response</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+196
+197
+198</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/redsnow/blueprint.rb', line 196</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_response'>response</span>
+  <span class='ivar'>@response</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="responses=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="responses-instance_method">
+    - (<tt><span class='object_link'><a href="Object.html" title="RedSnow::Object (class)">Object</a></span></tt>) <strong>responses</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute responses</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+199
+200
+201</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/redsnow/blueprint.rb', line 199</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_responses'>responses</span>
+  <span class='ivar'>@responses</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Wed Jul 23 10:49:33 2014 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.4 (ruby-2.1.1).
+</div>
+  </body>
+</html>