Author: buildbot
Date: Tue Jan 29 22:07:27 2019
New Revision: 1039715
Log:
Staging update by buildbot for thrift
Modified:
websites/staging/thrift/trunk/content/ (props changed)
websites/staging/thrift/trunk/content/lib/netstd.html
Propchange: websites/staging/thrift/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Jan 29 22:07:27 2019
@@ -1 +1 @@
-1852476
+1852477
Modified: websites/staging/thrift/trunk/content/lib/netstd.html
==============================================================================
--- websites/staging/thrift/trunk/content/lib/netstd.html (original)
+++ websites/staging/thrift/trunk/content/lib/netstd.html Tue Jan 29 22:07:27
2019
@@ -84,6 +84,56 @@
visibility: hidden;
}
h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink,
h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink,
dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="apache-thrift-netstd">Apache Thrift netstd<a class="headerlink"
href="#apache-thrift-netstd" title="Permanent link">¶</a></h1>
+<p>Thrift client library for Microsoft .NET Standard </p>
+<h1 id="build-the-library">Build the library<a class="headerlink"
href="#build-the-library" title="Permanent link">¶</a></h1>
+<h2 id="how-to-build-on-windows">How to build on Windows<a class="headerlink"
href="#how-to-build-on-windows" title="Permanent link">¶</a></h2>
+<ul>
+<li>Get Thrift IDL compiler executable, add to some folder and add path to
this folder into PATH variable</li>
+<li>Open the Thrift.sln project with Visual Studio and build.
+or </li>
+<li>Build with scripts</li>
+</ul>
+<h2 id="how-to-build-on-unixlinux">How to build on Unix/Linux<a
class="headerlink" href="#how-to-build-on-unixlinux" title="Permanent
link">¶</a></h2>
+<ul>
+<li>Ensure you have .NET SDK >= 2.0 installed, or use the <a
href="../../build/docker/README">Ubuntu docker image</a></li>
+<li>Follow common automake build practice: <code>./ bootstrap && ./
configure && make</code></li>
+</ul>
+<h2 id="known-issues">Known issues<a class="headerlink" href="#known-issues"
title="Permanent link">¶</a></h2>
+<ul>
+<li>In trace logging mode you can see some not important internal
exceptions</li>
+</ul>
+<h1 id="migration-to-netstd">Migration to netstd<a class="headerlink"
href="#migration-to-netstd" title="Permanent link">¶</a></h1>
+<h2 id="from-netcore">... from netcore<a class="headerlink"
href="#from-netcore" title="Permanent link">¶</a></h2>
+<p>If you are migrating your code from netcore library, you will have to:</p>
+<ul>
+<li>Switch to <code>thrift -gen netstd</code></li>
+<li>the following compiler flags are no longer needed or supported:
<code>hashcode</code> is now standard, while <code>nullable</code> is no longer
supported.</li>
+<li>the <code>Thrift.Transport</code> and <code>Thrift.Protocol</code>
namespaces now use the singular form</li>
+<li>add <code>using Thrift.Processor;</code> in the server code where
appropriate</li>
+<li>rename all <code>T*ClientTransport</code> to <code>T*Transport</code> </li>
+<li>rename all <code>TBaseServer</code> occurrences in your code to
<code>TServer</code></li>
+<li>the <code>SingletonTProcessorFactory</code> is now called
<code>TSingletonProcessorFactory</code></li>
+<li>and the <code>AsyncBaseServer</code> is now the
<code>TSimpleAsyncServer</code></li>
+</ul>
+<p>You may wonder why we changed so many names. The naming scheme has been
revised for two reasons: First, we want to get back the established, well-known
naming consistency across the Thrift libraries which the netcore library did
not fully respect. Second, by achieving that first objective, we get the
additional benefit of making migration at least a bit easier for C#
projects.</p>
+<h2 id="from-csharp">... from csharp<a class="headerlink" href="#from-csharp"
title="Permanent link">¶</a></h2>
+<p>Because of the different environment requirements, migration from C# takes
slightly more efforts. While the code changes related to Thrift itself are
moderate, you may need to upgrade certain dependencies, components or even
modules to more recent versions. </p>
+<ol>
+<li>Client and server applications must use at least framework 4.6.1, any
version below will not work. </li>
+<li>Switch to <code>thrift -gen netstd</code>. The following compiler flags
are no longer needed or supported: <code>hashcode</code> and <code>async</code>
are now standard, while <code>nullable</code> is no longer supported.</li>
+<li><a href="https://msdn.microsoft.com/en-us/magazine/jj991977">Familiarize
yourself with the <code>async/await</code> model</a>, if you have not already
done so. As netstd does not support <code>ISync</code> anymore, async is
mandatory. The synchronous model is simply no longer available (that's also the
reason why we don't need the <code>async</code> flag anymore). </li>
+<li>Consider proper use of <code>cancellationToken</code> parameters. They are
optional but may be quite helpful.</li>
+<li>As you probably already guessed, there are a few names that have been
changed:</li>
+<li>add <code>using Thrift.Processor;</code> in the server code where
appropriate</li>
+<li>the <code>TServerSocket</code> is now called
<code>TServerSocketTransport</code></li>
+<li>change <code>IProtocolFactory</code> into
<code>ITProtocolFactory</code></li>
+<li>if you are looking for <code>TSimpleServer</code>, try
<code>TSimpleAsyncServer</code> instead</li>
+<li>similarly, the <code>TThreadPoolServer</code> is now a
<code>TThreadPoolAsyncServer</code> </li>
+<li>the server's <code>Serve()</code> method does now
<code>ServeAsync()</code></li>
+<li>In case you are using Thrift server event handlers: the
<code>SetEventHandler</code> method now starts with an uppercase letter</li>
+<li>and you will also have to revise the method names of all
<code>TServerEventHandler</code> descendants you have in your code</li>
+</ol>
<p class='snippet_footer'>
This page was generated by Apache Thrift's <strong>source tree docs</strong>:
<a
href="https://gitbox.apache.org/repos/asf?p=thrift.git;a=blob;f=lib/netstd/README.md;hb=HEAD"</a>lib/netstd/README.md</a>