ConsumeDurableJobsAsync
public IAsyncEnumerable<IJobRunContext> ConsumeDurableJobsAsync() Consumes durable jobs from this shard in order of their due time.
Returns
An asynchronous enumerable of durable job contexts.
JobShard Methods
Base implementation of
IJobShard that provides common functionality for job shard implementations. DisposeAsync
virtual
public virtual ValueTask DisposeAsync() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.
Returns
A task that represents the asynchronous dispose operation.
EnqueueJob(DurableJob, int)
protected void EnqueueJob(DurableJob job, int dequeueCount) Enqueues a job into the in-memory queue with the specified dequeue count.
Parameters
jobDurableJob- The job to enqueue.
dequeueCountint- The number of times this job has been dequeued.
GetJobCountAsync
public ValueTask<int> GetJobCountAsync() Gets the number of jobs currently scheduled in this shard.
Returns
A task that represents the asynchronous operation. The task result contains the job count.
MarkAsCompleteAsync(CancellationToken)
public Task MarkAsCompleteAsync(CancellationToken cancellationToken) Marks this shard as complete, preventing new jobs from being scheduled.
Parameters
cancellationTokenCancellationToken- A token to cancel the operation.
Returns
A task that represents the asynchronous operation.
PersistAddJobAsync(DurableJob, CancellationToken)
abstract
protected abstract Task PersistAddJobAsync(DurableJob job, CancellationToken cancellationToken) Persists the addition of a new job to the underlying storage.
Parameters
jobDurableJob- The job to persist.
cancellationTokenCancellationToken- A token to cancel the operation.
Returns
A task that represents the asynchronous operation.
PersistRemoveJobAsync(string, CancellationToken)
abstract
protected abstract Task PersistRemoveJobAsync(string jobId, CancellationToken cancellationToken) Persists the removal of a job from the underlying storage.
Parameters
jobIdstring- The unique identifier of the job to remove.
cancellationTokenCancellationToken- A token to cancel the operation.
Returns
A task that represents the asynchronous operation.
PersistRetryJobAsync(IJobRunContext, DateTimeOffset, CancellationToken)
abstract
protected abstract Task PersistRetryJobAsync(IJobRunContext jobContext, DateTimeOffset newDueTime, CancellationToken cancellationToken) Persists the rescheduling of a job to the underlying storage.
Parameters
jobContextIJobRunContext- The execution context of the job to retry.
newDueTimeDateTimeOffset- The new due time for the job. This value supersedes
DurableJobonIJobRunContext. cancellationTokenCancellationToken- A token to cancel the operation.
Returns
A task that represents the asynchronous operation.
RemoveJobAsync(string, CancellationToken)
public Task<DurableJobMutationResult> RemoveJobAsync(string jobId, CancellationToken cancellationToken) Removes a durable job from this shard.
Parameters
jobIdstring- The unique identifier of the job to remove.
cancellationTokenCancellationToken- A token to cancel the operation.
Returns
A task containing the durable mutation outcome.
RescheduleJobAsync(IJobRunContext, DateTimeOffset, CancellationToken)
public Task<DurableJobMutationResult> RescheduleJobAsync(IJobRunContext jobContext, DateTimeOffset newDueTime, CancellationToken cancellationToken) Reschedules a successfully completed execution with its dequeue count reset.
Parameters
jobContextIJobRunContext- The context of the completed execution.
newDueTimeDateTimeOffset- The new due time for the job. This value supersedes
DurableJobonIJobRunContext. cancellationTokenCancellationToken- A token to cancel the operation.
Returns
A task containing the durable mutation outcome.
RetryJobLaterAsync(IJobRunContext, DateTimeOffset, CancellationToken)
public Task<DurableJobMutationResult> RetryJobLaterAsync(IJobRunContext jobContext, DateTimeOffset newDueTime, CancellationToken cancellationToken) Reschedules a job to be retried at a later time.
Parameters
jobContextIJobRunContext- The context of the job to retry.
newDueTimeDateTimeOffset- The new due time for the job. This value supersedes
DurableJobonIJobRunContext. cancellationTokenCancellationToken- A token to cancel the operation.
Returns
A task containing the durable mutation outcome.
TryScheduleJobAsync(ScheduleJobRequest, CancellationToken)
public Task<DurableJob?> TryScheduleJobAsync(ScheduleJobRequest request, CancellationToken cancellationToken) Attempts to schedule a new job on this shard.
Parameters
requestScheduleJobRequest- The request containing the job scheduling parameters.
cancellationTokenCancellationToken- A token to cancel the operation.
Returns
A task that represents the asynchronous operation. The task result contains the durable job if successful, or null if the job could not be scheduled (e.g., the shard was marked as complete).
Exceptions
System.ArgumentOutOfRangeException- Thrown when the due time is outside the shard's time range.
TryStartAttemptAsync(IJobRunContext, CancellationToken)
public Task<DurableJobMutationResult> TryStartAttemptAsync(IJobRunContext jobContext, CancellationToken cancellationToken) Attempts to reserve a dequeued durable job for execution.
Parameters
jobContextIJobRunContext- The dequeued job context.
cancellationTokenCancellationToken- A token to cancel the operation.
Returns
A task containing
DurableJobMutationResult when the attempt may start, DurableJobMutationResult when cancellation or completion removed the job first, or DurableJobMutationResult when this shard is no longer locally owned.