IceRpc.Compressor 0.6.1

Compressor interceptor and middleware for IceRPC

IceRpc.Compressor provides an IceRPC interceptor and the corresponding IceRPC middleware.

The compressor interceptor allows you to compress the payloads of outgoing requests. It also decompresses the payloads of incoming responses when these payloads are compressed.

The compressor middleware allows you to compress the payloads of outgoing responses. It also decompresses the payloads of incoming requests these payloads are compressed.

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

Sample code

// Slice definitions

module VisitorCenter

interface Greeter {
    // The compress attribute instructs the compressor interceptor or middleware (if
    // installed) to compress the payload of the outgoing request or response.
    // The compressor interceptor or middleware does not compress the payloads of Slice
    // operations without this attribute.
    [compress(Args, Return)] greet(name: string) -> string
}

// Client application

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

// 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 compressor interceptor to the invocation pipeline.
Pipeline pipeline = new Pipeline()
    .UseCompressor(CompressionFormat.Brotli)
    .Into(connection);

// Create the proxy using the invocation pipeline.
var greeter = new GreeterProxy(pipeline);

// The compressor interceptor compresses the request payload. It also decompresses the
// response payload (if it comes back compressed).
string greeting = await greeter.GreetAsync(Environment.UserName);

// Server application

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

// Add the compressor middleware to the dispatch pipeline. Chatbot is a class that
// implements the IGreeterService interface generated by the Slice compiler.
Router router = new Router()
    .UseCompressor(CompressionFormat.Brotli)
    .Map(new Chatbot());

// 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 compressor registration. For a complete Generic Host setup with certificates and configuration, see the GenericHost example.

// Slice definitions

module VisitorCenter

interface Greeter {
    // The compress attribute instructs the compressor interceptor or middleware (if
    // installed) to compress the payload of the outgoing request or response.
    // The compressor interceptor or middleware does not compress the payloads of Slice
    // operations without this attribute.
    [compress(Args, Return)] greet(name: string) -> string
}

// Client application

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

HostApplicationBuilder hostBuilder = Host.CreateApplicationBuilder(args);

hostBuilder.Services
    .AddIceRpcClientConnection(new Uri("icerpc://localhost"))
    .AddIceRpcInvoker(builder =>
        builder
            // Add the compressor interceptor to the invocation pipeline.
            .UseCompressor(CompressionFormat.Brotli)
            .Into<ClientConnection>())
    // Add an IGreeter singleton that uses the IInvoker singleton registered above.
    .AddSingleton<IGreeter>(provider => provider.CreateSliceProxy<GreeterProxy>());

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

// Server application

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

HostApplicationBuilder hostBuilder = Host.CreateApplicationBuilder(args);

hostBuilder.Services
    .AddSingleton<IGreeterService, Chatbot>()
    .AddIceRpcServer(builder =>
        builder
            // Add the compressor middleware to the dispatch pipeline.
            .UseCompressor(CompressionFormat.Brotli)
            .Map<IGreeterService>());

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

Remarks

The compressor interceptor and middleware compress and decompress payloads regardless of how these payloads are encoded. They work well with Slice but don't require Slice.