Skip to content

Commit

Permalink
[event-hubs] Update docs to mention the checkpoint store updates made…
Browse files Browse the repository at this point in the history
… when the subscription is closed. (#11345)

As part of investigating #11316 we found it was non-obvious that we would be using the checkpoint store when closing. 

The reason we use it is when we close the subscription we also mark, in the checkpoint store, that the partitions are abandoned. This lets other consumers more quickly pick up abandoned partitions rather than forcing them to wait for an expiration interval and discover it.

Fixes #11316
  • Loading branch information
richardpark-msft committed Sep 18, 2020
1 parent b8e3ac2 commit b750841
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions sdk/eventhub/event-hubs/src/eventHubConsumerClientModels.ts
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,10 @@ export interface SubscribeOptions {
export interface Subscription {
/**
* Stops the subscription from receiving more messages.
*
* If a checkpoint store has been configured this will also mark this subscription's
* partitions as abandoned, freeing them up to be read by other consumers.
*
* @returns Promise<void>
* @throws Error if the underlying connection encounters an error while closing.
*/
Expand Down

0 comments on commit b750841

Please sign in to comment.