Merge pull request #140 from microsoft/users/badrishc/make-serializer-public

Make serializer public

Author: badrishc

Sources/Core/Microsoft.StreamProcessing/Egress/Binary/BinaryEgress.cs

@@ -21,15 +21,15 @@ public static void ToBinaryStream<TKey, TPayload>(this IStreamable<TKey, TPayloa
         {
             if (writePropertiesToStream)
             {
-                var propSer = StreamableSerializer.Create<SerializedProperties>();
+                var propSer = StreamSerializer.Create<SerializedProperties>();
                 propSer.Serialize(binaryStream, SerializedProperties.FromStreamProperties(input.Properties));
             }
             input.ToStreamMessageObservable()
                 .Subscribe(new BinaryStreamObserver<TKey, TPayload>(input.Properties, binaryStream));
         }
 
         /// <summary>
-        /// Serialize streamable into a binary file
+        /// Serialize streamble into a binary file
         /// </summary>
         /// <typeparam name="TKey"></typeparam>
         /// <typeparam name="TPayload"></typeparam>
@@ -57,15 +57,15 @@ public static void RegisterBinaryOutput<TKey, TPayload>(this QueryContainer cont
         {
             if (writePropertiesToStream)
             {
-                var propSer = StreamableSerializer.Create<SerializedProperties>();
+                var propSer = StreamSerializer.Create<SerializedProperties>();
                 propSer.Serialize(binaryStream, SerializedProperties.FromStreamProperties(input.Properties));
             }
             container.RegisterOutputAsStreamMessages(input, identifier)
                 .Subscribe(new BinaryStreamObserver<TKey, TPayload>(input.Properties, binaryStream));
         }
 
         /// <summary>
-        /// Serialize streamable into a binary file
+        /// Serialize streamble into a binary file
         /// </summary>
         /// <typeparam name="TKey"></typeparam>
         /// <typeparam name="TPayload"></typeparam>

Sources/Core/Microsoft.StreamProcessing/Egress/Binary/BinaryEgress.tt

@@ -35,7 +35,7 @@ namespace Microsoft.StreamProcessing
         {
             if (writePropertiesToStream)
             {
-                var propSer = StreamableSerializer.Create<SerializedProperties>();
+                var propSer = StreamSerializer.Create<SerializedProperties>();
                 propSer.Serialize(binaryStream, SerializedProperties.FromStreamProperties(input.Properties));
             }
 <# if (hasContainer) { #>

Sources/Core/Microsoft.StreamProcessing/Egress/Binary/BinaryStreamObserver.cs

@@ -15,7 +15,7 @@ internal sealed class BinaryStreamObserver<TKey, TPayload> : IObserver<StreamMes
 
         public BinaryStreamObserver(StreamProperties<TKey, TPayload> streamProperties, Stream stream)
         {
-            this.serializer = StreamableSerializer.Create<QueuedMessage<StreamMessage<TKey, TPayload>>>(
+            this.serializer = StreamSerializer.Create<QueuedMessage<StreamMessage<TKey, TPayload>>>(
                 new SerializerSettings() { KnownTypes = StreamMessageManager.GeneratedTypes() });
             this.stream = stream;
         }

Sources/Core/Microsoft.StreamProcessing/Ingress/Binary/BinaryIngressReader.cs

@@ -61,7 +61,7 @@ private void Ingress(IStreamObserver<TKey, TPayload> observer)
 
             try
             {
-                var serializer = StreamableSerializer.Create<QueuedMessage<StreamMessage<TKey, TPayload>>>(
+                var serializer = StreamSerializer.Create<QueuedMessage<StreamMessage<TKey, TPayload>>>(
                     new SerializerSettings() { KnownTypes = StreamMessageManager.GeneratedTypes() });
                 while (true)
                 {

Sources/Core/Microsoft.StreamProcessing/Ingress/Binary/BinaryIngressStreamable.cs

@@ -24,7 +24,7 @@ public BinaryIngressStreamable(Stream binaryStream, int numMessages, IIngressSch
         {
             if (readPropertiesFromStream)
             {
-                var propSer = StreamableSerializer.Create<SerializedProperties>();
+                var propSer = StreamSerializer.Create<SerializedProperties>();
                 var props = propSer.Deserialize(binaryStream);
                 this.properties = props.ToStreamProperties<TKey, TPayload>();
             }

Sources/Core/Microsoft.StreamProcessing/Ingress/Binary/BinaryIngressStreamablePassive.cs

@@ -23,13 +23,13 @@ public BinaryIngressStreamablePassive(Stream binaryStream, StreamProperties<TKey
         {
             if (readPropertiesFromStream)
             {
-                var propSer = StreamableSerializer.Create<SerializedProperties>();
+                var propSer = StreamSerializer.Create<SerializedProperties>();
                 var props = propSer.Deserialize(binaryStream);
                 this.properties = props.ToStreamProperties<TKey, TPayload>();
             }
 
             this.stream = binaryStream;
-            this.serializer = StreamableSerializer.Create<QueuedMessage<StreamMessage<TKey, TPayload>>>(new SerializerSettings());
+            this.serializer = StreamSerializer.Create<QueuedMessage<StreamMessage<TKey, TPayload>>>(new SerializerSettings());
             this.container = container;
             this.IngressSiteIdentifier = identifier ?? Guid.NewGuid().ToString();
             container?.RegisterIngressSite(identifier);

Sources/Core/Microsoft.StreamProcessing/QueryContainer.cs

@@ -101,7 +101,7 @@ internal bool TryGetFastDictionary3Type(Tuple<string, Type, Type> key, out Type
         internal object GetOrCreateSerializer(Type type)
         {
             if (this.serializers.TryGetValue(type, out object serializer)) return serializer;
-            var serializerStatic = typeof(StreamableSerializer);
+            var serializerStatic = typeof(StreamSerializer);
             var method = serializerStatic.GetTypeInfo().GetMethod("Create", new Type[] { typeof(SerializerSettings) }).MakeGenericMethod(type);
             var settings = new SerializerSettings()
             {

Sources/Core/Microsoft.StreamProcessing/Serializer/SerializerSettings.cs

@@ -11,7 +11,7 @@ namespace Microsoft.StreamProcessing.Serializer
     /// <summary>
     ///     Specifies serializer settings.
     /// </summary>
-    internal sealed class SerializerSettings : IEquatable<SerializerSettings>
+    public sealed class SerializerSettings : IEquatable<SerializerSettings>
     {
         /// <summary>
         ///     Initializes a new instance of the <see cref="SerializerSettings" /> class.

Sources/Core/Microsoft.StreamProcessing/Serializer/StateSerializer.cs

@@ -9,7 +9,11 @@
 
 namespace Microsoft.StreamProcessing.Serializer
 {
-    internal sealed class StateSerializer<T>
+    /// <summary>
+    /// State serializer
+    /// </summary>
+    /// <typeparam name="T">Serialization object type</typeparam>
+    public sealed class StateSerializer<T>
     {
         private readonly ObjectSerializerBase schema;
         private readonly Lazy<Action<BinaryEncoder, T>> serialize;
@@ -22,8 +26,18 @@ internal StateSerializer(ObjectSerializerBase schema)
             this.deserialize = new Lazy<Func<BinaryDecoder, T>>(GenerateDeserializer);
         }
 
+        /// <summary>
+        /// Serialize object to stream
+        /// </summary>
+        /// <param name="stream">Stream to serialize to</param>
+        /// <param name="obj">Object to serialize</param>
         public void Serialize(Stream stream, T obj) => this.serialize.Value(new BinaryEncoder(stream), obj);
 
+        /// <summary>
+        /// Deserialize object from stream
+        /// </summary>
+        /// <param name="stream">Stream to deserialize from</param>
+        /// <returns>Deserialized object</returns>
         public T Deserialize(Stream stream) => this.deserialize.Value(new BinaryDecoder(stream));
 
         private Action<BinaryEncoder, T> GenerateSerializer()

…ssing/Serializer/StreamableSerializer.cs …rocessing/Serializer/StreamSerializer.csSources/Core/Microsoft.StreamProcessing/Serializer/StreamableSerializer.cs renamed to Sources/Core/Microsoft.StreamProcessing/Serializer/StreamSerializer.cs Sources/Core/Microsoft.StreamProcessing/Serializer/StreamableSerializer.cs renamed to Sources/Core/Microsoft.StreamProcessing/Serializer/StreamSerializer.cs

@@ -8,11 +8,19 @@
 
 namespace Microsoft.StreamProcessing.Serializer
 {
-    internal static class StreamableSerializer
+    /// <summary>
+    /// Serializer to read/write objects from/to streams
+    /// </summary>
+    public static class StreamSerializer
     {
         private static readonly Dictionary<Tuple<Type, SerializerSettings>, object> TypedSerializers
             = new Dictionary<Tuple<Type, SerializerSettings>, object>();
 
+        /// <summary>
+        /// Create instance of serializer for given object type
+        /// </summary>
+        /// <typeparam name="T">Type of object</typeparam>
+        /// <returns>StateSerializer</returns>
         public static StateSerializer<T> Create<T>() => Create<T>(new SerializerSettings());
 
         /// <summary>