VoltRpc.Communication.Pipes 2.0.1

VoltRpc

VoltRpc - Library designed for high performance RPC communication.

Features

• Its fast (See the benchmarks)
• Supports all built-in C# value types, including:
  • Bool
  • Byte
  • Char
  • Decimal
  • Double
  • Float
  • Int
  • Long
  • SByte
  • Short
  • UInt
  • ULong
  • UShort
• Supports these built-in .NET types: (More to be added)
  • String
  • DateTime
  • TimeSpan
  • Uri
• Supports arrays for any type
• Easily support custom types by implementing a TypeReadWriter<T>
• Proxy generated by using a .NET Source Generator
• Simple to use

Getting Started

Installation

VoltRpc can be installed from NuGet.

You can use the command below to install the package.

Install-Package VoltRpc

Proxy Generation

All proxy generation is handled by a .NET Source generator. You will need to install it's NuGet package.

You can use the command below to install the package.

Install-Package VoltRpc.Proxy.Generator

Example

For a more in-depth example, see the Overview or Setup.

There is also a demo project included.

Shared:

using VoltRpc.Proxy;

namespace VoltRpcExample.Shared
{
    [GenerateProxy(GeneratedName = "TestProxy")]
    public interface ITest
    {
        public void Basic();

        public string Hello();
    }
}

Host:

using System;
using System.Net;
using VoltRpc.Communication;
using VoltRpc.Communication.TCP;
using VoltRpcExample.Shared;

namespace VoltRpcExample
{
    public class Program
    {
        public static void Main()
        {
            Host host = new TCPHost(new IPEndPoint(IPAddress.Loopback, 7767));
            host.AddService<ITest>(new TestImpl());
            host.StartListening();

            Console.WriteLine("Press any key to stop...");
            Console.ReadKey();

            host.Dispose();
        }

        public class TestImpl : ITest
        {
            public void Basic()
            {
                Console.WriteLine("Hello!");
            }

            public string Hello()
            {
                return "Hello World!";
            }
        }
    }
}

Client:

using System;
using System.Net;
using VoltRpc.Communication.TCP;
using VoltRpc.Proxy.Generated;
using VoltRpcExample.Shared;

namespace VoltRpcExample.Client
{
    public class Program
    {
        public static void Main()
        {
            VoltRpc.Communication.Client client = new TCPClient(new IPEndPoint(IPAddress.Loopback, 7767));
            client.AddService<ITest>();
            client.Connect();

            ITest testProxy = new TestProxy(client);
            testProxy.Basic();
            Console.WriteLine($"Got from server: {testProxy.Hello()}");

            Console.WriteLine("Press any key to quit...");
            Console.ReadKey();

            client.Dispose();
        }
    }
}

Benchmarks

BenchmarkDotNet=v0.13.1, OS=ubuntu 21.10
Intel Core i5-10600KF CPU 4.10GHz, 1 CPU, 12 logical and 6 physical cores
.NET SDK=6.0.100
  [Host]     : .NET 6.0.0 (6.0.21.52210), X64 RyuJIT
  Job-YXCTJF : .NET 6.0.0 (6.0.21.52210), X64 RyuJIT

Jit=Default  Platform=AnyCpu  

For more info on these benchmarks see Benchmarks.

Authors

Voltstro - Initial work - Voltstro

License

This project is licensed under the MIT license – see the LICENSE.md file for details.

Credits

• Mirror
  • NetworkReader.cs used as a base for BufferedReader.cs
  • NetworkWriter.cs used as a base for BufferedWriter.cs
• Parts of BufferedStream.cs from the .NET Runtime was also used in the reader.