 | Hangfire.States Namespace |
The Hangfire.States namespace contains types that describe
background job states and the transitions between them. You can implement
custom IElectStateFilter or IApplyStateFilter
to customize the state changing pipeline, or define your own state by
implementing the IState interface.
Classes| Class | Description | |
|---|---|---|
 | ApplyStateContext | |
| AwaitingState |
Defines the intermediate state of a background job when it is waiting
for a parent background job to be finished before it is moved to the
EnqueuedState by the ContinuationsSupportAttribute
filter.
|
| BackgroundJobStateChanger | |
 | DeletedState |
Defines the final state of a background job when nobody
is interested whether it was performed or not.
|
| ElectStateContext | |
| EnqueuedState |
Defines the intermediate state of a background job when it is placed
on a message queue to be processed by the Worker
background process as soon as possible.
|
| FailedState |
Defines the intermediate state of a background job when its processing
was interrupted by an exception and it is a developer's responsibility
to decide what to do with it next.
|
| ProcessingState |
Defines the intermediate state of a background job when a
Worker has started to process it.
|
| ScheduledState |
Defines the intermediate state of a background job when it is placed
on a schedule to be moved to the EnqueuedState in the future
by DelayedJobScheduler background process.
|
| StateChangeContext | |
| StateHandlerCollection | |
| StateMachine | |
| SucceededState |
Defines the final state of a background job when a Worker
performed an enqueued job without any exception thrown during the performance.
|
Interfaces| Interface | Description | |
|---|---|---|
 | IApplyStateFilter |
Provides methods that are required for a state changed filter.
|
| IBackgroundJobStateChanger | |
| IElectStateFilter |
Defines methods that are required for a state changing filter.
|
| IState |
Provides the essential members for describing a background job state.
|
| IStateHandler |
Provides a mechanism for performing custom actions when applying or
unapplying the state of a background job by StateMachine.
|
| IStateMachine |
Provides a mechanism for running state election and state applying processes.
|