Add a binary propagator format option (#116)

* add binary format option * add notice that binary propagation is experimental
opentracing · Jan 23, 2019 · 4b1c14c · 4b1c14c
1 parent 03c457c
commit 4b1c14c
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 3 deletions.
diff --git a/examples/OpenTracing.Examples/LateSpanFinish/LateSpanFinishTest.cs b/examples/OpenTracing.Examples/LateSpanFinish/LateSpanFinishTest.cs
@@ -46,15 +46,15 @@ private Task SubmitTasks()
             {
                 using (IScope childScope1 = _tracer.BuildSpan("task1").StartActive(finishSpanOnDispose:true))
                 {
-                    await Task.Delay(55);
+                    await Task.Delay(100);
                 }
             });
 
             var task2 = Task.Run(async () =>
             {
                 using (IScope childScope2 = _tracer.BuildSpan("task2").StartActive(finishSpanOnDispose:true))
                 {
-                    await Task.Delay(85);
+                    await Task.Delay(500);
                 }
             });
 

diff --git a/src/OpenTracing/Propagation/BuiltinFormats.cs b/src/OpenTracing/Propagation/BuiltinFormats.cs
@@ -1,4 +1,6 @@
-namespace OpenTracing.Propagation
+using System.IO;
+
+namespace OpenTracing.Propagation
 {
     public static class BuiltinFormats
     {
@@ -25,6 +27,17 @@ public static class BuiltinFormats
         /// <seealso cref="TextMap"/>
         public static readonly IFormat<ITextMap> HttpHeaders = new Builtin<ITextMap>("HTTP_HEADERS");
 
+        /// <summary>
+        /// The 'Binary' format allows for unconstrained byte encoding of <see cref="ISpanContext"/> state
+        /// for <see cref="ITracer.Inject{TCarrier}"/> and <see cref="ITracer.Extract{TCarrier}"/> using a <see cref="MemoryStream"/>.
+        /// Note that this should be considered experimental, and subject to change.
+        /// </summary>
+        /// <seealso cref="ITracer.Inject{TCarrier}"/>
+        /// <seealso cref="ITracer.Extract{TCarrier}"/>
+        /// <seealso cref="IFormat{TCarrier}"/>
+        /// <seealso cref="byte"/>
+        public static readonly IFormat<Stream> Binary = new Builtin<Stream>("BINARY");
+
         private struct Builtin<TCarrier> : IFormat<TCarrier>
         {
             private readonly string _name;