#region Copyright notice and license // Copyright 2015 gRPC authors. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. #endregion using System; using Grpc.Core.Utils; namespace Grpc.Core { /// /// Encapsulates the logic for serializing and deserializing messages. /// public class Marshaller { readonly Func serializer; readonly Func deserializer; readonly Action contextualSerializer; readonly Func contextualDeserializer; /// /// Initializes a new marshaller from simple serialize/deserialize functions. /// /// Function that will be used to serialize messages. /// Function that will be used to deserialize messages. public Marshaller(Func serializer, Func deserializer) { this.serializer = GrpcPreconditions.CheckNotNull(serializer, nameof(serializer)); this.deserializer = GrpcPreconditions.CheckNotNull(deserializer, nameof(deserializer)); // contextual serialization/deserialization is emulated to make the marshaller // usable with the grpc library (required for backward compatibility). this.contextualSerializer = EmulateContextualSerializer; this.contextualDeserializer = EmulateContextualDeserializer; } /// /// Initializes a new marshaller from serialize/deserialize fuctions that can access serialization and deserialization /// context. Compared to the simple serializer/deserializer functions, using the contextual version provides more /// flexibility and can lead to increased efficiency (and better performance). /// Note: This constructor is part of an experimental API that can change or be removed without any prior notice. /// /// Function that will be used to serialize messages. /// Function that will be used to deserialize messages. public Marshaller(Action serializer, Func deserializer) { this.contextualSerializer = GrpcPreconditions.CheckNotNull(serializer, nameof(serializer)); this.contextualDeserializer = GrpcPreconditions.CheckNotNull(deserializer, nameof(deserializer)); // gRPC only uses contextual serializer/deserializer internally, so emulating the legacy // (de)serializer is not necessary. this.serializer = (msg) => { throw new NotImplementedException(); }; this.deserializer = (payload) => { throw new NotImplementedException(); }; } /// /// Gets the serializer function. /// public Func Serializer => this.serializer; /// /// Gets the deserializer function. /// public Func Deserializer => this.deserializer; /// /// Gets the serializer function. /// Note: experimental API that can change or be removed without any prior notice. /// public Action ContextualSerializer => this.contextualSerializer; /// /// Gets the serializer function. /// Note: experimental API that can change or be removed without any prior notice. /// public Func ContextualDeserializer => this.contextualDeserializer; // for backward compatibility, emulate the contextual serializer using the simple one private void EmulateContextualSerializer(T message, SerializationContext context) { var payload = this.serializer(message); context.Complete(payload); } // for backward compatibility, emulate the contextual deserializer using the simple one private T EmulateContextualDeserializer(DeserializationContext context) { return this.deserializer(context.PayloadAsNewBuffer()); } } /// /// Utilities for creating marshallers. /// public static class Marshallers { /// /// Creates a marshaller from specified serializer and deserializer. /// public static Marshaller Create(Func serializer, Func deserializer) { return new Marshaller(serializer, deserializer); } /// /// Creates a marshaller from specified contextual serializer and deserializer. /// Note: This method is part of an experimental API that can change or be removed without any prior notice. /// public static Marshaller Create(Action serializer, Func deserializer) { return new Marshaller(serializer, deserializer); } /// /// Returns a marshaller for string type. This is useful for testing. /// public static Marshaller StringMarshaller { get { return new Marshaller(System.Text.Encoding.UTF8.GetBytes, System.Text.Encoding.UTF8.GetString); } } } }