README.en.md

EleCho.JsonRpc

Simple JSON based RPC library.

By reading the code of this project, you can learn: Dynamic proxy.

Transmission

--> {"jsonrpc":"2.0","method":"method name","signature":"method signature","params":["parameter"],"id":"ID"}
<-- {"jsonrpc":"2.0","result":"return value","id":"ID"}

Specification: JSON-RPC 2.0 Specification

Features

• Basic features
• Async methods
• Ref/Out parameters
• Batch request

Usage

This library can be used on System.IO.Stream

Define the public interface:

public interface Commands
{
    public void WriteLine(string message);
    public int Add(int a, int b);
    public int Add114514(ref int num);
}

Server implementation of the interface:

internal class CommandsImpl : Commands
{
    public int Add(int a, int b) => a + b;
    public int Add114514(ref int num) => num += 114514;
    public void WriteLine(string message) => Console.WriteLine("Server print: " + message);
}

Server listening on TCP:

int port = 11451;

TcpListener listener = new TcpListener(new IPEndPoint(IPAddress.Any, port));      // listen on specified port
listener.Start();

CommandsImpl serverCommands = new CommandsImpl();                                 // Create a common command call instance
List<RpcServer<Commands>> rpcs = new List<RpcServer<Commands>>();                 // Save all client RPC references

Console.WriteLine($"Listening {port}");

while (true)
{
    TcpClient client = await listener.AcceptTcpClientAsync();                     // Accept a client
    rpcs.Add(new RpcServer<Commands>(client.GetStream(), serverCommands));        // Create and save an RPC instance
}

The client connects and calls the remote function:

Console.Write("Addr: ");
var addr = Console.ReadLine()!;                         // User enters the address

TcpClient client = new TcpClient();
client.Connect(IPEndPoint.Parse(addr));                 // Connect to server

RpcClient<Commands> rpc =
    new RpcClient<Commands>(client.GetStream());        // Create an RPC client instance

int num = 10;
rpc.Remote.Add114514(ref num);

if (num == 114524)
    Console.WriteLine("RPC call with 'ref' succeed");

while (true)
{
    var input = Console.ReadLine();
    if (input == null)
        break;

    rpc.Remote.WriteLine(input);                        // Call the server WriteLine method
}

Client console:
Addr: 127.0.0.1:11451
RPC call with 'ref' succeed
hello
this message is from client

Server console:
Listening 11451
Server print: hello
Server print: this message is from client