Skip to content

Commit

Permalink
Review updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
@ajcvickers
ajcvickers committed May 4, 2022
1 parent e1dcd5a commit 6e67b4a
Show file tree
Hide file tree
Showing 10 changed files with 74 additions and 74 deletions.
32 changes: 16 additions & 16 deletions src/EFCore.Relational/Diagnostics/IDbCommandInterceptor.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ public interface IDbCommandInterceptor : IInterceptor
/// If <see cref="InterceptionResult{DbCommand}.HasResult" /> is false, the EF will continue as normal.
/// If <see cref="InterceptionResult{DbCommand}.HasResult" /> is true, then EF will suppress the operation it
/// was about to perform and use <see cref="InterceptionResult{DbCommand}.Result" /> instead.
/// A normal implementation of this method for any interceptor that is not attempting to change the result
/// An implementation of this method for any interceptor that is not attempting to change the result
/// is to return the <paramref name="result" /> value passed in.
/// </returns>
InterceptionResult<DbCommand> CommandCreating(CommandCorrelatedEventData eventData, InterceptionResult<DbCommand> result)
Expand All @@ -63,7 +63,7 @@ InterceptionResult<DbCommand> CommandCreating(CommandCorrelatedEventData eventDa
/// </param>
/// <returns>
/// The result that EF will use.
/// A normal implementation of this method for any interceptor that is not attempting to change the result
/// An implementation of this method for any interceptor that is not attempting to change the result
/// is to return the <paramref name="result" /> value passed in.
/// </returns>
DbCommand CommandCreated(CommandEndEventData eventData, DbCommand result)
Expand All @@ -78,7 +78,7 @@ DbCommand CommandCreated(CommandEndEventData eventData, DbCommand result)
/// </param>
/// <returns>
/// The result that EF will use.
/// A normal implementation of this method for any interceptor that is not attempting to change the result
/// An implementation of this method for any interceptor that is not attempting to change the result
/// is to return the <paramref name="result" /> value passed in.
/// </returns>
DbCommand CommandInitialized(CommandEndEventData eventData, DbCommand result)
Expand All @@ -99,7 +99,7 @@ DbCommand CommandInitialized(CommandEndEventData eventData, DbCommand result)
/// If <see cref="InterceptionResult{DbDataReader}.HasResult" /> is false, the EF will continue as normal.
/// If <see cref="InterceptionResult{DbDataReader}.HasResult" /> is true, then EF will suppress the operation it
/// was about to perform and use <see cref="InterceptionResult{DbDataReader}.Result" /> instead.
/// A normal implementation of this method for any interceptor that is not attempting to change the result
/// An implementation of this method for any interceptor that is not attempting to change the result
/// is to return the <paramref name="result" /> value passed in.
/// </returns>
InterceptionResult<DbDataReader> ReaderExecuting(DbCommand command,CommandEventData eventData, InterceptionResult<DbDataReader> result)
Expand All @@ -120,7 +120,7 @@ InterceptionResult<DbDataReader> ReaderExecuting(DbCommand command,CommandEventD
/// If <see cref="InterceptionResult{Object}.HasResult" /> is false, the EF will continue as normal.
/// If <see cref="InterceptionResult{Object}.HasResult" /> is true, then EF will suppress the operation it
/// was about to perform and use <see cref="InterceptionResult{Object}.Result" /> instead.
/// A normal implementation of this method for any interceptor that is not attempting to change the result
/// An implementation of this method for any interceptor that is not attempting to change the result
/// is to return the <paramref name="result" /> value passed in.
/// </returns>
InterceptionResult<object> ScalarExecuting(DbCommand command, CommandEventData eventData, InterceptionResult<object> result)
Expand All @@ -141,7 +141,7 @@ InterceptionResult<object> ScalarExecuting(DbCommand command, CommandEventData e
/// If <see cref="InterceptionResult{Int32}.HasResult" /> is false, the EF will continue as normal.
/// If <see cref="InterceptionResult{Int32}.HasResult" /> is true, then EF will suppress the operation it
/// was about to perform and use <see cref="InterceptionResult{Int32}.Result" /> instead.
/// A normal implementation of this method for any interceptor that is not attempting to change the result
/// An implementation of this method for any interceptor that is not attempting to change the result
/// is to return the <paramref name="result" /> value passed in.
/// </returns>
InterceptionResult<int> NonQueryExecuting(DbCommand command, CommandEventData eventData, InterceptionResult<int> result)
Expand All @@ -163,7 +163,7 @@ InterceptionResult<int> NonQueryExecuting(DbCommand command, CommandEventData ev
/// If <see cref="InterceptionResult{DbDataReader}.HasResult" /> is false, the EF will continue as normal.
/// If <see cref="InterceptionResult{DbDataReader}.HasResult" /> is true, then EF will suppress the operation it
/// was about to perform and use <see cref="InterceptionResult{DbDataReader}.Result" /> instead.
/// A normal implementation of this method for any interceptor that is not attempting to change the result
/// An implementation of this method for any interceptor that is not attempting to change the result
/// is to return the <paramref name="result" /> value passed in, often using <see cref="Task.FromResult{TResult}" />
/// </returns>
/// <exception cref="OperationCanceledException">If the <see cref="CancellationToken" /> is canceled.</exception>
Expand All @@ -190,7 +190,7 @@ ValueTask<InterceptionResult<DbDataReader>> ReaderExecutingAsync(
/// If <see cref="InterceptionResult{Object}.HasResult" /> is false, the EF will continue as normal.
/// If <see cref="InterceptionResult{Object}.HasResult" /> is true, then EF will suppress the operation it
/// was about to perform and use <see cref="InterceptionResult{Object}.Result" /> instead.
/// A normal implementation of this method for any interceptor that is not attempting to change the result
/// An implementation of this method for any interceptor that is not attempting to change the result
/// is to return the <paramref name="result" /> value passed in, often using <see cref="Task.FromResult{TResult}" />
/// </returns>
/// <exception cref="OperationCanceledException">If the <see cref="CancellationToken" /> is canceled.</exception>
Expand All @@ -217,7 +217,7 @@ ValueTask<InterceptionResult<object>> ScalarExecutingAsync(
/// If <see cref="InterceptionResult{Int32}.HasResult" /> is false, the EF will continue as normal.
/// If <see cref="InterceptionResult{Int32}.HasResult" /> is true, then EF will suppress the operation it
/// was about to perform and use <see cref="InterceptionResult{Int32}.Result" /> instead.
/// A normal implementation of this method for any interceptor that is not attempting to change the result
/// An implementation of this method for any interceptor that is not attempting to change the result
/// is to return the <paramref name="result" /> value passed in, often using <see cref="Task.FromResult{TResult}" />
/// </returns>
/// <exception cref="OperationCanceledException">If the <see cref="CancellationToken" /> is canceled.</exception>
Expand All @@ -243,7 +243,7 @@ ValueTask<InterceptionResult<int>> NonQueryExecutingAsync(
/// </param>
/// <returns>
/// The result that EF will use.
/// A normal implementation of this method for any interceptor that is not attempting to change the result
/// An implementation of this method for any interceptor that is not attempting to change the result
/// is to return the <paramref name="result" /> value passed in.
/// </returns>
DbDataReader ReaderExecuted(DbCommand command, CommandExecutedEventData eventData, DbDataReader result)
Expand All @@ -264,7 +264,7 @@ DbDataReader ReaderExecuted(DbCommand command, CommandExecutedEventData eventDat
/// </param>
/// <returns>
/// The result that EF will use.
/// A normal implementation of this method for any interceptor that is not attempting to change the result
/// An implementation of this method for any interceptor that is not attempting to change the result
/// is to return the <paramref name="result" /> value passed in.
/// </returns>
object? ScalarExecuted(DbCommand command, CommandExecutedEventData eventData, object? result)
Expand All @@ -285,7 +285,7 @@ DbDataReader ReaderExecuted(DbCommand command, CommandExecutedEventData eventDat
/// </param>
/// <returns>
/// The result that EF will use.
/// A normal implementation of this method for any interceptor that is not attempting to change the result
/// An implementation of this method for any interceptor that is not attempting to change the result
/// is to return the <paramref name="result" /> value passed in.
/// </returns>
int NonQueryExecuted(DbCommand command, CommandExecutedEventData eventData, int result)
Expand All @@ -307,7 +307,7 @@ int NonQueryExecuted(DbCommand command, CommandExecutedEventData eventData, int
/// <param name="cancellationToken">A <see cref="CancellationToken" /> to observe while waiting for the task to complete.</param>
/// <returns>
/// A <see cref="Task" /> providing the result that EF will use.
/// A normal implementation of this method for any interceptor that is not attempting to change the result
/// An implementation of this method for any interceptor that is not attempting to change the result
/// is to return the <paramref name="result" /> value passed in, often using <see cref="Task.FromResult{TResult}" />
/// </returns>
/// <exception cref="OperationCanceledException">If the <see cref="CancellationToken" /> is canceled.</exception>
Expand All @@ -334,7 +334,7 @@ ValueTask<DbDataReader> ReaderExecutedAsync(
/// <param name="cancellationToken">A <see cref="CancellationToken" /> to observe while waiting for the task to complete.</param>
/// <returns>
/// A <see cref="Task" /> providing the result that EF will use.
/// A normal implementation of this method for any interceptor that is not attempting to change the result
/// An implementation of this method for any interceptor that is not attempting to change the result
/// is to return the <paramref name="result" /> value passed in, often using <see cref="Task.FromResult{TResult}" />
/// </returns>
/// <exception cref="OperationCanceledException">If the <see cref="CancellationToken" /> is canceled.</exception>
Expand All @@ -361,7 +361,7 @@ ValueTask<DbDataReader> ReaderExecutedAsync(
/// <param name="cancellationToken">A <see cref="CancellationToken" /> to observe while waiting for the task to complete.</param>
/// <returns>
/// A <see cref="Task" /> providing the result that EF will use.
/// A normal implementation of this method for any interceptor that is not attempting to change the result
/// An implementation of this method for any interceptor that is not attempting to change the result
/// is to return the <paramref name="result" /> value passed in, often using <see cref="Task.FromResult{TResult}" />
/// </returns>
/// <exception cref="OperationCanceledException">If the <see cref="CancellationToken" /> is canceled.</exception>
Expand Down Expand Up @@ -427,7 +427,7 @@ Task CommandFailedAsync(DbCommand command, CommandErrorEventData eventData, Canc
/// If <see cref="InterceptionResult.IsSuppressed" /> is false, the EF will continue as normal.
/// If <see cref="InterceptionResult.IsSuppressed" /> is true, then EF will suppress the operation
/// it was about to perform.
/// A normal implementation of this method for any interceptor that is not attempting to suppress
/// An implementation of this method for any interceptor that is not attempting to suppress
/// the operation is to return the <paramref name="result" /> value passed in.
/// </returns>
InterceptionResult DataReaderDisposing(DbCommand command, DataReaderDisposingEventData eventData, InterceptionResult result)
Expand Down
14 changes: 7 additions & 7 deletions src/EFCore.Relational/Diagnostics/IDbConnectionInterceptor.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ InterceptionResult<DbConnection> ConnectionCreating(ConnectionCreatingEventData
/// </param>
/// <returns>
/// The result that EF will use.
/// A normal implementation of this method for any interceptor that is not attempting to change the result
/// An implementation of this method for any interceptor that is not attempting to change the result
/// is to return the <paramref name="result" /> value passed in.
/// </returns>
DbConnection ConnectionCreated(ConnectionCreatedEventData eventData, DbConnection result)
Expand All @@ -84,7 +84,7 @@ DbConnection ConnectionCreated(ConnectionCreatedEventData eventData, DbConnectio
/// If <see cref="InterceptionResult.IsSuppressed" /> is false, the EF will continue as normal.
/// If <see cref="InterceptionResult.IsSuppressed" /> is true, then EF will suppress the operation
/// it was about to perform.
/// A normal implementation of this method for any interceptor that is not attempting to suppress
/// An implementation of this method for any interceptor that is not attempting to suppress
/// the operation is to return the <paramref name="result" /> value passed in.
/// </returns>
InterceptionResult ConnectionOpening(DbConnection connection, ConnectionEventData eventData, InterceptionResult result)
Expand All @@ -106,7 +106,7 @@ InterceptionResult ConnectionOpening(DbConnection connection, ConnectionEventDat
/// If <see cref="InterceptionResult.IsSuppressed" /> is false, the EF will continue as normal.
/// If <see cref="InterceptionResult.IsSuppressed" /> is true, then EF will suppress the operation
/// it was about to perform.
/// A normal implementation of this method for any interceptor that is not attempting to suppress
/// An implementation of this method for any interceptor that is not attempting to suppress
/// the operation is to return the <paramref name="result" /> value passed in.
/// </returns>
/// <exception cref="OperationCanceledException">If the <see cref="CancellationToken" /> is canceled.</exception>
Expand Down Expand Up @@ -152,7 +152,7 @@ Task ConnectionOpenedAsync(DbConnection connection, ConnectionEndEventData event
/// If <see cref="InterceptionResult.IsSuppressed" /> is false, the EF will continue as normal.
/// If <see cref="InterceptionResult.IsSuppressed" /> is true, then EF will suppress the operation
/// it was about to perform.
/// A normal implementation of this method for any interceptor that is not attempting to suppress
/// An implementation of this method for any interceptor that is not attempting to suppress
/// the operation is to return the <paramref name="result" /> value passed in.
/// </returns>
InterceptionResult ConnectionClosing(DbConnection connection, ConnectionEventData eventData, InterceptionResult result)
Expand All @@ -173,7 +173,7 @@ InterceptionResult ConnectionClosing(DbConnection connection, ConnectionEventDat
/// If <see cref="InterceptionResult.IsSuppressed" /> is false, the EF will continue as normal.
/// If <see cref="InterceptionResult.IsSuppressed" /> is true, then EF will suppress the operation
/// it was about to perform.
/// A normal implementation of this method for any interceptor that is not attempting to suppress
/// An implementation of this method for any interceptor that is not attempting to suppress
/// the operation is to return the <paramref name="result" /> value passed in.
/// </returns>
ValueTask<InterceptionResult> ConnectionClosingAsync(DbConnection connection, ConnectionEventData eventData, InterceptionResult result)
Expand Down Expand Up @@ -212,7 +212,7 @@ Task ConnectionClosedAsync(DbConnection connection, ConnectionEndEventData event
/// If <see cref="InterceptionResult.IsSuppressed" /> is <see langword="false" />, the EF will continue as normal.
/// If <see cref="InterceptionResult.IsSuppressed" /> is <see langword="true" />, then EF will suppress the operation
/// it was about to perform.
/// A normal implementation of this method for any interceptor that is not attempting to suppress
/// An implementation of this method for any interceptor that is not attempting to suppress
/// the operation is to return the <paramref name="result" /> value passed in.
/// </returns>
InterceptionResult ConnectionDisposing(DbConnection connection, ConnectionEventData eventData, InterceptionResult result)
Expand All @@ -233,7 +233,7 @@ InterceptionResult ConnectionDisposing(DbConnection connection, ConnectionEventD
/// If <see cref="InterceptionResult.IsSuppressed" /> is false, the EF will continue as normal.
/// If <see cref="InterceptionResult.IsSuppressed" /> is true, then EF will suppress the operation
/// it was about to perform.
/// A normal implementation of this method for any interceptor that is not attempting to suppress
/// An implementation of this method for any interceptor that is not attempting to suppress
/// the operation is to return the <paramref name="result" /> value passed in.
/// </returns>
ValueTask<InterceptionResult> ConnectionDisposingAsync(DbConnection connection, ConnectionEventData eventData, InterceptionResult result)
Expand Down
Loading

0 comments on commit 6e67b4a

Please sign in to comment.