valitydev/thrift
14
0
Fork 0
mirror of https://github.com/valitydev/thrift.git synced 2024-11-07 10:48:51 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
d9019fc5a4
thrift/lib/netstd/README.md
Jens Geyer aa0c8b35d8 THRIFT-4723 Consolidate C#/netcore into new netstd language target 
Client: netstd
Patch: Jens Geyer

This closes #1710
2019-01-28 23:12:28 +01:00

3.3 KiB
Raw Blame History

Apache Thrift netstd

Thrift client library for Microsoft .NET Standard

Build the library

How to build on Windows

  • Get Thrift IDL compiler executable, add to some folder and add path to this folder into PATH variable
  • Open the Thrift.sln project with Visual Studio and build. or
  • Build with scripts

How to build on Unix/Linux

  • Ensure you have .NET SDK >= 2.0 installed, or use the Ubuntu docker image
  • Follow common automake build practice: ./ bootstrap && ./ configure && make

Known issues

  • In trace logging mode you can see some not important internal exceptions

Migration to netstd

... from netcore

If you are migrating your code from netcore library, you will have to:

  • Switch to thrift -gen netstd
  • the following compiler flags are no longer needed or supported: hashcode is now standard, while nullable is no longer supported.
  • the Thrift.Transport and Thrift.Protocol namespaces now use the singular form
  • add using Thrift.Processor; in the server code where appropriate
  • rename all T*ClientTransport to T*Transport
  • rename all TBaseServer occurrences in your code to TServer
  • the SingletonTProcessorFactory is now called TSingletonProcessorFactory
  • and the AsyncBaseServer is now the TSimpleAsyncServer

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.

... from csharp

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.

  1. Client and server applications must use at least framework 4.6.1, any version below will not work.
  2. Switch to thrift -gen netstd. The following compiler flags are no longer needed or supported: hashcode and async are now standard, while nullable is no longer supported.
  3. Familiarize yourself with the async/await model, if you have not already done so. As netstd does not support ISync anymore, async is mandatory. The synchronous model is simply no longer available (that's also the reason why we don't need the async flag anymore).
  4. Consider proper use of cancellationToken parameters. They are optional but may be quite helpful.
  5. As you probably already guessed, there are a few names that have been changed:
  • add using Thrift.Processor; in the server code where appropriate
  • the TServerSocket is now called TServerSocketTransport
  • change IProtocolFactory into ITProtocolFactory
  • if you are looking for TSimpleServer, try TSimpleAsyncServer instead
  • similarly, the TThreadPoolServer is now a TThreadPoolAsyncServer
  • the server's Serve() method does now ServeAsync()
  • In case you are using Thrift server event handlers: the SetEventHandler method now starts with an uppercase letter
  • and you will also have to revise the method names of all TServerEventHandler descendants you have in your code