Google Git
Sign in
apache / thrift-website / refs/heads/asf-site / . / output / tutorial / rb.html
blob: 3b547b454ffbfc187a34edad1eb3be9a884ec062 [file] [log] [blame]
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
<meta content="en-us" http-equiv="Content-Language" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link href="/static/images/favicon.ico" rel="shortcut icon" />
<link href="/static/css/style.css" rel="stylesheet" type="text/css" />
<link href="/static/css/codehilite.css" rel="stylesheet" type="text/css" />
<link href="/static/css/bootstrap.css" media="screen, projection" rel="stylesheet" type="text/css" />
<link href="/static/css/thrift.css" media="screen, projection" rel="stylesheet" type="text/css" />
<script src="/static/js/jquery.min.js"></script>
<script src="/static/js/bootstrap-dropdown.js"></script>
<script src="/static/js/bootstrap-tab.js"></script>
<script src="/static/js/thrift.js"></script>
<title>Apache Thrift - Ruby</title>
</head>
<body>
<div class="navbar">
<div class="navbar-inner">
<div class="container">
<a class="brand" href="/">Apache Thrift &trade;</a>
<div class="nav-collapse">
<ul class="nav pull-right">
<li><a href="/download">Download</a></li>
<li><a href="/docs">Documentation</a></li>
<li><a href="/developers">Developers</a></li>
<li><a href="/lib">Libraries</a></li>
<li><a href="/tutorial">Tutorial</a></li>
<li><a href="/test">Test Suite</a></li>
<li><a href="/about">About</a></li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Apache <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="http://www.apache.org/" target="_blank">Apache Home</a></li>
<li><a href="http://www.apache.org/licenses/" target="_blank">Apache License v2.0</a></li>
<li><a href="http://www.apache.org/foundation/sponsorship.html" target="_blank">Donate</a></li>
<li><a href="http://www.apache.org/foundation/thanks.html" target="_blank">Thanks</a></li>
<li><a href="http://www.apache.org/security/" target="_blank">Security</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<h2>Ruby Tutorial</h2>
<h3>Introduction</h3>
<p>
All Apache Thrift tutorials require that you have:
<ol>
<li>The Apache Thrift Compiler and Libraries, see <a href="/download">Download</a> and <a href="/docs/BuildingFromSource">Building from Source</a> for more details.</li>
<li>Generated the <a href="https://github.com/apache/thrift/blob/master/tutorial/tutorial.thrift">tutorial.thrift</a> and <a href="https://github.com/apache/thrift/blob/master/tutorial/shared.thrift">shared.thrift</a> files:<br>
<pre><code>thrift -r --gen rb tutorial.thrift</code></pre>
</li>
<li>Followed all prerequisites listed below.</li>
</ol>
<h3 id="prerequisites">Prerequisites</h3>
<h3 id="client">Client</h3>
<div class="highlight"><pre class="codehilite"><code><span class="vg">$:</span><span class="p">.</span><span class="nf">push</span><span class="p">(</span><span class="s1">'gen-rb'</span><span class="p">)</span>
<span class="vg">$:</span><span class="p">.</span><span class="nf">unshift</span> <span class="s1">'../../lib/rb/lib'</span>
<span class="nb">require</span> <span class="s1">'thrift'</span>
<span class="nb">require</span> <span class="s1">'calculator'</span>
<span class="k">begin</span>
<span class="n">port</span> <span class="o">=</span> <span class="no">ARGV</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">||</span> <span class="mi">9090</span>
<span class="n">transport</span> <span class="o">=</span> <span class="no">Thrift</span><span class="o">::</span><span class="no">BufferedTransport</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="no">Thrift</span><span class="o">::</span><span class="no">Socket</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="s1">'localhost'</span><span class="p">,</span> <span class="n">port</span><span class="p">))</span>
<span class="n">protocol</span> <span class="o">=</span> <span class="no">Thrift</span><span class="o">::</span><span class="no">BinaryProtocol</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="n">transport</span><span class="p">)</span>
<span class="n">client</span> <span class="o">=</span> <span class="no">Calculator</span><span class="o">::</span><span class="no">Client</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="n">protocol</span><span class="p">)</span>
<span class="n">transport</span><span class="p">.</span><span class="nf">open</span><span class="p">()</span>
<span class="n">client</span><span class="p">.</span><span class="nf">ping</span><span class="p">()</span>
<span class="nb">print</span> <span class="s2">"ping()</span><span class="se">\n</span><span class="s2">"</span>
<span class="n">sum</span> <span class="o">=</span> <span class="n">client</span><span class="p">.</span><span class="nf">add</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">1</span><span class="p">)</span>
<span class="nb">print</span> <span class="s2">"1+1="</span><span class="p">,</span> <span class="n">sum</span><span class="p">,</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span>
<span class="n">sum</span> <span class="o">=</span> <span class="n">client</span><span class="p">.</span><span class="nf">add</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">4</span><span class="p">)</span>
<span class="nb">print</span> <span class="s2">"1+4="</span><span class="p">,</span> <span class="n">sum</span><span class="p">,</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span>
<span class="n">work</span> <span class="o">=</span> <span class="no">Work</span><span class="p">.</span><span class="nf">new</span><span class="p">()</span>
<span class="n">work</span><span class="p">.</span><span class="nf">op</span> <span class="o">=</span> <span class="no">Operation</span><span class="o">::</span><span class="no">SUBTRACT</span>
<span class="n">work</span><span class="p">.</span><span class="nf">num1</span> <span class="o">=</span> <span class="mi">15</span>
<span class="n">work</span><span class="p">.</span><span class="nf">num2</span> <span class="o">=</span> <span class="mi">10</span>
<span class="n">diff</span> <span class="o">=</span> <span class="n">client</span><span class="p">.</span><span class="nf">calculate</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="n">work</span><span class="p">)</span>
<span class="nb">print</span> <span class="s2">"15-10="</span><span class="p">,</span> <span class="n">diff</span><span class="p">,</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span>
<span class="n">log</span> <span class="o">=</span> <span class="n">client</span><span class="p">.</span><span class="nf">getStruct</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="nb">print</span> <span class="s2">"Log: "</span><span class="p">,</span> <span class="n">log</span><span class="p">.</span><span class="nf">value</span><span class="p">,</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span>
<span class="k">begin</span>
<span class="n">work</span><span class="p">.</span><span class="nf">op</span> <span class="o">=</span> <span class="no">Operation</span><span class="o">::</span><span class="no">DIVIDE</span>
<span class="n">work</span><span class="p">.</span><span class="nf">num1</span> <span class="o">=</span> <span class="mi">1</span>
<span class="n">work</span><span class="p">.</span><span class="nf">num2</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">quot</span> <span class="o">=</span> <span class="n">client</span><span class="p">.</span><span class="nf">calculate</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="n">work</span><span class="p">)</span>
<span class="nb">puts</span> <span class="s2">"Whoa, we can divide by 0 now?"</span>
<span class="k">rescue</span> <span class="no">InvalidOperation</span> <span class="o">=&gt;</span> <span class="n">io</span>
<span class="nb">print</span> <span class="s2">"InvalidOperation: "</span><span class="p">,</span> <span class="n">io</span><span class="p">.</span><span class="nf">why</span><span class="p">,</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span>
<span class="k">end</span>
<span class="n">client</span><span class="p">.</span><span class="nf">zip</span><span class="p">()</span>
<span class="nb">print</span> <span class="s2">"zip</span><span class="se">\n</span><span class="s2">"</span>
<span class="n">transport</span><span class="p">.</span><span class="nf">close</span><span class="p">()</span>
<span class="k">rescue</span> <span class="no">Thrift</span><span class="o">::</span><span class="no">Exception</span> <span class="o">=&gt;</span> <span class="n">tx</span>
<span class="nb">print</span> <span class="s1">'Thrift::Exception: '</span><span class="p">,</span> <span class="n">tx</span><span class="p">.</span><span class="nf">message</span><span class="p">,</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span>
<span class="k">end</span>
</code></pre></div>
<p class="snippet_footer">This snippet was generated by Apache Thrift's <strong>source tree docs</strong>:
<a href="https://gitbox.apache.org/repos/asf?p=thrift.git;a=blob;hb=HEAD;f=tutorial/rb/RubyClient.rb">tutorial/rb/RubyClient.rb</a>
</p>
<h3 id="server">Server</h3>
<div class="highlight"><pre class="codehilite"><code><span class="vg">$:</span><span class="p">.</span><span class="nf">push</span><span class="p">(</span><span class="s1">'gen-rb'</span><span class="p">)</span>
<span class="vg">$:</span><span class="p">.</span><span class="nf">unshift</span> <span class="s1">'../../lib/rb/lib'</span>
<span class="nb">require</span> <span class="s1">'thrift'</span>
<span class="nb">require</span> <span class="s1">'calculator'</span>
<span class="nb">require</span> <span class="s1">'shared_types'</span>
<span class="k">class</span> <span class="nc">CalculatorHandler</span>
<span class="k">def</span> <span class="nf">initialize</span><span class="p">()</span>
<span class="vi">@log</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">end</span>
<span class="k">def</span> <span class="nf">ping</span><span class="p">()</span>
<span class="nb">puts</span> <span class="s2">"ping()"</span>
<span class="k">end</span>
<span class="k">def</span> <span class="nf">add</span><span class="p">(</span><span class="n">n1</span><span class="p">,</span> <span class="n">n2</span><span class="p">)</span>
<span class="nb">print</span> <span class="s2">"add("</span><span class="p">,</span> <span class="n">n1</span><span class="p">,</span> <span class="s2">","</span><span class="p">,</span> <span class="n">n2</span><span class="p">,</span> <span class="s2">")</span><span class="se">\n</span><span class="s2">"</span>
<span class="k">return</span> <span class="n">n1</span> <span class="o">+</span> <span class="n">n2</span>
<span class="k">end</span>
<span class="k">def</span> <span class="nf">calculate</span><span class="p">(</span><span class="n">logid</span><span class="p">,</span> <span class="n">work</span><span class="p">)</span>
<span class="nb">print</span> <span class="s2">"calculate("</span><span class="p">,</span> <span class="n">logid</span><span class="p">,</span> <span class="s2">", {"</span><span class="p">,</span> <span class="n">work</span><span class="p">.</span><span class="nf">op</span><span class="p">,</span> <span class="s2">","</span><span class="p">,</span> <span class="n">work</span><span class="p">.</span><span class="nf">num1</span><span class="p">,</span> <span class="s2">","</span><span class="p">,</span> <span class="n">work</span><span class="p">.</span><span class="nf">num2</span><span class="p">,</span><span class="s2">"})</span><span class="se">\n</span><span class="s2">"</span>
<span class="k">if</span> <span class="n">work</span><span class="p">.</span><span class="nf">op</span> <span class="o">==</span> <span class="no">Operation</span><span class="o">::</span><span class="no">ADD</span>
<span class="n">val</span> <span class="o">=</span> <span class="n">work</span><span class="p">.</span><span class="nf">num1</span> <span class="o">+</span> <span class="n">work</span><span class="p">.</span><span class="nf">num2</span>
<span class="k">elsif</span> <span class="n">work</span><span class="p">.</span><span class="nf">op</span> <span class="o">==</span> <span class="no">Operation</span><span class="o">::</span><span class="no">SUBTRACT</span>
<span class="n">val</span> <span class="o">=</span> <span class="n">work</span><span class="p">.</span><span class="nf">num1</span> <span class="o">-</span> <span class="n">work</span><span class="p">.</span><span class="nf">num2</span>
<span class="k">elsif</span> <span class="n">work</span><span class="p">.</span><span class="nf">op</span> <span class="o">==</span> <span class="no">Operation</span><span class="o">::</span><span class="no">MULTIPLY</span>
<span class="n">val</span> <span class="o">=</span> <span class="n">work</span><span class="p">.</span><span class="nf">num1</span> <span class="o">*</span> <span class="n">work</span><span class="p">.</span><span class="nf">num2</span>
<span class="k">elsif</span> <span class="n">work</span><span class="p">.</span><span class="nf">op</span> <span class="o">==</span> <span class="no">Operation</span><span class="o">::</span><span class="no">DIVIDE</span>
<span class="k">if</span> <span class="n">work</span><span class="p">.</span><span class="nf">num2</span> <span class="o">==</span> <span class="mi">0</span>
<span class="n">x</span> <span class="o">=</span> <span class="no">InvalidOperation</span><span class="p">.</span><span class="nf">new</span><span class="p">()</span>
<span class="n">x</span><span class="p">.</span><span class="nf">whatOp</span> <span class="o">=</span> <span class="n">work</span><span class="p">.</span><span class="nf">op</span>
<span class="n">x</span><span class="p">.</span><span class="nf">why</span> <span class="o">=</span> <span class="s2">"Cannot divide by 0"</span>
<span class="k">raise</span> <span class="n">x</span>
<span class="k">end</span>
<span class="n">val</span> <span class="o">=</span> <span class="n">work</span><span class="p">.</span><span class="nf">num1</span> <span class="o">/</span> <span class="n">work</span><span class="p">.</span><span class="nf">num2</span>
<span class="k">else</span>
<span class="n">x</span> <span class="o">=</span> <span class="no">InvalidOperation</span><span class="p">.</span><span class="nf">new</span><span class="p">()</span>
<span class="n">x</span><span class="p">.</span><span class="nf">whatOp</span> <span class="o">=</span> <span class="n">work</span><span class="p">.</span><span class="nf">op</span>
<span class="n">x</span><span class="p">.</span><span class="nf">why</span> <span class="o">=</span> <span class="s2">"Invalid operation"</span>
<span class="k">raise</span> <span class="n">x</span>
<span class="k">end</span>
<span class="n">entry</span> <span class="o">=</span> <span class="no">SharedStruct</span><span class="p">.</span><span class="nf">new</span><span class="p">()</span>
<span class="n">entry</span><span class="p">.</span><span class="nf">key</span> <span class="o">=</span> <span class="n">logid</span>
<span class="n">entry</span><span class="p">.</span><span class="nf">value</span> <span class="o">=</span> <span class="s2">"</span><span class="si">#{</span><span class="n">val</span><span class="si">}</span><span class="s2">"</span>
<span class="vi">@log</span><span class="p">[</span><span class="n">logid</span><span class="p">]</span> <span class="o">=</span> <span class="n">entry</span>
<span class="k">return</span> <span class="n">val</span>
<span class="k">end</span>
<span class="k">def</span> <span class="nf">getStruct</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
<span class="nb">print</span> <span class="s2">"getStruct("</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="s2">")</span><span class="se">\n</span><span class="s2">"</span>
<span class="k">return</span> <span class="vi">@log</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
<span class="k">end</span>
<span class="k">def</span> <span class="nf">zip</span><span class="p">()</span>
<span class="nb">print</span> <span class="s2">"zip</span><span class="se">\n</span><span class="s2">"</span>
<span class="k">end</span>
<span class="k">end</span>
<span class="n">handler</span> <span class="o">=</span> <span class="no">CalculatorHandler</span><span class="p">.</span><span class="nf">new</span><span class="p">()</span>
<span class="n">processor</span> <span class="o">=</span> <span class="no">Calculator</span><span class="o">::</span><span class="no">Processor</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="n">handler</span><span class="p">)</span>
<span class="n">transport</span> <span class="o">=</span> <span class="no">Thrift</span><span class="o">::</span><span class="no">ServerSocket</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="mi">9090</span><span class="p">)</span>
<span class="n">transportFactory</span> <span class="o">=</span> <span class="no">Thrift</span><span class="o">::</span><span class="no">BufferedTransportFactory</span><span class="p">.</span><span class="nf">new</span><span class="p">()</span>
<span class="n">server</span> <span class="o">=</span> <span class="no">Thrift</span><span class="o">::</span><span class="no">SimpleServer</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="n">processor</span><span class="p">,</span> <span class="n">transport</span><span class="p">,</span> <span class="n">transportFactory</span><span class="p">)</span>
<span class="nb">puts</span> <span class="s2">"Starting the server..."</span>
<span class="n">server</span><span class="p">.</span><span class="nf">serve</span><span class="p">()</span>
<span class="nb">puts</span> <span class="s2">"done."</span>
</code></pre></div>
<p class="snippet_footer">This snippet was generated by Apache Thrift's <strong>source tree docs</strong>:
<a href="https://gitbox.apache.org/repos/asf?p=thrift.git;a=blob;hb=HEAD;f=tutorial/rb/RubyServer.rb">tutorial/rb/RubyServer.rb</a>
</p>
<h2 id="additional-information">Additional Information</h2>
</div>
<div class="container">
<hr>
<footer class="footer">
<div class="row">
<div class="span3">
<h3>Links</h3>
<ul class="unstyled">
<li><a href="/download">Download</a></li>
<li><a href="/developers">Developers</a></li>
<li><a href="/tutorial">Tutorials</a></li>
</ul>
<ul class="unstyled">
<li><a href="/sitemap">Sitemap</a></li>
</ul>
</div>
<div class="span3">
<h3>Get Involved</h3>
<ul class="unstyled">
<li><a href="/mailing">Mailing Lists</a></li>
<li><a href="http://issues.apache.org/jira/browse/THRIFT">Issue Tracking</a></li>
<li><a href="/docs/HowToContribute">How To Contribute</a></li>
</ul>
</div>
<div class="span6">
<a href="http://www.apache.org/"><img src="/static/images/feather.svg" onerror="this.src='/static/images/feather.png';this.onerror=null;" /></a>
Copyright &copy; 2024 <a href="http://www.apache.org/">Apache Software Foundation</a>.
Licensed under the <a href="http://www.apache.org/licenses/">Apache License v2.0</a>.
Apache, Apache Thrift, and the Apache feather logo are trademarks of The Apache Software Foundation.
</div>
</div>
</footer>
</div>
</body>
</html>