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

Remove mention of autoAck #489

Merged
merged 1 commit into from
Apr 2, 2022
Merged

Remove mention of autoAck #489

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
80 changes: 40 additions & 40 deletions docs/clients/grpc/persistent-subscriptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ The first step of dealing with a subscription group is to create one. You will r

@[code{create-persistent-subscription-to-stream}](@grpc:persistent-subscriptions/Program.cs;persistentSubscriptions.go;persistent_subscriptions/PersistentSubscriptions.java;persistent-subscriptions.js;persistent_subscriptions.rs;persistent-subscriptions.ts)

| Parameter | Description |
| Parameter | Description |
|:--------------|:----------------------------------------------------|
| `stream` | The stream the persistent subscription is on. |
| `groupName` | The name of the subscription group to create. |
| `settings` | The settings to use when creating the subscription. |
| `credentials` | The user credentials to use for this operation. |
| `stream` | The stream the persistent subscription is on. |
| `groupName` | The name of the subscription group to create. |
| `settings` | The settings to use when creating the subscription. |
| `credentials` | The user credentials to use for this operation. |

## Connecting to a subscription group

Expand All @@ -21,15 +21,15 @@ The most important parameter to pass when connecting is the buffer size. This re

@[code{subscribe-to-persistent-subscription-to-stream}](@grpc:persistent-subscriptions/Program.cs;persistentSubscriptions.go;persistent_subscriptions/PersistentSubscriptions.java;persistent-subscriptions.js;persistent_subscriptions.rs;persistent-subscriptions.ts)

| Parameter | Description |
| Parameter | Description |
|:----------------------|:---------------------------------------------------------------------------------------------|
| `stream` | The stream the persistent subscription is on. |
| `groupName` | The name of the subscription group to subscribe to. |
| `eventAppeared` | The action to call when an event arrives over the subscription. |
| `subscriptionDropped` | The action to call if the subscription is dropped. |
| `credentials` | The user credentials to use for this operation. |
| `stream` | The stream the persistent subscription is on. |
| `groupName` | The name of the subscription group to subscribe to. |
| `eventAppeared` | The action to call when an event arrives over the subscription. |
| `subscriptionDropped` | The action to call if the subscription is dropped. |
| `credentials` | The user credentials to use for this operation. |
| `bufferSize` | The number of in-flight messages this client is allowed. **Default: 10** |
| `autoAck` | Whether to automatically acknowledge messages after eventAppeared returns. **Default: true** |
| `autoAck` | Whether to automatically acknowledge messages after eventAppeared returns. **Default: true** |

## Subscribing to $all

Expand Down Expand Up @@ -89,20 +89,20 @@ And then subscribing to it is done in much the same way:

## Acknowledgements

Clients must acknowledge (or not acknowledge) messages in the competing consumer model. If you enable auto-ack the subscription will automatically acknowledge messages once your handler completes them. If an error occurs, it will shut down your subscription with a message and the error.
Clients must acknowledge (or not acknowledge) messages in the competing consumer model.

You can choose to not auto-ack messages. This can be useful when you have multi-threaded processing of messages in your subscriber and need to pass control to something else. If you want to manually acknowledge events, you need to set this option when subscribing and then acknowledge or not acknowledge messages as you handle them.
If processing is successful, you must send an Ack (Acknowledge) to the server to let it know that the message has been handled. If processing fails for some reason, then you can Nack (Not Acknowledge) the message and tell the server how to handle the failure.

@[code{subscribe-to-persistent-subscription-with-manual-acks}](@grpc:persistent-subscriptions/Program.cs;persistentSubscriptions.go;persistent_subscriptions/PersistentSubscriptions.java;persistent-subscriptions.js;persistent_subscriptions.rs;persistent-subscriptions.ts)

The Nak Actions describe what the server should do with the message:

| Action | Description |
| Action | Description |
|:----------|:---------------------------------------------------------------------|
| `Unknown` | The client does not know what action to take. Let the server decide. |
| `Park` | Park the message and do not resend. Put it on poison queue. |
| `Retry` | Explicitly retry the message. |
| `Skip` | Skip this message do not resend and do not put in poison queue. |
| `Park` | Park the message and do not resend. Put it on poison queue. |
| `Retry` | Explicitly retry the message. |
| `Skip` | Skip this message do not resend and do not put in poison queue. |

## Consumer strategies

Expand Down Expand Up @@ -134,43 +134,43 @@ You can edit the settings of an existing subscription group while it is running,

@[code{update-persistent-subscription}](@grpc:persistent-subscriptions/Program.cs;persistentSubscriptions.go;persistent_subscriptions/PersistentSubscriptions.java;persistent-subscriptions.js;persistent_subscriptions.rs;persistent-subscriptions.ts)

| Parameter | Description |
| Parameter | Description |
|:--------------|:----------------------------------------------------|
| `stream` | The stream the persistent subscription is on. |
| `groupName` | The name of the subscription group to update. |
| `settings` | The settings to use when creating the subscription. |
| `credentials` | The user credentials to use for this operation. |
| `stream` | The stream the persistent subscription is on. |
| `groupName` | The name of the subscription group to update. |
| `settings` | The settings to use when creating the subscription. |
| `credentials` | The user credentials to use for this operation. |

## Persistent subscription settings

Both the `Create` and `Update` methods take some settings for configuring the persistent subscription.

The following table shows the configuration options you can set on a persistent subscription.

| Option | Description | Default |
| Option | Description | Default |
|:------------------------|:----------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------|
| `ResolveLinkTos` | Whether the subscription should resolve link events to their linked events. | `false` |
| `StartFrom` | The exclusive position in the stream or transaction file the subscription should start from. | `null` (start from the end of the stream) |
| `ExtraStatistics` | Whether to track latency statistics on this subscription. | `false` |
| `MessageTimeout` | The amount of time after which to consider a message as timed out and retried. | `30` (seconds) |
| `MaxRetryCount` | The maximum number of retries (due to timeout) before a message is considered to be parked. | `10` |
| `LiveBufferSize` | The size of the buffer (in-memory) listening to live messages as they happen before paging occurs. | `500` |
| `ReadBatchSize` | The number of events read at a time when paging through history. | `20` |
| `HistoryBufferSize` | The number of events to cache when paging through history. | `500` |
| `CheckPointAfter` | The amount of time to try to checkpoint after. | `2` seconds |
| `MinCheckPointCount` | The minimum number of messages to process before a checkpoint may be written. | `10` |
| `MaxCheckPointCount` | The maximum number of messages not checkpointed before forcing a checkpoint. | `1000` |
| `MaxSubscriberCount` | The maximum number of subscribers allowed. | `0` (unbounded) |
| `NamedConsumerStrategy` | The strategy to use for distributing events to client consumers. See the [consumer strategies](#consumer-strategies) in this doc. | `RoundRobin` |
| `ResolveLinkTos` | Whether the subscription should resolve link events to their linked events. | `false` |
| `StartFrom` | The exclusive position in the stream or transaction file the subscription should start from. | `null` (start from the end of the stream) |
| `ExtraStatistics` | Whether to track latency statistics on this subscription. | `false` |
| `MessageTimeout` | The amount of time after which to consider a message as timed out and retried. | `30` (seconds) |
| `MaxRetryCount` | The maximum number of retries (due to timeout) before a message is considered to be parked. | `10` |
| `LiveBufferSize` | The size of the buffer (in-memory) listening to live messages as they happen before paging occurs. | `500` |
| `ReadBatchSize` | The number of events read at a time when paging through history. | `20` |
| `HistoryBufferSize` | The number of events to cache when paging through history. | `500` |
| `CheckPointAfter` | The amount of time to try to checkpoint after. | `2` seconds |
| `MinCheckPointCount` | The minimum number of messages to process before a checkpoint may be written. | `10` |
| `MaxCheckPointCount` | The maximum number of messages not checkpointed before forcing a checkpoint. | `1000` |
| `MaxSubscriberCount` | The maximum number of subscribers allowed. | `0` (unbounded) |
| `NamedConsumerStrategy` | The strategy to use for distributing events to client consumers. See the [consumer strategies](#consumer-strategies) in this doc. | `RoundRobin` |

## Deleting a subscription group

Remove a subscription group with the delete operation. Like the creation of groups, you rarely do this in your runtime code and is undertaken by an administrator running a script.

@[code{delete-persistent-subscription}](@grpc:persistent-subscriptions/Program.cs;persistentSubscriptions.go;persistent_subscriptions/PersistentSubscriptions.java;persistent-subscriptions.js;persistent_subscriptions.rs;persistent-subscriptions.ts)

| Parameter | Description |
| Parameter | Description |
|:--------------|:-----------------------------------------------|
| `stream` | The stream the persistent subscription is on. |
| `groupName` | The name of the subscription group to delete. |
| `stream` | The stream the persistent subscription is on. |
| `groupName` | The name of the subscription group to delete. |
| `credentials` | The user credentials to use for this operation |