Method documentation on ISynchronizableQuery

Return task as cancelled

Author: gliljas

src/NHibernate/Async/Impl/SessionFactoryImpl.cs

@@ -222,7 +222,7 @@ public sealed partial class SessionFactoryImpl : ISessionFactoryImplementor, IOb
 				}
 				if (tasks.Any())
 				{
-					return Task.WhenAny(Task.WhenAll(tasks), cancellationToken.WhenCanceled());
+					return Task.WhenAny(Task.WhenAll(tasks), cancellationToken.WhenCanceled(true));
 				}
 				return Task.CompletedTask;
 			}
@@ -338,7 +338,7 @@ public sealed partial class SessionFactoryImpl : ISessionFactoryImplementor, IOb
 				}
 				if (tasks.Any())
 				{
-					return Task.WhenAny(Task.WhenAll(tasks), cancellationToken.WhenCanceled());
+					return Task.WhenAny(Task.WhenAll(tasks), cancellationToken.WhenCanceled(true));
 				}
 				return Task.CompletedTask;
 			}

src/NHibernate/Async/TaskExtensions.cs

@@ -10,15 +10,28 @@ namespace NHibernate.Async
     public static class TaskExtensions
     {
 		//https://github.com/dotnet/corefx/issues/2704
-		/// <summary>
-		/// Returns a Task that completes if the cancellationToken is cancelled
-		/// </summary>
-		/// <param name="cancellationToken"></param>
-		/// <returns></returns>
-		public static Task WhenCanceled(this CancellationToken cancellationToken)
+	    /// <summary>
+	    /// Returns a Task that completes if the cancellationToken is cancelled
+	    /// </summary>
+	    /// <param name="cancellationToken"></param>
+	    /// <param name="setCancelled"></param>
+	    /// <returns></returns>
+	    public static Task WhenCanceled(this CancellationToken cancellationToken, bool setCancelled)
 	    {
 		    var tcs = new TaskCompletionSource<bool>();
-		    cancellationToken.Register(s => ((TaskCompletionSource<bool>) s).SetResult(true), tcs);
+		    cancellationToken.Register(s =>
+		    {
+				var completion= ((TaskCompletionSource<bool>) s);
+			    if (setCancelled)
+			    {
+				    completion.SetCanceled();
+			    }
+			    else
+				{
+				    completion.SetResult(true);
+				}
+			    
+		    }, tcs);
 		    return tcs.Task;
 	    }
 	}

src/NHibernate/ISynchronizableQuery.cs

@@ -4,9 +4,31 @@ namespace NHibernate
 {
 	public interface ISynchronizableQuery<out T> where T : ISynchronizableQuery<T>
 	{
+		/// <summary>
+		/// Adds a query space for auto-flush synchronization and second level cache invalidation.
+		/// </summary>
+		/// <param name="querySpace"></param>
+		/// <returns></returns>
 		T AddSynchronizedQuerySpace(string querySpace);
+
+		/// <summary>
+		/// Adds an entity name for auto-flush synchronization and second level cache invalidation.
+		/// </summary>
+		/// <param name="entityName"></param>
+		/// <returns></returns>
 		T AddSynchronizedEntityName(string entityName);
+
+		/// <summary>
+		/// Adds an entity type for auto-flush synchronization and second level cache invalidation.
+		/// </summary>
+		/// <param name="entityType"></param>
+		/// <returns></returns>
 		T AddSynchronizedEntityClass(System.Type entityType);
+
+		/// <summary>
+		/// 
+		/// </summary>
+		/// <returns></returns>
 		IReadOnlyCollection<string> GetSynchronizedQuerySpaces();
 	}
 }