Class CompressorRouterExtensions

Namespace

IceRpc

Assembly

IceRpc.Compressor.dll

Provides an extension method for Router to add the compressor middleware.

public static class CompressorRouterExtensions

Inheritance

object

CompressorRouterExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

UseCompressor(Router, CompressionFormat, CompressionLevel)

Adds a CompressorMiddleware to this router.

public static Router UseCompressor(this Router router, CompressionFormat compressionFormat, CompressionLevel compressionLevel = CompressionLevel.Fastest)

Parameters

router Router

The router being configured.

compressionFormat CompressionFormat

The compression format for the compress operation.

compressionLevel CompressionLevel

The compression level for the compress operation.

Returns

Router

The router being configured.

Examples

The following code adds the compressor middleware to the dispatch pipeline.

// Add the compressor middleware to the dispatch pipeline.
Router router = new Router()
    .UseCompressor(CompressionFormat.Brotli)
    .Map(new Chatbot());

// The default transport (QUIC) requires a server certificate. CreateServerAuthenticationOptions
// is a helper from examples/common/Program.Authentication.cs in the icerpc-csharp repo.
using var serverCertificate = X509CertificateLoader.LoadPkcs12FromFile(
    "certs/server.p12",
    password: null,
    keyStorageFlags: X509KeyStorageFlags.Exportable);

await using var server = new Server(
    router,
    serverAuthenticationOptions: CreateServerAuthenticationOptions(serverCertificate));
server.Listen();

See Also

https://github.com/icerpc/icerpc-csharp/tree/main/examples/slice/Compress