Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cyanfish/grpc-dotnet-namedpipes
Named pipe transport for gRPC in C#/.NET
https://github.com/cyanfish/grpc-dotnet-namedpipes
csharp dotnet grpc ipc named-pipes
Last synced: about 9 hours ago
JSON representation
Named pipe transport for gRPC in C#/.NET
- Host: GitHub
- URL: https://github.com/cyanfish/grpc-dotnet-namedpipes
- Owner: cyanfish
- License: apache-2.0
- Created: 2020-01-24T21:25:14.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-26T22:00:12.000Z (5 months ago)
- Last Synced: 2024-12-21T19:02:10.365Z (7 days ago)
- Topics: csharp, dotnet, grpc, ipc, named-pipes
- Language: C#
- Homepage:
- Size: 167 KB
- Stars: 192
- Watchers: 12
- Forks: 48
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# GrpcDotNetNamedPipes
[](https://www.nuget.org/packages/GrpcDotNetNamedPipes/)
Named pipe transport for [gRPC](https://grpc.io/) in C#/.NET.
**This is not an official Google product.**
## Supported platforms
- .NET Framework 4.6.2+ (Windows)
- .NET 6+ (Windows, macOS, Linux)
## Usage
Suppose you have a Greeter service as described in
the [gRPC on .NET Core](https://docs.microsoft.com/en-us/aspnet/core/grpc/) intro.
Server:
```
var server = new NamedPipeServer("MY_PIPE_NAME");
Greeter.BindService(server.ServiceBinder, new GreeterService());
server.Start();
```
Client:
```
var channel = new NamedPipeChannel(".", "MY_PIPE_NAME");
var client = new Greeter.GreeterClient(channel);
var response = await client.SayHelloAsync(
new HelloRequest { Name = "World" });
Console.WriteLine(response.Message);
```
## Why named pipes?
Named pipes are suitable for inter-process communication (IPC).
Since the introduction of this project, ASP.NET Core has added support for gRPC
over [Unix Domain Sockets](https://learn.microsoft.com/en-us/aspnet/core/grpc/interprocess-uds?view=aspnetcore-8.0) and
over [Named Pipes](https://learn.microsoft.com/en-us/aspnet/core/grpc/interprocess-namedpipes?view=aspnetcore-8.0). Here
is a handy matrix to help you decide what's right for you:
| | GrpcDotNetNamedPipes | ASP.NET UDS | ASP.NET Named Pipes | ASP.NET HTTP |
|----------------------------|--------------------------------|----------------------------|------------------------------------|---------------------------|
| .NET Platform | .NET Framework 4.6.2
.NET 5 | .NET 5 | .NET 8 (server)
.NET 5 (client) | .NET 5 |
| OS | Windows 7
Mac
Linux | Windows 10
Mac
Linux | Windows 7 | Windows 7
Mac
Linux |
| No firewall warnings | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: |
| No network adapter | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: |
| Access controls | :heavy_check_mark: | :x: | :heavy_check_mark: | :x: |
| Binary size (trimmed) | **\~ 300 KB** | ~ 7 MB | **\~ 7 MB** | ~ 7 MB |
| Startup time | < 25ms | < 25ms | < 25ms | ~ 250ms |
| Large message throughput | **\~ 500MB/s** | ~ 400MB/s | **\~ 100MB/s** | ~ 100MB/s |
| Streaming messages | ~ 400k/s | ~ 500k/s | ~ 500k/s | ~ 400k/s |
| Method calls | ~ 8000/s | ~ 4000/s | ~ 5000/s | ~ 2500/s |
| Compatible with gRPC-Go | :x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| Official Microsoft support | :x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
Performance numbers are based
on [tests](https://github.com/cyanfish/grpc-dotnet-namedpipes/blob/master/GrpcDotNetNamedPipes.PerfTests/GrpcPerformanceTests.cs)
running on Windows 11 with .NET 8.
## Caveats
This implementation currently uses a custom wire protocol so it won't be compatible with other gRPC named pipe
implementations.
Linux and macOS support is provided for universal compatibility but may not be as optimized as Windows.