Async notification of ConnectionHandlers

Author: alex-kulakov

Orm/Xtensive.Orm/Sql/SqlHelper.cs

@@ -1,4 +1,4 @@
-// Copyright (C) 2009-2020 Xtensive LLC.
+// Copyright (C) 2009-2021 Xtensive LLC.
 // This code is distributed under MIT license terms.
 // See the License.txt file in the project root for more information.
 // Created by: Denis Krjuchkov
@@ -8,14 +8,9 @@
 using System.Collections.Generic;
 using System.Data;
 using System.Data.Common;
-using System.Data.SqlClient;
-using System.Linq;
 using System.Runtime.CompilerServices;
-using System.Text;
 using System.Threading;
 using System.Threading.Tasks;
-using JetBrains.Annotations;
-using Xtensive.Collections;
 using Xtensive.Core;
 using Xtensive.Orm;
 using Xtensive.Sql.Dml;
@@ -491,6 +486,8 @@ public static NotSupportedException NotSupported(ServerFeatures feature)
       return NotSupported(feature.ToString());
     }
 
+    #region Notifications
+
     /// <summary>
     /// Notifies all the <paramref name="connectionHandlers"/> that
     /// <paramref name="connection"/> is about to be opened.
@@ -502,8 +499,29 @@ public static NotSupportedException NotSupported(ServerFeatures feature)
     public static void NotifyConnectionOpening(
       IEnumerable<IConnectionHandler> connectionHandlers, DbConnection connection, bool reconnect = false)
     {
-      foreach (var handler in connectionHandlers)
+      foreach (var handler in connectionHandlers) {
         handler.ConnectionOpening(new ConnectionEventData(connection, reconnect));
+      }
+    }
+
+    /// <summary>
+    /// Notifies all the <paramref name="connectionHandlers"/> that
+    /// <paramref name="connection"/> is about to be opened.
+    /// </summary>
+    /// <param name="connectionHandlers">The handlers that should be notified.</param>
+    /// <param name="connection">The connection that is opening.</param>
+    /// <param name="reconnect"><see langword="true"/> if event happened on attemp to restore connection, otherwise <see langword="false"/>.</param>
+    /// <param name="token">Cancellation token.</param>
+    /// <returns>Task performing operation.</returns>
+    [MethodImpl(MethodImplOptions.AggressiveInlining)]
+    public static async Task NotifyConnectionOpeningAsync(
+      IEnumerable<IConnectionHandler> connectionHandlers, DbConnection connection, bool reconnect = false, CancellationToken token = default)
+    {
+      foreach (var handler in connectionHandlers) {
+        await handler.ConnectionOpeningAsync(
+          new ConnectionEventData(connection, reconnect), token)
+          .ConfigureAwait(false);
+      }
     }
 
     /// <summary>
@@ -518,8 +536,33 @@ public static void NotifyConnectionOpening(
     public static void NotifyConnectionInitializing(
       IEnumerable<IConnectionHandler> connectionHandlers, DbConnection connection, string initializationScript, bool reconnect = false)
     {
-      foreach (var handler in connectionHandlers)
+      foreach (var handler in connectionHandlers) {
         handler.ConnectionInitialization(new ConnectionInitEventData(initializationScript, connection, reconnect));
+      }
+    }
+
+    /// <summary>
+    /// Notifies all the <paramref name="connectionHandlers"/> that
+    /// opened connection is about to be initialized with <paramref name="initializationScript"/>.
+    /// </summary>
+    /// <param name="connectionHandlers">The handlers that should be notified.</param>
+    /// <param name="connection">Opened but not initialized connection</param>
+    /// <param name="initializationScript">The script that will run to initialize connection</param>
+    /// <param name="reconnect"><see langword="true"/> if event happened on attemp to restore connection, otherwise <see langword="false"/>.</param>
+    /// <param name="token">Cancellation token.</param>
+    /// <returns>Task performing operation.</returns>
+    [MethodImpl(MethodImplOptions.AggressiveInlining)]
+    public static async Task NotifyConnectionInitializingAsync(IEnumerable<IConnectionHandler> connectionHandlers,
+      DbConnection connection,
+      string initializationScript,
+      bool reconnect = false,
+      CancellationToken token = default)
+    {
+      foreach (var handler in connectionHandlers) {
+        await handler.ConnectionInitializationAsync(
+          new ConnectionInitEventData(initializationScript, connection, reconnect), token)
+          .ConfigureAwait(false);
+      }
     }
 
     /// <summary>
@@ -533,8 +576,29 @@ public static void NotifyConnectionInitializing(
     public static void NotifyConnectionOpened(
       IEnumerable<IConnectionHandler> connectionHandlers, DbConnection connection, bool reconnect = false)
     {
-      foreach (var handler in connectionHandlers)
+      foreach (var handler in connectionHandlers) {
         handler.ConnectionOpened(new ConnectionEventData(connection, reconnect));
+      }
+    }
+
+    /// <summary>
+    /// Notifies all the <paramref name="connectionHandlers"/> about
+    /// successful connection opening.
+    /// </summary>
+    /// <param name="connectionHandlers">The handlers that should be notified.</param>
+    /// <param name="connection">The connection that is completely opened and initialized.</param>
+    /// <param name="reconnect"><see langword="true"/> if event happened on attemp to restore connection, otherwise <see langword="false"/>.</param>
+    /// <param name="token">Cancellation token.</param>
+    /// <returns>Task performing operation.</returns>
+    [MethodImpl(MethodImplOptions.AggressiveInlining)]
+    public static async Task NotifyConnectionOpenedAsync(
+      IEnumerable<IConnectionHandler> connectionHandlers, DbConnection connection, bool reconnect = false, CancellationToken token = default)
+    {
+      foreach (var handler in connectionHandlers) {
+        await handler.ConnectionOpenedAsync(
+          new ConnectionEventData(connection, reconnect), token)
+          .ConfigureAwait(false);
+      }
     }
 
     /// <summary>
@@ -549,8 +613,35 @@ public static void NotifyConnectionOpened(
     public static void NotifyConnectionOpeningFailed(
       IEnumerable<IConnectionHandler> connectionHandlers, DbConnection connection, Exception exception, bool reconnect = false)
     {
-      foreach (var handler in connectionHandlers)
+      foreach (var handler in connectionHandlers) {
         handler.ConnectionOpeningFailed(new ConnectionErrorEventData(exception, connection, reconnect));
+      }
     }
+
+    /// <summary>
+    /// Notifies all the <paramref name="connectionHandlers"/> about
+    /// connection opening failure.
+    /// </summary>
+    /// <param name="connectionHandlers">The handlers that should be notified.</param>
+    /// <param name="connection">Connection that failed to be opened or properly initialized.</param>
+    /// <param name="exception">The exception which appeared.</param>
+    /// <param name="reconnect"><see langword="true"/> if event happened on attemp to restore connection, otherwise <see langword="false"/>.</param>
+    /// <param name="token">Cancellation token.</param>
+    /// <returns>Task performing operation.</returns>
+    [MethodImpl(MethodImplOptions.AggressiveInlining)]
+    public static async Task NotifyConnectionOpeningFailedAsync(IEnumerable<IConnectionHandler> connectionHandlers,
+      DbConnection connection,
+      Exception exception,
+      bool reconnect = false,
+      CancellationToken token = default)
+    {
+      foreach (var handler in connectionHandlers) {
+        await handler.ConnectionOpeningFailedAsync(
+          new ConnectionErrorEventData(exception, connection, reconnect), token)
+          .ConfigureAwait(false);
+      }
+    }
+
+    #endregion
   }
 }