Skip to content
Branch: master
Find file History
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
Grpc.Auth dependency versions are imported through Directory props Mar 25, 2019
Grpc.Core.Api move CallInvoker and its prerequisites to Grpc.Core.Api Apr 10, 2019
Grpc.Core.NativeDebug
Grpc.Core.Testing dependency versions are imported through Directory props Mar 25, 2019
Grpc.Core.Tests make CallCredentials implementation agnostic Apr 5, 2019
Grpc.Core fixup ForwardedTypes.cs Apr 10, 2019
Grpc.Examples.MathClient dependency versions are imported through Directory props Mar 25, 2019
Grpc.Examples.MathServer
Grpc.Examples.Tests dependency versions are imported through Directory props Mar 25, 2019
Grpc.Examples Merge pull request #18484 from JamesNK/jamesnk/bindserviceattribute Apr 5, 2019
Grpc.HealthCheck.Tests dependency versions are imported through Directory props Mar 25, 2019
Grpc.HealthCheck Merge pull request #18484 from JamesNK/jamesnk/bindserviceattribute Apr 5, 2019
Grpc.IntegrationTesting.Client dependency versions are imported through Directory props Mar 25, 2019
Grpc.IntegrationTesting.QpsWorker
Grpc.IntegrationTesting.Server dependency versions are imported through Directory props Mar 25, 2019
Grpc.IntegrationTesting.StressClient dependency versions are imported through Directory props Mar 25, 2019
Grpc.IntegrationTesting Merge pull request #18484 from JamesNK/jamesnk/bindserviceattribute Apr 5, 2019
Grpc.Microbenchmarks
Grpc.Reflection.Tests dependency versions are imported through Directory props Mar 25, 2019
Grpc.Reflection Merge pull request #18484 from JamesNK/jamesnk/bindserviceattribute Apr 5, 2019
Grpc.Tools.Tests
Grpc.Tools use process architecture instead of OS architecture Mar 29, 2019
Grpc dependency versions are imported through Directory props Mar 25, 2019
build
doc
experimental Updated experimental README Mar 11, 2019
ext
keys include assembly signing key in the repo Jan 21, 2016
unitypackage add NativeCallbackDispatcher Mar 11, 2019
.editorconfig Infer coding style, adjust .editorconfig, reformat Tools code Oct 14, 2018
.gitignore Minor changes to control files from Tools package rework Mar 13, 2018
BUILD-INTEGRATION.md Address review comments Nov 2, 2018
Directory.Build.props introduce Directory.Build.props Mar 25, 2019
Grpc.sln add Grpc.Core.Api to the solution Jan 25, 2019
README.md Fixed dead examples link Mar 1, 2019
Settings.StyleCop Setting up stylecop to ignore generated files and fixing style Mar 12, 2015
build_packages_dotnetcli.bat Fix source stepping by upgrading sourcelink Mar 14, 2019
build_unitypackage.bat Regenerate projects Mar 29, 2019
expand_dev_version.sh makes generation of dev nuget versions work Mar 25, 2019
generate_proto_csharp.sh fix C# codegen for empty service May 31, 2018
install_dotnet_sdk.ps1 install dotnet SDK before starting Windows build Mar 11, 2019
tests.json Fix c-ares on Windows bug triggered by tracing Feb 19, 2019

README.md

Nuget gRPC C#

A C# implementation of gRPC.

SUPPORTED PLATFORMS

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

PREREQUISITES

When using gRPC C# under .NET Core you only need to install .NET Core.

In addition to that, you can also use gRPC C# with these runtimes / IDEs

  • Windows: .NET Framework 4.5+, Visual Studio 2013, 2015, 2017, Visual Studio Code
  • Linux: Mono 4+, Visual Studio Code, MonoDevelop 5.9+
  • Mac OS X: Mono 4+, Visual Studio Code, Xamarin Studio 5.9+

HOW TO USE

Windows, Linux, Mac OS X

  • Open Visual Studio / MonoDevelop / Xamarin Studio and start a new project/solution (alternatively, you can create a new project from command line with dotnet SDK)

  • 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.

Xamarin.Android and Xamarin.iOS (Experimental only)

See Experimentally supported platforms for instructions.

Unity (Experimental only)

See Experimentally supported platforms for instructions.

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.

Prerequisites for contributors

Windows, Linux or Mac OS X

  • The easiest way to build is using the run_tests.py script that will take care of building the grpc_csharp_ext native library.

    # NOTE: make sure all necessary git submodules with dependencies 
    # are available by running "git submodule update --init"
    
    # from the gRPC repository root
    $ python tools/run_tests/run_tests.py -l csharp -c dbg --build_only
    
  • Use Visual Studio 2017 (on Windows) to open the solution Grpc.sln or use Visual Studio Code with C# extension (on Linux and Mac). gRPC C# code has been migrated to dotnet SDK .csproj projects that are much simpler to maintain, but are not yet supported by Xamarin Studio or Monodevelop (the NuGet packages still support both net45 and netstandard and can be used in all IDEs).

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.

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

# from the gRPC repository root
$ python tools/run_tests/run_tests.py -l csharp -c dbg

DOCUMENTATION

PERFORMANCE

For best gRPC C# performance, use .NET Core and the Server GC mode "System.GC.Server": true for your applications.

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.

You can’t perform that action at this time.