OutWit.Communication.Serializers.GoogleProtobuf 3.1.0

OutWit.Communication.Serializers.GoogleProtobuf

Google.Protobuf serialization for WitRPC method parameters, return values and event arguments — the serializer for proto-first gRPC services whose models are generated by protoc / Grpc.Tools. Opt-in, on the client and the server.

Overview

Reference this package on both ends and call WithGoogleProtobuf():

using OutWit.Communication.Client;
using OutWit.Communication.Client.WebSocket.Utils;
using OutWit.Communication.Serializers.GoogleProtobuf;

var client = WitClientBuilder.Build(options =>
{
    options.WithWebSocket("ws://localhost:5000");
    options.WithGoogleProtobuf();
});

The server side is symmetrical: options.WithGoogleProtobuf() on WitServerBuilder with the same using.

What travels how

• Every parameter, result or event argument that is a generated message (Google.Protobuf.IMessage) is written and read as protobuf wire bytes — byte-for-byte what gRPC would put on the wire for that message. Your .proto files, generated classes, RepeatedFields and well-known types stay exactly as they are.

• Everything else in a signature — int, string, Guid, enums, plain DTOs — goes through a fallback serializer, JSON by default. WithGoogleProtobuf(IMessageSerializer fallback) lets you pick another one for those.

Both sides decide per declared type, so the choice is deterministic and needs no marker on the wire.

Why this exists: bring your own models

A service written against classic Grpc.Net already has its contracts in .proto and its models generated. Moving it to WitRPC should not mean re-modelling and re-testing every message. With this package the generated messages are the payloads; WitRPC provides the transport (WebSocket, TCP, pipes, memory-mapped files, REST), the proxies, the callbacks and the encryption around them.

Server streaming (IAsyncEnumerable) is not part of WitRPC 3.x; unary calls and events are.

WitRPC's own message envelope always travels as MemoryPack, independently of this package.

License

Licensed under the Apache License, Version 2.0. See LICENSE.

Attribution (optional)

If you use OutWit.Communication.Serializers.GoogleProtobuf in a product, a mention is appreciated (but not required), for example: "Powered by WitRPC (https://witrpc.io/)".

Trademark / Project name

"WitRPC" and the WitRPC logo are used to identify the official project by Dmitry Ratner.

You may:

• refer to the project name in a factual way (e.g., "built with WitRPC");
• use the name to indicate compatibility (e.g., "WitRPC-compatible").

You may not:

• use "WitRPC" as the name of a fork or a derived product in a way that implies it is the official project;
• use the WitRPC logo to promote forks or derived products without permission.