blob: b7b3b01f44a65e03c002acf677409280489195be [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 - Haskell</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>Haskell 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 hs 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="n">import</span> <span class="n">qualified</span> <span class="n">Calculator</span>
<span class="n">import</span> <span class="n">qualified</span> <span class="n">Calculator_Client</span> <span class="n">as</span> <span class="n">Client</span>
<span class="n">import</span> <span class="n">qualified</span> <span class="n">SharedService_Client</span> <span class="n">as</span> <span class="n">SClient</span>
<span class="n">import</span> <span class="n">Tutorial_Types</span>
<span class="n">import</span> <span class="n">SharedService_Iface</span>
<span class="n">import</span> <span class="n">Shared_Types</span>
<span class="n">import</span> <span class="n">Thrift</span>
<span class="n">import</span> <span class="n">Thrift</span><span class="p">.</span><span class="n">Protocol</span><span class="p">.</span><span class="n">Binary</span>
<span class="n">import</span> <span class="n">Thrift</span><span class="p">.</span><span class="n">Transport</span>
<span class="n">import</span> <span class="n">Thrift</span><span class="p">.</span><span class="n">Transport</span><span class="p">.</span><span class="n">Handle</span>
<span class="n">import</span> <span class="n">Thrift</span><span class="p">.</span><span class="n">Server</span>
<span class="n">import</span> <span class="n">Control</span><span class="p">.</span><span class="n">Exception</span>
<span class="n">import</span> <span class="n">Data</span><span class="p">.</span><span class="n">Maybe</span>
<span class="n">import</span> <span class="n">Data</span><span class="p">.</span><span class="n">Text</span><span class="p">.</span><span class="n">Lazy</span>
<span class="n">import</span> <span class="n">Text</span><span class="p">.</span><span class="n">Printf</span>
<span class="n">import</span> <span class="n">Network</span>
<span class="n">main</span> <span class="o">=</span> <span class="k">do</span>
<span class="n">transport</span> <span class="o">&lt;-</span> <span class="n">hOpen</span> <span class="p">(</span><span class="s">"localhost"</span><span class="p">,</span> <span class="n">PortNumber</span> <span class="mi">9090</span><span class="p">)</span>
<span class="n">let</span> <span class="n">binProto</span> <span class="o">=</span> <span class="n">BinaryProtocol</span> <span class="n">transport</span>
<span class="n">let</span> <span class="n">client</span> <span class="o">=</span> <span class="p">(</span><span class="n">binProto</span><span class="p">,</span> <span class="n">binProto</span><span class="p">)</span>
<span class="n">Client</span><span class="p">.</span><span class="n">ping</span> <span class="n">client</span>
<span class="n">print</span> <span class="s">"ping()"</span>
<span class="n">sum</span> <span class="o">&lt;-</span> <span class="n">Client</span><span class="p">.</span><span class="n">add</span> <span class="n">client</span> <span class="mi">1</span> <span class="mi">1</span>
<span class="n">printf</span> <span class="s">"1+1=%d</span><span class="se">\n</span><span class="s">"</span> <span class="n">sum</span>
<span class="n">let</span> <span class="n">work</span> <span class="o">=</span> <span class="n">Work</span> <span class="p">{</span> <span class="n">work_op</span> <span class="o">=</span> <span class="n">Operation_DIVIDE</span><span class="p">,</span>
<span class="n">work_num1</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span>
<span class="n">work_num2</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
<span class="n">work_comment</span> <span class="o">=</span> <span class="n">Nothing</span>
<span class="p">}</span>
<span class="n">Control</span><span class="p">.</span><span class="n">Exception</span><span class="p">.</span><span class="k">catch</span> <span class="p">(</span><span class="n">printf</span> <span class="s">"1/0=%d</span><span class="se">\n</span><span class="s">"</span> <span class="o">=&lt;&lt;</span> <span class="n">Client</span><span class="p">.</span><span class="n">calculate</span> <span class="n">client</span> <span class="mi">1</span> <span class="n">work</span><span class="p">)</span>
<span class="p">(</span><span class="err">\</span><span class="n">e</span> <span class="o">-&gt;</span> <span class="n">printf</span> <span class="s">"InvalidOperation %s</span><span class="se">\n</span><span class="s">"</span> <span class="p">(</span><span class="n">show</span> <span class="p">(</span><span class="n">e</span> <span class="o">::</span> <span class="n">InvalidOperation</span><span class="p">)))</span>
<span class="n">let</span> <span class="n">work</span> <span class="o">=</span> <span class="n">Work</span> <span class="p">{</span> <span class="n">work_op</span> <span class="o">=</span> <span class="n">Operation_SUBTRACT</span><span class="p">,</span>
<span class="n">work_num1</span> <span class="o">=</span> <span class="mi">15</span><span class="p">,</span>
<span class="n">work_num2</span> <span class="o">=</span> <span class="mi">10</span><span class="p">,</span>
<span class="n">work_comment</span> <span class="o">=</span> <span class="n">Nothing</span>
<span class="p">}</span>
<span class="n">diff</span> <span class="o">&lt;-</span> <span class="n">Client</span><span class="p">.</span><span class="n">calculate</span> <span class="n">client</span> <span class="mi">1</span> <span class="n">work</span>
<span class="n">printf</span> <span class="s">"15-10=%d</span><span class="se">\n</span><span class="s">"</span> <span class="n">diff</span>
<span class="n">log</span> <span class="o">&lt;-</span> <span class="n">SClient</span><span class="p">.</span><span class="n">getStruct</span> <span class="n">client</span> <span class="mi">1</span>
<span class="n">printf</span> <span class="s">"Check log: %s</span><span class="se">\n</span><span class="s">"</span> <span class="err">$</span> <span class="n">unpack</span> <span class="err">$</span> <span class="n">sharedStruct_value</span> <span class="n">log</span>
<span class="o">--</span> <span class="n">Close</span><span class="o">!</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/hs/HaskellClient.hs">tutorial/hs/HaskellClient.hs</a>
</p>
<h3 id="server">Server</h3>
<div class="highlight"><pre class="codehilite"><code><span class="p">{</span><span class="o">-</span><span class="err">#</span> <span class="n">LANGUAGE</span> <span class="n">OverloadedStrings</span> <span class="err">#</span><span class="o">-</span><span class="p">}</span>
<span class="n">import</span> <span class="n">qualified</span> <span class="n">Calculator</span>
<span class="n">import</span> <span class="n">Calculator_Iface</span>
<span class="n">import</span> <span class="n">Tutorial_Types</span>
<span class="n">import</span> <span class="n">SharedService_Iface</span>
<span class="n">import</span> <span class="n">Shared_Types</span>
<span class="n">import</span> <span class="n">Thrift</span>
<span class="n">import</span> <span class="n">Thrift</span><span class="p">.</span><span class="n">Protocol</span><span class="p">.</span><span class="n">Binary</span>
<span class="n">import</span> <span class="n">Thrift</span><span class="p">.</span><span class="n">Transport</span>
<span class="n">import</span> <span class="n">Thrift</span><span class="p">.</span><span class="n">Server</span>
<span class="n">import</span> <span class="n">Data</span><span class="p">.</span><span class="n">Int</span>
<span class="n">import</span> <span class="n">Data</span><span class="p">.</span><span class="n">String</span>
<span class="n">import</span> <span class="n">Data</span><span class="p">.</span><span class="n">Maybe</span>
<span class="n">import</span> <span class="n">Text</span><span class="p">.</span><span class="n">Printf</span>
<span class="n">import</span> <span class="n">Control</span><span class="p">.</span><span class="n">Exception</span> <span class="p">(</span><span class="k">throw</span><span class="p">)</span>
<span class="n">import</span> <span class="n">Control</span><span class="p">.</span><span class="n">Concurrent</span><span class="p">.</span><span class="n">MVar</span>
<span class="n">import</span> <span class="n">qualified</span> <span class="n">Data</span><span class="p">.</span><span class="n">Map</span> <span class="n">as</span> <span class="n">M</span>
<span class="n">import</span> <span class="n">Data</span><span class="p">.</span><span class="n">Map</span> <span class="p">((</span><span class="o">!</span><span class="p">))</span>
<span class="n">import</span> <span class="n">Data</span><span class="p">.</span><span class="n">Monoid</span>
<span class="n">data</span> <span class="n">CalculatorHandler</span> <span class="o">=</span> <span class="n">CalculatorHandler</span> <span class="p">{</span><span class="n">mathLog</span> <span class="o">::</span> <span class="n">MVar</span> <span class="p">(</span><span class="n">M</span><span class="p">.</span><span class="n">Map</span> <span class="n">Int32</span> <span class="n">SharedStruct</span><span class="p">)}</span>
<span class="n">newCalculatorHandler</span> <span class="o">=</span> <span class="k">do</span>
<span class="n">log</span> <span class="o">&lt;-</span> <span class="n">newMVar</span> <span class="n">mempty</span>
<span class="k">return</span> <span class="err">$</span> <span class="n">CalculatorHandler</span> <span class="n">log</span>
<span class="n">instance</span> <span class="n">SharedService_Iface</span> <span class="n">CalculatorHandler</span> <span class="n">where</span>
<span class="n">getStruct</span> <span class="n">self</span> <span class="n">k</span> <span class="o">=</span> <span class="k">do</span>
<span class="n">myLog</span> <span class="o">&lt;-</span> <span class="n">readMVar</span> <span class="p">(</span><span class="n">mathLog</span> <span class="n">self</span><span class="p">)</span>
<span class="k">return</span> <span class="err">$</span> <span class="p">(</span><span class="n">myLog</span> <span class="o">!</span> <span class="n">k</span><span class="p">)</span>
<span class="n">instance</span> <span class="n">Calculator_Iface</span> <span class="n">CalculatorHandler</span> <span class="n">where</span>
<span class="n">ping</span> <span class="n">_</span> <span class="o">=</span>
<span class="n">print</span> <span class="s">"ping()"</span>
<span class="n">add</span> <span class="n">_</span> <span class="n">n1</span> <span class="n">n2</span> <span class="o">=</span> <span class="k">do</span>
<span class="n">printf</span> <span class="s">"add(%d,%d)</span><span class="se">\n</span><span class="s">"</span> <span class="n">n1</span> <span class="n">n2</span>
<span class="k">return</span> <span class="p">(</span><span class="n">n1</span> <span class="o">+</span> <span class="n">n2</span><span class="p">)</span>
<span class="n">calculate</span> <span class="n">self</span> <span class="n">mlogid</span> <span class="n">mwork</span> <span class="o">=</span> <span class="k">do</span>
<span class="n">printf</span> <span class="s">"calculate(%d, %s)</span><span class="se">\n</span><span class="s">"</span> <span class="n">logid</span> <span class="p">(</span><span class="n">show</span> <span class="n">work</span><span class="p">)</span>
<span class="n">let</span> <span class="n">val</span> <span class="o">=</span> <span class="k">case</span> <span class="n">op</span> <span class="n">work</span> <span class="n">of</span>
<span class="n">Operation_ADD</span> <span class="o">-&gt;</span>
<span class="n">num1</span> <span class="n">work</span> <span class="o">+</span> <span class="n">num2</span> <span class="n">work</span>
<span class="n">Operation_SUBTRACT</span> <span class="o">-&gt;</span>
<span class="n">num1</span> <span class="n">work</span> <span class="o">-</span> <span class="n">num2</span> <span class="n">work</span>
<span class="n">Operation_MULTIPLY</span> <span class="o">-&gt;</span>
<span class="n">num1</span> <span class="n">work</span> <span class="o">*</span> <span class="n">num2</span> <span class="n">work</span>
<span class="n">Operation_DIVIDE</span> <span class="o">-&gt;</span>
<span class="k">if</span> <span class="n">num2</span> <span class="n">work</span> <span class="o">==</span> <span class="mi">0</span> <span class="n">then</span>
<span class="k">throw</span> <span class="err">$</span>
<span class="n">InvalidOperation</span> <span class="err">{</span>
<span class="n">invalidOperation_whatOp</span> <span class="o">=</span> <span class="n">fromIntegral</span> <span class="err">$</span> <span class="n">fromEnum</span> <span class="err">$</span> <span class="n">op</span> <span class="n">work</span><span class="p">,</span>
<span class="n">invalidOperation_why</span> <span class="o">=</span> <span class="s">"Cannot divide by 0"</span>
<span class="err">}</span>
<span class="k">else</span>
<span class="n">num1</span> <span class="n">work</span> <span class="err">`</span><span class="n">div</span><span class="err">`</span> <span class="n">num2</span> <span class="n">work</span>
<span class="n">let</span> <span class="n">logEntry</span> <span class="o">=</span> <span class="n">SharedStruct</span> <span class="n">logid</span> <span class="p">(</span><span class="n">fromString</span> <span class="err">$</span> <span class="n">show</span> <span class="err">$</span> <span class="n">val</span><span class="p">)</span>
<span class="n">modifyMVar_</span> <span class="p">(</span><span class="n">mathLog</span> <span class="n">self</span><span class="p">)</span> <span class="err">$</span> <span class="k">return</span> <span class="p">.(</span><span class="n">M</span><span class="p">.</span><span class="n">insert</span> <span class="n">logid</span> <span class="n">logEntry</span><span class="p">)</span>
<span class="k">return</span> <span class="err">$</span><span class="o">!</span> <span class="n">val</span>
<span class="n">where</span>
<span class="o">--</span> <span class="n">stupid</span> <span class="n">dynamic</span> <span class="n">languages</span> <span class="n">f</span><span class="err">'</span><span class="n">ing</span> <span class="n">it</span> <span class="n">up</span>
<span class="n">num1</span> <span class="o">=</span> <span class="n">work_num1</span>
<span class="n">num2</span> <span class="o">=</span> <span class="n">work_num2</span>
<span class="n">op</span> <span class="o">=</span> <span class="n">work_op</span>
<span class="n">logid</span> <span class="o">=</span> <span class="n">mlogid</span>
<span class="n">work</span> <span class="o">=</span> <span class="n">mwork</span>
<span class="n">zip</span> <span class="n">_</span> <span class="o">=</span>
<span class="n">print</span> <span class="s">"zip()"</span>
<span class="n">main</span> <span class="o">=</span> <span class="k">do</span>
<span class="n">handler</span> <span class="o">&lt;-</span> <span class="n">newCalculatorHandler</span>
<span class="n">print</span> <span class="s">"Starting the server..."</span>
<span class="n">runBasicServer</span> <span class="n">handler</span> <span class="n">Calculator</span><span class="p">.</span><span class="n">process</span> <span class="mi">9090</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/hs/HaskellServer.hs">tutorial/hs/HaskellServer.hs</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; 2020 <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>