Aid.Microservice.Shared 2.3.0

Aid.Microservice.Shared

Shared models, attributes, and protocols for the Aid.Microservice ecosystem.

This package is referenced by both Aid.Microservice.Server and Aid.Microservice.Client and does not need to be installed directly in most cases.

Attributes

[Microservice]

Marks a class as an RPC service.

[Microservice]                                             // name: class name without "Service" suffix
[Microservice("custom_name")]                              // explicit name
[Microservice(SerializerType = typeof(NamekoSerializer))]  // per-service serializer
[Microservice(ExchangeName = "my_rpc")]                    // explicit exchange
[Microservice(Exchanges = ["aid_rpc", "nameko-rpc"])]      // multiple exchanges

[RpcCallable]

Marks a method as an RPC endpoint.

[RpcCallable]                                            // name: method name (lowercase)
[RpcCallable("alias")]                                   // explicit name
[RpcCallable(SerializerType = typeof(NamekoSerializer))] // per-method serializer

Protocols

IRpcProtocol

Defines the messaging protocol (exchange type, exchange name, serializer).

Built-in implementations:

• DefaultJsonProtocol — .NET ↔ .NET (Topic, aid_rpc)
• NamekoProtocol — .NET ↔ Python Nameko (Topic, nameko-rpc)

IRequestSerializer

Handles serialization/deserialization of RPC message bodies.

Built-in implementations:

• DefaultJsonSerializer — {"Method": "...", "Parameters": {...}}
• NamekoSerializer — {"args": [...], "kwargs": {...}, "context_data": {...}}

Models

RpcRequest

Parsed incoming request.

public record RpcRequest
{
    public string Method { get; init; }
    public Dictionary<string, JsonElement>? Parameters { get; init; }
}

RpcResponse

RPC call result.

public record RpcResponse
{
    public object? Result { get; init; }
    public RpcError? Error { get; set; }
    public bool IsSuccess => Error == null;
}

RpcError

Error details from server-side execution.

public record RpcError
{
    public string Message { get; }
    public string? StackTrace { get; }
    public string? ErrorType { get; }
}

RpcNamekoRequest

Wrapper for sending positional arguments to Nameko-compatible services.

new RpcNamekoRequest(1, 2, 3)                              // args only
new RpcNamekoRequest(args: [1, 2], kwargs: new { x = 10 }) // both

Configuration

RabbitMqConfiguration

public class RabbitMqConfiguration
{
    public string Hostname { get; set; } = "localhost";
    public int Port { get; set; } = 5672;
    public string Username { get; set; } = "guest";
    public string Password { get; set; } = "guest";
    public string? ExchangeName { get; set; }
    public int RetryCount { get; set; } = 3;
    public int RecoveryInterval { get; set; } = 5;
}