Skip to content
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

Clearer xmldoc on RecoverabilityActions #6674

Merged
merged 1 commit into from
Jan 25, 2023
Merged

Clearer xmldoc on RecoverabilityActions #6674

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 11 additions & 6 deletions src/NServiceBus.Core/Recoverability/RecoverabilityAction.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ protected internal RecoverabilityAction()
}

/// <summary>
/// Creates an immediate retry recoverability action.
/// Specifies that messages matching this recoverability policy will be retried immediately.
/// </summary>
/// <returns>Immediate retry action.</returns>
public static ImmediateRetry ImmediateRetry() => CachedImmediateRetry;
Expand All @@ -29,7 +29,7 @@ protected internal RecoverabilityAction()
public abstract IReadOnlyCollection<IRoutingContext> GetRoutingContexts(IRecoverabilityActionContext context);

/// <summary>
/// Creates a new delayed retry recoverability action.
/// Specifies that messages matching this recoverability policy will be retried with a specified delay.
/// </summary>
/// <param name="timeSpan">Delivery delay.</param>
/// <returns>Delayed retry action.</returns>
Expand All @@ -41,7 +41,7 @@ public static DelayedRetry DelayedRetry(TimeSpan timeSpan)
}

/// <summary>
/// Creates a move to error recoverability action.
/// Specifies that messages matching this recoverability policy will not be retried and will be routed to the error queue.
/// </summary>
/// <param name="errorQueue">The address of the error queue.</param>
/// <returns>Move to error action.</returns>
Expand All @@ -52,9 +52,14 @@ public static MoveToError MoveToError(string errorQueue)
}

/// <summary>
/// Creates a discard recoverability action.
/// Specifies that messages matching this recoverability policy will be discarded as if they had never happened.
/// The message will not be forwarded to the audit queue, which may be confusing when viewing audit data as
/// the conversation will abruptly end without any information about the reason.
/// </summary>
/// <param name="reason">The reason why the message was discarded.</param>
/// <param name="reason">
/// The reason why the message was discarded. This reason is communicated only in logs and is not transmitted
/// through audit messages to the audit queue.
/// </param>
/// <returns>Discard action.</returns>
public static Discard Discard(string reason)
{
Expand All @@ -69,4 +74,4 @@ public static Discard Discard(string reason)

static readonly ImmediateRetry CachedImmediateRetry = new ImmediateRetry();
}
}
}