blob: 0adc6c3f36269f1ebc2ff529e82cdc7094283663 [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 - D</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>D 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 d 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">module</span> <span class="n">client</span><span class="p">;</span>
<span class="n">import</span> <span class="n">std</span><span class="p">.</span><span class="n">stdio</span><span class="p">;</span>
<span class="n">import</span> <span class="n">thrift</span><span class="p">.</span><span class="n">base</span><span class="p">;</span>
<span class="n">import</span> <span class="n">thrift</span><span class="p">.</span><span class="n">codegen</span><span class="p">.</span><span class="n">client</span><span class="p">;</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="p">;</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">buffered</span><span class="p">;</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">socket</span><span class="p">;</span>
<span class="n">import</span> <span class="n">tutorial</span><span class="p">.</span><span class="n">Calculator</span><span class="p">;</span>
<span class="n">import</span> <span class="n">tutorial</span><span class="p">.</span><span class="n">tutorial_types</span><span class="p">;</span>
<span class="kt">void</span> <span class="nf">main</span><span class="p">()</span> <span class="p">{</span>
<span class="k">auto</span> <span class="n">socket</span> <span class="o">=</span> <span class="k">new</span> <span class="n">TSocket</span><span class="p">(</span><span class="s">"localhost"</span><span class="p">,</span> <span class="mi">9090</span><span class="p">);</span>
<span class="k">auto</span> <span class="n">transport</span> <span class="o">=</span> <span class="k">new</span> <span class="n">TBufferedTransport</span><span class="p">(</span><span class="n">socket</span><span class="p">);</span>
<span class="k">auto</span> <span class="n">protocol</span> <span class="o">=</span> <span class="n">tBinaryProtocol</span><span class="p">(</span><span class="n">transport</span><span class="p">);</span>
<span class="k">auto</span> <span class="n">client</span> <span class="o">=</span> <span class="n">tClient</span><span class="o">!</span><span class="n">Calculator</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="n">open</span><span class="p">();</span>
<span class="n">client</span><span class="p">.</span><span class="n">ping</span><span class="p">();</span>
<span class="n">writeln</span><span class="p">(</span><span class="s">"ping()"</span><span class="p">);</span>
<span class="kt">int</span> <span class="n">sum</span> <span class="o">=</span> <span class="n">client</span><span class="p">.</span><span class="n">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="n">writefln</span><span class="p">(</span><span class="s">"1 + 1 = %s"</span><span class="p">,</span> <span class="n">sum</span><span class="p">);</span>
<span class="k">auto</span> <span class="n">work</span> <span class="o">=</span> <span class="n">Work</span><span class="p">();</span>
<span class="n">work</span><span class="p">.</span><span class="n">op</span> <span class="o">=</span> <span class="n">Operation</span><span class="p">.</span><span class="n">DIVIDE</span><span class="p">;</span>
<span class="n">work</span><span class="p">.</span><span class="n">num1</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span>
<span class="n">work</span><span class="p">.</span><span class="n">num2</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
<span class="k">try</span> <span class="p">{</span>
<span class="kt">int</span> <span class="n">quotient</span> <span class="o">=</span> <span class="n">client</span><span class="p">.</span><span class="n">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="n">writeln</span><span class="p">(</span><span class="s">"Whoa we can divide by 0"</span><span class="p">);</span>
<span class="p">}</span> <span class="k">catch</span> <span class="p">(</span><span class="n">InvalidOperation</span> <span class="n">io</span><span class="p">)</span> <span class="p">{</span>
<span class="n">writeln</span><span class="p">(</span><span class="s">"Invalid operation: "</span> <span class="o">~</span> <span class="n">io</span><span class="p">.</span><span class="n">why</span><span class="p">);</span>
<span class="p">}</span>
<span class="n">work</span><span class="p">.</span><span class="n">op</span> <span class="o">=</span> <span class="n">Operation</span><span class="p">.</span><span class="n">SUBTRACT</span><span class="p">;</span>
<span class="n">work</span><span class="p">.</span><span class="n">num1</span> <span class="o">=</span> <span class="mi">15</span><span class="p">;</span>
<span class="n">work</span><span class="p">.</span><span class="n">num2</span> <span class="o">=</span> <span class="mi">10</span><span class="p">;</span>
<span class="kt">int</span> <span class="n">diff</span> <span class="o">=</span> <span class="n">client</span><span class="p">.</span><span class="n">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="n">writefln</span><span class="p">(</span><span class="s">"15 - 10 = %s"</span><span class="p">,</span> <span class="n">diff</span><span class="p">);</span>
<span class="k">auto</span> <span class="n">log</span> <span class="o">=</span> <span class="n">client</span><span class="p">.</span><span class="n">getStruct</span><span class="p">(</span><span class="mi">1</span><span class="p">);</span>
<span class="n">writefln</span><span class="p">(</span><span class="s">"Check log: %s"</span><span class="p">,</span> <span class="n">log</span><span class="p">.</span><span class="n">value</span><span class="p">);</span>
<span class="p">}</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/d/client.d">tutorial/d/client.d</a>
</p>
<h3 id="server">Server</h3>
<div class="highlight"><pre class="codehilite"><code><span class="n">module</span> <span class="n">server</span><span class="p">;</span>
<span class="n">import</span> <span class="n">std</span><span class="p">.</span><span class="n">conv</span> <span class="o">:</span> <span class="n">to</span><span class="p">;</span>
<span class="n">import</span> <span class="n">std</span><span class="p">.</span><span class="n">stdio</span><span class="p">;</span>
<span class="n">import</span> <span class="n">thrift</span><span class="p">.</span><span class="n">codegen</span><span class="p">.</span><span class="n">processor</span><span class="p">;</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="p">;</span>
<span class="n">import</span> <span class="n">thrift</span><span class="p">.</span><span class="n">server</span><span class="p">.</span><span class="n">simple</span><span class="p">;</span>
<span class="n">import</span> <span class="n">thrift</span><span class="p">.</span><span class="n">server</span><span class="p">.</span><span class="n">transport</span><span class="p">.</span><span class="n">socket</span><span class="p">;</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">buffered</span><span class="p">;</span>
<span class="n">import</span> <span class="n">share</span><span class="p">.</span><span class="n">SharedService</span><span class="p">;</span>
<span class="n">import</span> <span class="n">share</span><span class="p">.</span><span class="n">shared_types</span><span class="p">;</span>
<span class="n">import</span> <span class="n">tutorial</span><span class="p">.</span><span class="n">Calculator</span><span class="p">;</span>
<span class="n">import</span> <span class="n">tutorial</span><span class="p">.</span><span class="n">tutorial_types</span><span class="p">;</span>
<span class="cm">/**
* The actual implementation of the Calculator interface that is called by
* the server to answer the requests.
*/</span>
<span class="k">class</span> <span class="nc">CalculatorHandler</span> <span class="o">:</span> <span class="n">Calculator</span> <span class="p">{</span>
<span class="kt">void</span> <span class="n">ping</span><span class="p">()</span> <span class="p">{</span>
<span class="n">writeln</span><span class="p">(</span><span class="s">"ping()"</span><span class="p">);</span>
<span class="p">}</span>
<span class="kt">int</span> <span class="n">add</span><span class="p">(</span><span class="kt">int</span> <span class="n">n1</span><span class="p">,</span> <span class="kt">int</span> <span class="n">n2</span><span class="p">)</span> <span class="p">{</span>
<span class="n">writefln</span><span class="p">(</span><span class="s">"add(%s,%s)"</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="k">return</span> <span class="n">n1</span> <span class="o">+</span> <span class="n">n2</span><span class="p">;</span>
<span class="p">}</span>
<span class="kt">int</span> <span class="n">calculate</span><span class="p">(</span><span class="kt">int</span> <span class="n">logid</span><span class="p">,</span> <span class="n">ref</span> <span class="k">const</span><span class="p">(</span><span class="n">Work</span><span class="p">)</span> <span class="n">work</span><span class="p">)</span> <span class="p">{</span>
<span class="n">writefln</span><span class="p">(</span><span class="s">"calculate(%s, {%s, %s, %s})"</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="n">op</span><span class="p">,</span> <span class="n">work</span><span class="p">.</span><span class="n">num1</span><span class="p">,</span> <span class="n">work</span><span class="p">.</span><span class="n">num2</span><span class="p">);</span>
<span class="kt">int</span> <span class="n">val</span><span class="p">;</span>
<span class="k">switch</span> <span class="p">(</span><span class="n">work</span><span class="p">.</span><span class="n">op</span><span class="p">)</span> <span class="p">{</span>
<span class="k">case</span> <span class="n">Operation</span><span class="p">.</span><span class="n">ADD</span><span class="p">:</span>
<span class="n">val</span> <span class="o">=</span> <span class="n">work</span><span class="p">.</span><span class="n">num1</span> <span class="o">+</span> <span class="n">work</span><span class="p">.</span><span class="n">num2</span><span class="p">;</span>
<span class="k">break</span><span class="p">;</span>
<span class="k">case</span> <span class="n">Operation</span><span class="p">.</span><span class="n">SUBTRACT</span><span class="p">:</span>
<span class="n">val</span> <span class="o">=</span> <span class="n">work</span><span class="p">.</span><span class="n">num1</span> <span class="o">-</span> <span class="n">work</span><span class="p">.</span><span class="n">num2</span><span class="p">;</span>
<span class="k">break</span><span class="p">;</span>
<span class="k">case</span> <span class="n">Operation</span><span class="p">.</span><span class="n">MULTIPLY</span><span class="p">:</span>
<span class="n">val</span> <span class="o">=</span> <span class="n">work</span><span class="p">.</span><span class="n">num1</span> <span class="o">*</span> <span class="n">work</span><span class="p">.</span><span class="n">num2</span><span class="p">;</span>
<span class="k">break</span><span class="p">;</span>
<span class="k">case</span> <span class="n">Operation</span><span class="p">.</span><span class="n">DIVIDE</span><span class="p">:</span>
<span class="k">if</span> <span class="p">(</span><span class="n">work</span><span class="p">.</span><span class="n">num2</span> <span class="o">==</span> <span class="mi">0</span><span class="p">)</span> <span class="p">{</span>
<span class="k">auto</span> <span class="n">io</span> <span class="o">=</span> <span class="k">new</span> <span class="n">InvalidOperation</span><span class="p">();</span>
<span class="n">io</span><span class="p">.</span><span class="n">whatOp</span> <span class="o">=</span> <span class="n">work</span><span class="p">.</span><span class="n">op</span><span class="p">;</span>
<span class="n">io</span><span class="p">.</span><span class="n">why</span> <span class="o">=</span> <span class="s">"Cannot divide by 0"</span><span class="p">;</span>
<span class="k">throw</span> <span class="n">io</span><span class="p">;</span>
<span class="p">}</span>
<span class="n">val</span> <span class="o">=</span> <span class="n">work</span><span class="p">.</span><span class="n">num1</span> <span class="o">/</span> <span class="n">work</span><span class="p">.</span><span class="n">num2</span><span class="p">;</span>
<span class="k">break</span><span class="p">;</span>
<span class="nl">default:</span>
<span class="k">auto</span> <span class="n">io</span> <span class="o">=</span> <span class="k">new</span> <span class="n">InvalidOperation</span><span class="p">();</span>
<span class="n">io</span><span class="p">.</span><span class="n">whatOp</span> <span class="o">=</span> <span class="n">work</span><span class="p">.</span><span class="n">op</span><span class="p">;</span>
<span class="n">io</span><span class="p">.</span><span class="n">why</span> <span class="o">=</span> <span class="s">"Invalid Operation"</span><span class="p">;</span>
<span class="k">throw</span> <span class="n">io</span><span class="p">;</span>
<span class="p">}</span>
<span class="k">auto</span> <span class="n">ss</span> <span class="o">=</span> <span class="n">SharedStruct</span><span class="p">();</span>
<span class="n">ss</span><span class="p">.</span><span class="n">key</span> <span class="o">=</span> <span class="n">logid</span><span class="p">;</span>
<span class="n">ss</span><span class="p">.</span><span class="n">value</span> <span class="o">=</span> <span class="n">to</span><span class="o">!</span><span class="n">string</span><span class="p">(</span><span class="n">val</span><span class="p">);</span>
<span class="n">log</span><span class="p">[</span><span class="n">logid</span><span class="p">]</span> <span class="o">=</span> <span class="n">ss</span><span class="p">;</span>
<span class="k">return</span> <span class="n">val</span><span class="p">;</span>
<span class="p">}</span>
<span class="n">SharedStruct</span> <span class="n">getStruct</span><span class="p">(</span><span class="kt">int</span> <span class="n">logid</span><span class="p">)</span> <span class="p">{</span>
<span class="n">writefln</span><span class="p">(</span><span class="s">"getStruct(%s)"</span><span class="p">,</span> <span class="n">logid</span><span class="p">);</span>
<span class="k">return</span> <span class="n">log</span><span class="p">[</span><span class="n">logid</span><span class="p">];</span>
<span class="p">}</span>
<span class="kt">void</span> <span class="n">zip</span><span class="p">()</span> <span class="p">{</span>
<span class="n">writeln</span><span class="p">(</span><span class="s">"zip()"</span><span class="p">);</span>
<span class="p">}</span>
<span class="nl">protected:</span>
<span class="n">SharedStruct</span><span class="p">[</span><span class="kt">int</span><span class="p">]</span> <span class="n">log</span><span class="p">;</span>
<span class="p">}</span>
<span class="kt">void</span> <span class="nf">main</span><span class="p">()</span> <span class="p">{</span>
<span class="k">auto</span> <span class="n">protocolFactory</span> <span class="o">=</span> <span class="k">new</span> <span class="n">TBinaryProtocolFactory</span><span class="o">!</span><span class="p">();</span>
<span class="k">auto</span> <span class="n">processor</span> <span class="o">=</span> <span class="k">new</span> <span class="n">TServiceProcessor</span><span class="o">!</span><span class="n">Calculator</span><span class="p">(</span><span class="k">new</span> <span class="n">CalculatorHandler</span><span class="p">);</span>
<span class="k">auto</span> <span class="n">serverTransport</span> <span class="o">=</span> <span class="k">new</span> <span class="n">TServerSocket</span><span class="p">(</span><span class="mi">9090</span><span class="p">);</span>
<span class="k">auto</span> <span class="n">transportFactory</span> <span class="o">=</span> <span class="k">new</span> <span class="n">TBufferedTransportFactory</span><span class="p">;</span>
<span class="k">auto</span> <span class="n">server</span> <span class="o">=</span> <span class="k">new</span> <span class="n">TSimpleServer</span><span class="p">(</span>
<span class="n">processor</span><span class="p">,</span> <span class="n">serverTransport</span><span class="p">,</span> <span class="n">transportFactory</span><span class="p">,</span> <span class="n">protocolFactory</span><span class="p">);</span>
<span class="n">writeln</span><span class="p">(</span><span class="s">"Starting the server on port 9090..."</span><span class="p">);</span>
<span class="n">server</span><span class="p">.</span><span class="n">serve</span><span class="p">();</span>
<span class="n">writeln</span><span class="p">(</span><span class="s">"done."</span><span class="p">);</span>
<span class="p">}</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/d/server.d">tutorial/d/server.d</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>