Subscription worker generation is accessible through the DocumentStore's Subscriptions Property, of type DocumentSubscriptions:
SubscriptionWorker<dynamic> GetSubscriptionWorker(string subscriptionName, string database = null);
SubscriptionWorker<dynamic> GetSubscriptionWorker(SubscriptionWorkerOptions options, string database = null);
SubscriptionWorker<T> GetSubscriptionWorker<T>(string subscriptionName, string database = null) where T : class;
SubscriptionWorker<T> GetSubscriptionWorker<T>(SubscriptionWorkerOptions options, string database = null) where T : class;
The subscription's name. This parameter appears in more simple overloads allowing to start processing without creating a SubscriptionCreationOptions instance, relying on the default values
Contains subscription worker, affecting the interaction of the specific worker with the subscription, but does not affect the subscription's definition
Name of the database to look for the data subscription. If null, the default database configured in DocumentStore will be used.
A created data subscription worker. When returned, the worker is Idle and it will start working only when the Run function is called.
The only mandatory parameter for SubscriptionWorkerOptions creation is the subscription's name.
Returns the subscription name passed to the constructor. This name will be used by the server side to identify the subscription in question.
Time to wait before reconnecting, in the case of non-aborting failure during the subscription processing. Default: 5 seconds.
If true, will not abort subscription processing if client code, passed to the Run function, throws an unhandled exception. Default: false.
Sets the way the server will treat current and/or other clients when they will try to connect. See Workers interplay. Default: OpenIfFree.
Maximum amount of documents that the server will try sending in a batch. If the server will not find "enough" documents, it won't wait and send the amount it found. Default: 4096.
If true, it performs an "ad-hoc" operation that processes all possible documents, until the server can't find any new documents to send. At that moment, the task returned by the Run function will fail and throw a SubscriptionClosedException exception. Default: false.
The size in bytes of the TCP socket buffer used for sending data. Default: 32,768 (32 KiB)
The size in bytes of the TCP socket buffer used for receiving data. Default: 32,768 (32 KiB)
Running subscription worker
After generating a subscription worker, the subscription worker is still not processing any documents. SubscriptionWorker's Run function allows you to start processing worker operations.
The Run function receives the client-side code as a delegate that will process the received batches:
Cancellation token used in order to halt the worker operation
Task that is alive as long as the subscription worker is processing or tries processing. If the processing is aborted, the task exits with an exception
Batch's items list.
Amount of items in the batch.
New document session, that tracks all items and included items of the current batch.
New asynchronous document session, that tracks all items and included items of the current batch.
Subscription Worker Connectivity
As long as there is no exception, the worker will continue addressing the same
server that the first batch was received from.
If the worker fails to reach that node, it will try to
failover to another node
from the session's topology list.
The node that the worker succeeded connecting to, will inform the worker which
node is currently responsible for data subscriptions.
if T is BlittableJsonReaderObject, no deserialization will take place
Current batch item.
Message of the exception thrown during current document processing in the server side.
Current batch item's underlying document ID.
Current batch item's underlying document change vector of the current document.
Current batch item before serialization to T.
Current batch item's underlying document metadata.
Current batch item's underlying metadata values.
Usage of RawResult, RawMetadata, and Metadata values outside of the document processing delegate are not supported
Aborts subscription worker operation ungracefully by waiting for the task returned by the Run function to finish running.
Async version of Dispose().
Aborts the subscription worker, but allows deciding whether to wait for the Run function task or not.
Async version of DisposeAsync(bool waitForSubscriptionTask).
Run (multiple overloads)
Starts the subscription worker work of processing batches, receiving the batch processing delegates (see above).
Event that is risen after each time the server acknowledges batch processing progress.
Event that is fired when the subscription worker tries to reconnect to the server after a failure. The event receives as a parameter the exception that interrupted the processing.
Event that is fired after the subscription worker was disposed.
The batch process which was acknowledged
Task for which the worker will wait for the event processing to be finished (for async functions, etc.)
Returns current processing RavenDB server's node tag.