Extend IODataOutputInStreamErrorListener interface to support asynchr…

…onous notifications when an in-stream error is to be written

src/Microsoft.OData.Core/Batch/ODataBatchWriter.cs

@@ -419,6 +419,14 @@ public Task FlushAsync()
         /// </remarks>
         public abstract void OnInStreamError();
 
+        /// <inheritdoc/>
+        public virtual Task OnInStreamErrorAsync()
+        {
+            // NOTE: ODataBatchWriter class is abstract and public. This method body is intended
+            // to prevent a breaking change in subclasses that provide the implementation.
+            throw new NotImplementedException();
+        }
+
         /// <summary>
         /// Flush the output.
         /// </summary>

src/Microsoft.OData.Core/IODataOutputInStreamErrorListener.cs

@@ -6,6 +6,10 @@
 
 namespace Microsoft.OData
 {
+    #region Namespaces
+    using System.Threading.Tasks;
+    #endregion Namespaces
+
     /// <summary>
     /// An interface that allows the implementations of the writers to get notified if an in-stream error is to be written.
     /// </summary>
@@ -19,5 +23,15 @@ internal interface IODataOutputInStreamErrorListener
         /// If the listener returns, the writer should not allow any more writing, since the in-stream error is the last thing in the payload.
         /// </remarks>
         void OnInStreamError();
+
+        /// <summary>
+        /// This method asynchronously notifies the listener, that an in-stream error is to be written.
+        /// </summary>
+        /// <remarks>
+        /// This listener can choose to fail, if the currently written payload doesn't support in-stream error at this position.
+        /// If the listener returns, the writer should not allow any more writing, since the in-stream error is the last thing in the payload.
+        /// </remarks>
+        /// <returns>A task that represents the asynchronous operation.</returns>
+        Task OnInStreamErrorAsync();
     }
 }

src/Microsoft.OData.Core/JsonLight/ODataJsonLightDeltaWriter.cs

@@ -287,6 +287,12 @@ void IODataOutputInStreamErrorListener.OnInStreamError()
             this.inStreamErrorListener.OnInStreamError();
         }
 
+        /// <inheritdoc/>
+        Task IODataOutputInStreamErrorListener.OnInStreamErrorAsync()
+        {
+            throw new NotImplementedException();
+        }
+
         #endregion
     }
 }

src/Microsoft.OData.Core/ODataAsynchronousWriter.cs

@@ -101,6 +101,12 @@ void IODataOutputInStreamErrorListener.OnInStreamError()
             throw new ODataException(Strings.ODataAsyncWriter_CannotWriteInStreamErrorForAsync);
         }
 
+        /// <inheritdoc/>
+        Task IODataOutputInStreamErrorListener.OnInStreamErrorAsync()
+        {
+            throw new NotImplementedException();
+        }
+
         /// <summary>
         /// Validates that the async writer is not disposed.
         /// </summary>

src/Microsoft.OData.Core/ODataCollectionWriterCore.cs

@@ -265,6 +265,12 @@ void IODataOutputInStreamErrorListener.OnInStreamError()
             this.EnterScope(CollectionWriterState.Error, this.scopes.Peek().Item);
         }
 
+        /// <inheritdoc/>
+        Task IODataOutputInStreamErrorListener.OnInStreamErrorAsync()
+        {
+            throw new NotImplementedException();
+        }
+
         /// <summary>
         /// Determines whether a given writer state is considered an error state.
         /// </summary>

src/Microsoft.OData.Core/ODataParameterWriterCore.cs

@@ -306,6 +306,12 @@ void IODataOutputInStreamErrorListener.OnInStreamError()
             throw new ODataException(Strings.ODataParameterWriter_InStreamErrorNotSupported);
         }
 
+        /// <inheritdoc/>
+        Task IODataOutputInStreamErrorListener.OnInStreamErrorAsync()
+        {
+            throw new NotImplementedException();
+        }
+
         /// <summary>
         /// Check if the object has been disposed; called from all public API methods. Throws an ObjectDisposedException if the object
         /// has already been disposed.

src/Microsoft.OData.Core/ODataWriterCore.cs

@@ -760,6 +760,12 @@ void IODataOutputInStreamErrorListener.OnInStreamError()
             this.EnterScope(WriterState.Error, this.CurrentScope.Item);
         }
 
+        /// <inheritdoc/>
+        Task IODataOutputInStreamErrorListener.OnInStreamErrorAsync()
+        {
+            throw new NotImplementedException();
+        }
+
         /// <summary>
         /// This method is called when a stream is requested. It is a no-op.
         /// </summary>