ServiceModel.Grpc.DesignTime 1.8.3

dotnet add package ServiceModel.Grpc.DesignTime --version 1.8.3
NuGet\Install-Package ServiceModel.Grpc.DesignTime -Version 1.8.3
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="ServiceModel.Grpc.DesignTime" Version="1.8.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ServiceModel.Grpc.DesignTime --version 1.8.3
#r "nuget: ServiceModel.Grpc.DesignTime, 1.8.3"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install ServiceModel.Grpc.DesignTime as a Cake Addin
#addin nuget:?package=ServiceModel.Grpc.DesignTime&version=1.8.3

// Install ServiceModel.Grpc.DesignTime as a Cake Tool
#tool nuget:?package=ServiceModel.Grpc.DesignTime&version=1.8.3

ServiceModel.Grpc.SelfHost

ServiceModel.Grpc enables applications to communicate with gRPC services using a code-first approach (no .proto files), helps to get around limitations of gRPC protocol like "only reference types", "exact one input", "no nulls", "no value-types". Provides exception handling. Helps to migrate existing WCF solution to gRPC with minimum effort.

ServiceModel.Grpc.DesignTime is package with C# code generator for client and server-side assets.

Declare a service contract

A service contract is an interface decorated with the ServiceContract attribute. Interface methods decorated with the OperationContract attribute are treated as gRPC operations.

For example, following ICalculator contract with unary Sum operation and client streaming MultiplyBy operation:

[ServiceContract]
public interface ICalculator
{
    [OperationContract]
    Task<long> Sum(long x, int y, int z, CancellationToken token = default);

    [OperationContract]
    ValueTask<(int Multiplier, IAsyncEnumerable<int> Values)> MultiplyBy(IAsyncEnumerable<int> values, int multiplier, CancellationToken token = default);
}

Configure code generator for client proxies

For source code generation create a placeholder - a static partial class, name doesn’t matter. Configure which proxies should be generated via ImportGrpcService attribute.

[ImportGrpcService(typeof(ICalculator))]
internal static partial class MyGrpcServices
{
    // generated code ...
    public static IClientFactory AddCalculatorClient(this IClientFactory clientFactory, Action<ServiceModelGrpcClientOptions> configure = null) {}
}

Instruct ClientFactory to use a proxy from generated code.

IClientFactory clientFactory = new ClientFactory();

// register generated proxy for ICalculator
clientFactory.AddCalculatorClient();

// create an instance
ICalculator calculator = clientFactory.CreateClient<ICalculator>(channel);

Configure code generator for server endpoints

Implement service.

internal sealed class Calculator : ICalculator
{
    public Task<long> Sum(long x, int y, int z, CancellationToken token)
    {
        ...
    }

    public ValueTask<(int Multiplier, IAsyncEnumerable<int> Values)> MultiplyBy(IAsyncEnumerable<int> values, int multiplier, CancellationToken token)
    {
        ...
    }
}

For source code generation create a placeholder - a static partial class, name doesn’t matter. Configure which endpoints should be generated via ExportGrpcService attribute.

Generate code with extensions for ServiceModel.Grpc.AspNetCore.

[ExportGrpcService(typeof(Calculator), GenerateAspNetExtensions = true)]
internal static partial class MyGrpcServices
{
    // generated code ...
    public static IServiceCollection AddCalculatorOptions(this IServiceCollection services, Action<ServiceModelGrpcServiceOptions<Calculator>> configure) {}

    // generated code ...
    public static GrpcServiceEndpointConventionBuilder MapCalculator(this IEndpointRouteBuilder builder) {}
}

Instruct Grpc.AspNetCore.Server to use a proxy from generated code.

var builder = WebApplication.CreateBuilder();

// optional configuration for Calculator endpoint
builder.Services.AddCalculatorOptions(options => { ... });

var app = builder.Build();

// bind generated Calculator endpoint
app.MapCalculator();

Generate code with extensions for ServiceModel.Grpc.SelfHost.

[ExportGrpcService(typeof(Calculator), GenerateSelfHostExtensions = true)]
internal static partial class MyGrpcServices
{
    // generated code ...
    public static Server.ServiceDefinitionCollection AddCalculator(this Server.ServiceDefinitionCollection services, Func<Calculator> serviceFactory, Action<ServiceModelGrpcServiceOptions> configure = default) {}

    // generated code ...
    public static Server.ServiceDefinitionCollection AddCalculator(this Server.ServiceDefinitionCollection services, Calculator service, Action<ServiceModelGrpcServiceOptions> configure = default) {}
}

Instruct Grpc.Core.Server to use a proxy from generated code.

var server = new Grpc.Core.Server();

// bind generated Calculator endpoint with configuration
server.Services.AddCalculator(
    () => new Calculator(),
    options => { ... });

// or bind generated Calculator endpoint with default configuration
server.Services.AddCalculator(() => new Calculator());
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.8.3 1,261 5/18/2024
1.8.2 542 3/2/2024
1.8.1 911 2/13/2024
1.8.0 169 1/7/2024
1.7.0 142 12/24/2023
1.6.1 262 11/25/2023
1.6.0 737 9/9/2023
1.5.2 768 6/25/2023
1.5.1 647 5/1/2023
1.5.0 386 3/7/2023
1.4.13 1,189 12/19/2022
1.4.12 406 11/19/2022
1.4.11 367 10/23/2022
1.4.10 1,625 8/14/2022
1.4.9 500 7/23/2022
1.4.8 507 5/29/2022
1.4.7 440 5/21/2022
1.4.6 482 4/3/2022
1.4.5 422 3/26/2022
1.4.4 401 3/12/2022
1.4.3 408 2/5/2022
1.4.2 15,772 1/22/2022
1.4.1 251 1/8/2022
1.4.0 2,421 11/26/2021
1.3.2 326 11/5/2021
1.3.1 422 10/10/2021
1.3.0 342 7/31/2021
1.2.1 348 6/12/2021
1.2.0 355 6/6/2021
1.1.9 307 5/8/2021
1.1.8 333 3/28/2021
1.1.7 388 1/3/2021
1.1.6 369 12/13/2020
1.1.5 370 11/21/2020
1.0.1 465 10/11/2020
1.0.0 567 9/13/2020
1.0.0-pre1 294 8/26/2020