Skip to content

Update IExceptionHandler.cs #49040

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 27, 2023
Merged

Update IExceptionHandler.cs #49040

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4c04702
Update IExceptionHandler.cs
JamesNK Jun 26, 2023
9e347db
Update IExceptionHandler.cs
JamesNK Jun 26, 2023
a2818d3
Update IExceptionHandler.cs
JamesNK Jun 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions src/Middleware/Diagnostics/src/ExceptionHandler/IExceptionHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ public interface IExceptionHandler
{
/// <summary>
/// Tries to handle the specified exception asynchronously within the ASP.NET Core pipeline.
/// Implementations of this method can provide custom exception handling logic for different scenarios.
/// Implementations of this method can provide custom exception-handling logic for different scenarios.
/// </summary>
/// <param name="httpContext"></param>
/// <param name="exception"></param>
/// <param name="cancellationToken"></param>
/// <param name="httpContext">The <see cref="HttpContext"/> for the request.</param>
/// <param name="exception">The unhandled exception.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>
/// A <see cref="ValueTask{TResult}"/> representing the asynchronous handling operation indicating
/// <see langword="true"/> if the exception was
/// handled successfully; otherwise <see langword="false"/>.
/// A task that represents the asynchronous read operation. The value of its <see cref="P:System.Threading.Tasks.ValueTask`1.Result" />
/// property contains the result of the handling operation.
/// <see langword="true"/> if the exception was handled successfully; otherwise <see langword="false"/>.
/// </returns>
ValueTask<bool> TryHandleAsync(HttpContext httpContext, Exception exception, CancellationToken cancellationToken);
}