Click or drag to resize
SucceededState Class
Defines the final state of a background job when a Worker performed an enqueued job without any exception thrown during the performance.
Inheritance Hierarchy

Namespace: Hangfire.States
Assembly: Hangfire.Core (in Hangfire.Core.dll) Version:
public class SucceededState : IState

The SucceededState type exposes the following members.

Public propertyIgnoreJobLoadException
Gets whether transition to this state should ignore job de-serialization exceptions.
Public propertyIsFinal
Gets if the current state is a final one.
Public propertyLatency
Gets the total number of milliseconds passed from a job creation time till the start of the performance.
Public propertyName
Gets the unique name of the state.
Public propertyPerformanceDuration
Gets the total milliseconds elapsed from a processing start.
Public propertyReason
Gets the human-readable reason of a state transition.
Public propertyResult
Gets the value returned by a job method.
Public propertySucceededAt
Gets a date/time when the current state instance was created.
Public methodSerializeData
Gets a serialized representation of the current state.
Public fieldStatic memberStateName
Represents the name of the Succeeded state. This field is read-only.

All the transitions to the Succeeded state are internal for the Worker background process. You can't create background jobs using this state, and can't change state to Succeeded.

This state is used in a user code primarily in state change filters (TODO: add a link) to add custom logic during state transitions.

Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also