Skip to content

Commit

Permalink
Doc clarifications, closes #1234
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelklishin committed Jul 22, 2022
1 parent e5e960b commit 868dfc3
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions projects/RabbitMQ.Client/client/api/IModel.cs
Original file line number Diff line number Diff line change
Expand Up @@ -415,26 +415,28 @@ void BasicPublish<TProperties>(CachedString exchange, CachedString routingKey, r
void TxSelect();

/// <summary>
/// Wait until all published messages have been confirmed.
/// Wait until all published messages on this channel have been confirmed.
/// </summary>
/// <returns>True if no nacks were received within the timeout, otherwise false.</returns>
/// <param name="token">The cancellation token.</param>
/// <remarks>
/// Waits until all messages published since the last call have
/// been either ack'd or nack'd by the broker. Returns whether
/// all the messages were ack'd (and none were nack'd). Note,
/// throws an exception when called on a non-Confirm channel.
/// Waits until all messages published on this channel since the last call have
/// been either ack'd or nack'd by the server. Returns whether
/// all the messages were ack'd (and none were nack'd).
/// Throws an exception when called on a channel
/// that does not have publisher confirms enabled.
/// </remarks>
Task<bool> WaitForConfirmsAsync(CancellationToken token = default);

/// <summary>
/// Wait until all published messages have been confirmed.
/// Wait until all published messages on this channel have been confirmed.
/// </summary>
/// <param name="token">The cancellation token.</param>
/// <remarks>
/// Waits until all messages published since the last call have
/// been ack'd by the broker. If a nack is received or the timeout
/// elapses, throws an IOException exception immediately.
/// Waits until all messages published on this channel since the last call have
/// been ack'd by the server. If a nack is received or the timeout
/// elapses, throws an IOException exception immediately and closes
/// the channel.
/// </remarks>
Task WaitForConfirmsOrDieAsync(CancellationToken token = default);

Expand Down

0 comments on commit 868dfc3

Please sign in to comment.