JobShard

1. Documentation
2. API reference
3. Microsoft.Orleans.DurableJobs
4. JobShard

class

Namespace: Orleans.DurableJobs

NuGetSourceMarkdown

Base implementation of IJobShard that provides common functionality for job shard implementations.

public abstract class JobShard : IJobShard, IAsyncDisposable

Constructors

• JobShard(string, DateTimeOffset, DateTimeOffset) Initializes a new instance of the JobShard class.

Properties

• EndTime Gets the end time of the time range managed by this shard.
• Id Gets the unique identifier for this job shard.
• IsAddingCompleted Gets a value indicating whether this shard has been marked as complete and is no longer accepting new jobs.
• Metadata Gets optional metadata associated with this job shard.
• StartTime Gets the start time of the time range managed by this shard.

Methods

• ConsumeDurableJobsAsync Consumes durable jobs from this shard in order of their due time.
• DisposeAsync Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.
• EnqueueJob(DurableJob, int) Enqueues a job into the in-memory queue with the specified dequeue count.
• GetJobCountAsync Gets the number of jobs currently scheduled in this shard.
• MarkAsCompleteAsync(CancellationToken) Marks this shard as complete, preventing new jobs from being scheduled.
• PersistAddJobAsync(DurableJob, CancellationToken) Persists the addition of a new job to the underlying storage.
• PersistRemoveJobAsync(string, CancellationToken) Persists the removal of a job from the underlying storage.
• PersistRetryJobAsync(IJobRunContext, DateTimeOffset, CancellationToken) Persists the rescheduling of a job to the underlying storage.
• RemoveJobAsync(string, CancellationToken) Removes a durable job from this shard.
• RetryJobLaterAsync(IJobRunContext, DateTimeOffset, CancellationToken) Reschedules a job to be retried at a later time.
• TryScheduleJobAsync(ScheduleJobRequest, CancellationToken) Attempts to schedule a new job on this shard.