grpc/src/csharp
Jan Tattermusch ff3da88c63 regenerate C# protos 2016-11-23 10:48:03 +01:00
..
Grpc.Auth Merge remote-tracking branch 'upstream/v1.0.x' into HEAD 2016-11-22 11:15:53 +01:00
Grpc.Core Merge remote-tracking branch 'upstream/v1.0.x' into HEAD 2016-11-22 11:15:53 +01:00
Grpc.Core.Tests Merge remote-tracking branch 'upstream/v1.0.x' into HEAD 2016-11-22 11:15:53 +01:00
Grpc.Examples Merge remote-tracking branch 'upstream/v1.0.x' into HEAD 2016-11-22 11:15:53 +01:00
Grpc.Examples.MathClient Merge remote-tracking branch 'upstream/v1.0.x' into HEAD 2016-11-22 11:15:53 +01:00
Grpc.Examples.MathServer Merge remote-tracking branch 'upstream/v1.0.x' into HEAD 2016-11-22 11:15:53 +01:00
Grpc.Examples.Tests Merge remote-tracking branch 'upstream/v1.0.x' into HEAD 2016-11-22 11:15:53 +01:00
Grpc.HealthCheck Merge remote-tracking branch 'upstream/v1.0.x' into HEAD 2016-11-22 11:15:53 +01:00
Grpc.HealthCheck.Tests Merge remote-tracking branch 'upstream/v1.0.x' into HEAD 2016-11-22 11:15:53 +01:00
Grpc.IntegrationTesting regenerate C# protos 2016-11-23 10:48:03 +01:00
Grpc.IntegrationTesting.Client Merge remote-tracking branch 'upstream/v1.0.x' into HEAD 2016-11-22 11:15:53 +01:00
Grpc.IntegrationTesting.QpsWorker Merge remote-tracking branch 'upstream/v1.0.x' into HEAD 2016-11-22 11:15:53 +01:00
Grpc.IntegrationTesting.Server Merge remote-tracking branch 'upstream/v1.0.x' into HEAD 2016-11-22 11:15:53 +01:00
Grpc.IntegrationTesting.StressClient Merge remote-tracking branch 'upstream/v1.0.x' into HEAD 2016-11-22 11:15:53 +01:00
doc polishing public docs 2015-08-24 17:41:21 -07:00
ext allow null metadata_array in plugin notify 2016-11-09 22:52:38 +01:00
keys include assembly signing key in the repo 2016-01-21 10:45:57 -08:00
.gitignore add support for CoreCLR 2016-06-14 12:52:05 -07:00
Grpc.Dotnet.sln improve project.json files 2016-06-20 16:24:08 -07:00
Grpc.Tools.nuspec change back slashes to forward slashes in grpc.tool nuspec 2016-10-06 17:33:12 -07:00
Grpc.nuspec pick up nuget package version from cmdline param and fix nuget build 2015-07-15 10:48:30 -07:00
Grpc.sln Add C# stress test client 2016-04-21 17:44:33 -07:00
README.md Update README.md 2016-10-12 18:22:39 +02:00
Settings.StyleCop Setting up stylecop to ignore generated files and fixing style 2015-03-12 12:54:43 -07:00
build_packages.bat Going 1.0.1. 2016-10-26 21:42:29 +02:00
build_packages_dotnetcli.bat strong name sign csharp nuget builds with dotnet on windows 2016-11-01 18:40:03 -07:00
build_packages_dotnetcli.sh Going 1.0.1. 2016-10-26 21:42:29 +02:00
buildall.bat add missing copyrights to .bat files 2016-05-13 10:50:29 -07:00
generate_proto_csharp.sh Add C# stress test client 2016-04-21 17:44:33 -07:00
tests.json add appdomain unload test 2016-06-06 15:04:06 -07:00

README.md

Nuget gRPC C#

A C# implementation of gRPC.

SUPPORTED PLATFORMS

  • .NET Framework 4.5+ (Windows)
  • .NET Core on Linux, Windows and Mac OS X (starting from version 1.0.1)
  • Mono 4+ on Linux, Windows and Mac OS X

PREREQUISITES

  • Windows: .NET Framework 4.5+, Visual Studio 2013 or 2015
  • Linux: Mono 4+, MonoDevelop 5.9+ (with NuGet add-in installed)
  • Mac OS X: Xamarin Studio 5.9+

HOW TO USE

Windows, Linux, Mac OS X

  • Open Visual Studio / MonoDevelop / Xamarin Studio and start a new project/solution.

  • Add the Grpc NuGet package as a dependency (Project options -> Manage NuGet Packages).

  • To be able to generate code from Protocol Buffer (.proto) file definitions, add the Grpc.Tools NuGet package that contains Protocol Buffers compiler (protoc) and the gRPC protoc plugin.

BUILD FROM SOURCE

You only need to go through these steps if you are planning to develop gRPC C#. If you are a user of gRPC C#, go to Usage section above.

Windows

  • The grpc_csharp_ext native library needs to be built so you can build the gRPC C# solution. Open the solution vsprojects/grpc_csharp_ext.sln in Visual Studio and build it.

  • Open src\csharp\Grpc.sln (path is relative to gRPC repository root) using Visual Studio

Linux and Mac OS X

  • The grpc_csharp_ext native library needs to be built so you can build the gRPC C# solution:

    # from the gRPC repository root
    $ tools/run_tests/run_tests.py -c dbg -l csharp --build_only
    
  • Use MonoDevelop / Xamarin Studio to open the solution Grpc.sln

RUNNING TESTS

gRPC C# is using NUnit as the testing framework.

Under Visual Studio, make sure NUnit test adapter is installed (under "Extensions and Updates"). Then you should be able to run all the tests using Test Explorer.

Under Monodevelop or Xamarin Studio, make sure you installed "NUnit support" in Add-in manager. Then you should be able to run all the test from the Test View.

gRPC team uses a Python script to simplify facilitate running tests for different languages.

tools/run_tests/run_tests.py -l csharp

DOCUMENTATION

CONTENTS

  • ext: The extension library that wraps C API to be more digestible by C#.
  • Grpc.Auth: gRPC OAuth2/JWT support.
  • Grpc.Core: The main gRPC C# library.
  • Grpc.Examples: API examples for math.proto
  • Grpc.Examples.MathClient: An example client that sends requests to math server.
  • Grpc.Examples.MathServer: An example server that implements a simple math service.
  • Grpc.IntegrationTesting: Cross-language gRPC implementation testing (interop testing).

THE NATIVE DEPENDENCY

Internally, gRPC C# uses a native library written in C (gRPC C core) and invokes its functionality via P/Invoke. The fact that a native library is used should be fully transparent to the users and just installing the Grpc.Core NuGet package is the only step needed to use gRPC C# on all supported platforms.