IceRpc.RequestContext 0.6.1

RequestContext interceptor and middleware for IceRPC

IceRpc.RequestContext provides an IceRPC interceptor that encodes request context features into request context fields. It also provides the corresponding middleware that decodes request context fields into request context features.

Source code | Package | Example | API reference | Interceptor documentation | Middleware documentation

Sample code

// Client application

using IceRpc;
using System.Security.Cryptography.X509Certificates;

// Load the test root CA certificate in order to connect to the server that uses a test
// server certificate.
using var rootCA = X509CertificateLoader.LoadCertificateFromFile("certs/cacert.der");

await using var connection = new ClientConnection(
    new Uri("icerpc://localhost"),
    // examples/common/Program.Authentication.cs in the icerpc-csharp repo provides the
    // CreateClientAuthenticationOptions helper method
    clientAuthenticationOptions: CreateClientAuthenticationOptions(rootCA));

// Add the request context interceptor to the invocation pipeline.
Pipeline pipeline = new Pipeline()
    .UseRequestContext()
    .Into(connection);

// Server application

using IceRpc;
using System.Security.Cryptography.X509Certificates;

// Add the request context middleware to the dispatch pipeline.
Router router = new Router()
    .UseRequestContext()
    .Map(...);

// The default transport (QUIC) requires a server certificate.
// We use a test certificate here.
using var serverCertificate = X509CertificateLoader.LoadPkcs12FromFile(
    "certs/server.p12",
    password: null,
    keyStorageFlags: X509KeyStorageFlags.Exportable);

await using var server = new Server(
    router,
    // examples/common/Program.Authentication.cs in the icerpc-csharp repo provides the
    // CreateServerAuthenticationOptions helper method
    serverAuthenticationOptions: CreateServerAuthenticationOptions(serverCertificate));
server.Listen();

Sample code with DI

This sample stays focused on the request context registration. For a complete Generic Host setup with certificates and configuration, see the GenericHost example.

// Client application

using IceRpc;
using IceRpc.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

HostApplicationBuilder hostBuilder = Host.CreateApplicationBuilder(args);

hostBuilder.Services
    .AddIceRpcClientConnection(new Uri("icerpc://localhost"))
    .AddIceRpcInvoker(builder =>
        builder
            // Add the request context interceptor to the invocation pipeline.
            .UseRequestContext()
            .Into<ClientConnection>());

using IHost host = hostBuilder.Build();
host.Run();

// Server application

using IceRpc;
using IceRpc.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

HostApplicationBuilder hostBuilder = Host.CreateApplicationBuilder(args);

hostBuilder.Services
    .AddIceRpcServer(builder =>
        builder
            // Add the request context middleware to the dispatch pipeline.
            .UseRequestContext()
            .Map<...>());

using IHost host = hostBuilder.Build();
host.Run();

Ice interop

The ice protocol can send and receive request context fields. They correspond to request contexts in Ice.