types

package

Go to main page

Versions in this module

v0

v0.2.2

Mar 16, 2026

Changes in this version

+ var ErrEffectPending = errors.New("dureq: operation effect is pending (claimed by another worker)")

+ func GetOperationKey(ctx context.Context) string

+ func WithOperationEffectStore(ctx context.Context, s OperationEffectStore) context.Context

+ func WithOperationKey(ctx context.Context, key string) context.Context

+ type OperationEffectStore interface

+ ClaimOperationEffect func(ctx context.Context, opKey, stepKey string, ttlSeconds int) (string, bool, error)

+ CompleteOperationEffect func(ctx context.Context, opKey, stepKey string, result string) (bool, error)

+ func GetOperationEffectStore(ctx context.Context) OperationEffectStore

type WorkMessage

+ OperationKey string

type WorkflowTaskState

+ Iteration int

v0.2.1

Mar 13, 2026

Changes in this version

type ScheduleEntry

+ LastFiringID string

type WorkMessage

+ FiringID string

v0.2.0

Mar 13, 2026

Changes in this version

+ var ErrSignalDuplicate = errors.New("dureq: duplicate signal (dedup key already exists)")

+ var ErrWorkflowTerminal = errors.New("dureq: workflow is in terminal state, cannot receive signals")

+ func GetSideEffectTTL(ctx context.Context) int

+ func ValidWorkflowTransition(from, to WorkflowStatus) bool

+ func WithSideEffectStore(ctx context.Context, s SideEffectStore) context.Context

+ func WithSideEffectTTL(ctx context.Context, seconds int) context.Context

+ type ConcurrencyKey struct

+ Key string

+ MaxConcurrency int

+ type ContinueAsNewError struct

+ Input json.RawMessage

+ func (e *ContinueAsNewError) Error() string

type ErrorClassification

+ const ErrorClassContinueAsNew

type Job

+ ConcurrencyKeys []ConcurrencyKey

type JobStatus

+ func (s JobStatus) IsRetryable() bool

+ type ResultReusePolicy string

+ const ResultReuseAlways

+ const ResultReuseNever

+ const ResultReuseOnSuccess

+ type SideEffectStore interface

+ ClaimSideEffect func(ctx context.Context, runID, stepKey string, ttlSeconds int) (string, bool, error)

+ CompleteSideEffect func(ctx context.Context, runID, stepKey string, result string) error

+ func GetSideEffectStore(ctx context.Context) SideEffectStore

+ type SignalOption func(*WorkflowSignal)

+ func WithDedupeKey(key string) SignalOption

type WorkMessage

+ ConcurrencyKeys []ConcurrencyKey

type WorkResult

+ ContinueAsNewInput json.RawMessage

type WorkflowDefinition

+ SignalTimeout *Duration

type WorkflowInstance

+ ArchivedTaskCount int

+ ContinuedFrom *string

+ ContinuedTo *string

type WorkflowSignal

+ DedupeKey string

+ StreamID string

type WorkflowStatus

+ const WorkflowStatusContinued

+ func (s WorkflowStatus) IsRetryable() bool

type WorkflowTask

+ ResultReuse ResultReusePolicy

v0.1.11

Mar 11, 2026

v0.1.10

Mar 11, 2026

Changes in this version

+ func ValidJobTransition(from, to JobStatus) bool

+ func ValidRunTransition(from, to RunStatus) bool

+ type ConditionResult struct

+ Route uint

type ErrorClassification

+ const ErrorClassPause

+ const ErrorClassRepeat

+ const ErrorClassSkip

+ func ClassifyControlFlow(err error) ErrorClassification

type EventType

+ const EventJobPaused

+ const EventJobResumed

+ const EventWorkflowHookCompleted

+ const EventWorkflowHookDispatched

+ const EventWorkflowHookFailed

+ const EventWorkflowResumed

+ const EventWorkflowSuspended

+ const EventWorkflowTaskPanicked

type HandlerFunc

+ func TypedHandlerWithUpstream[U any, T any](fn func(ctx context.Context, upstream U, original T) error) HandlerFunc

+ func TypedHandler[T any](fn func(ctx context.Context, payload T) error) HandlerFunc

type HandlerFuncWithResult

+ func TypedConditionHandler[T any](fn func(ctx context.Context, payload T) (uint, error)) HandlerFuncWithResult

+ func TypedHandlerWithResult[T any, R any](fn func(ctx context.Context, payload T) (R, error)) HandlerFuncWithResult

+ func TypedHandlerWithUpstreamResult[U any, T any, R any](fn func(ctx context.Context, upstream U, original T) (R, error)) HandlerFuncWithResult

+ func TypedSubflowHandler[T any](fn func(ctx context.Context, payload T) ([]WorkflowTask, error)) HandlerFuncWithResult

+ type HookFunc func(ctx context.Context, event JobEvent)

+ type Hooks struct

+ OnBatchCompleted []HookFunc

+ OnBatchFailed []HookFunc

+ OnJobCancelled []HookFunc

+ OnJobCompleted []HookFunc

+ OnJobDead []HookFunc

+ OnJobFailed []HookFunc

+ OnJobPaused []HookFunc

+ OnJobResumed []HookFunc

+ OnWorkflowCompleted []HookFunc

+ OnWorkflowFailed []HookFunc

+ func (h *Hooks) Fire(ctx context.Context, event JobEvent)

type Job

+ ConsecutiveErrors int

+ PausedAt *time.Time

+ ResumeAt *time.Time

type JobEvent

+ WorkflowID string

type JobStatus

+ const JobStatusPaused

+ func (s JobStatus) IsPaused() bool

+ type PauseError struct

+ Reason string

+ RetryAfter time.Duration

+ func (e *PauseError) Error() string

+ type Precondition struct

+ Expected string

+ Path string

+ Task string

+ Type string

type RedisOptions

+ Username string

+ type RepeatError struct

+ Delay time.Duration

+ Err error

+ func (e *RepeatError) Error() string

+ func (e *RepeatError) Unwrap() error

type RetryPolicy

+ PauseAfterErrCount int

+ PauseRetryDelay time.Duration

+ type SkipError struct

+ Reason string

+ func (e *SkipError) Error() string

+ type SubflowResult struct

+ Tasks []WorkflowTask

+ type UpstreamPayload struct

+ Original T

+ Upstream json.RawMessage

type WorkflowDefinition

+ Hooks *WorkflowHooks

+ type WorkflowHookDef struct

+ Payload json.RawMessage

+ TaskType TaskType

+ Timeout Duration

+ type WorkflowHooks struct

+ OnExit *WorkflowHookDef

+ OnFailure *WorkflowHookDef

+ OnInit *WorkflowHookDef

+ OnSuccess *WorkflowHookDef

type WorkflowInstance

+ ConditionIterations map[string]int

+ HookStates map[string]WorkflowTaskState

+ Output json.RawMessage

+ PendingDeps map[string]int

type WorkflowStatus

+ const WorkflowStatusSuspended

type WorkflowTask

+ AllowFailure bool

+ ConditionRoutes map[uint]string

+ MaxIterations int

+ Preconditions []Precondition

+ Priority int

+ ResultFrom string

+ Type WorkflowTaskType

type WorkflowTaskState

+ ConditionRoute *uint

+ SkipReason string

+ Skipped bool

+ SubflowTasks []string

+ type WorkflowTaskType string

+ const WorkflowTaskCondition

+ const WorkflowTaskStatic

+ const WorkflowTaskSubflow

v0.1.9

Mar 9, 2026

v0.1.8

Mar 9, 2026

v0.1.7

Mar 9, 2026

v0.1.6

Mar 9, 2026

v0.1.5

Mar 9, 2026

v0.1.4

Mar 8, 2026

v0.1.3

Mar 8, 2026

Changes in this version

type EventType

+ const EventWorkflowSignalReceived

type HandlerDefinition

+ Version string

type NodeInfo

+ HandlerVersions map[string]string

type OverlapPolicy

+ const OverlapReplace

type RetryPolicy

+ NonRetryableErrors []string

type Schedule

+ Jitter *Duration

type WorkMessage

+ Version string

type WorkflowInstance

+ ParentTaskName *string

+ ParentWorkflowID *string

+ type WorkflowSignal struct

+ Name string

+ Payload json.RawMessage

+ SentAt time.Time

+ WorkflowID string

type WorkflowTask

+ ChildWorkflowDef *WorkflowDefinition

type WorkflowTaskState

+ ChildWorkflowID string

v0.1.2

Mar 6, 2026

Changes in this version

+ func CalculateBackoff(attempt int, policy *RetryPolicy) time.Duration

v0.1.1

Feb 28, 2026

v0.1.0

Feb 24, 2026

Changes in this version

+ var ErrBatchNotFound = errors.New("dureq: batch not found")

+ var ErrCyclicDependency = errors.New("dureq: workflow has cyclic dependencies")

+ var ErrDuplicateJob = errors.New("dureq: duplicate unique key")

+ var ErrExecutionTimedOut = errors.New("dureq: execution timed out")

+ var ErrHandlerNotFound = errors.New("dureq: handler not registered for task type")

+ var ErrInvalidJobStatus = errors.New("dureq: invalid job status transition")

+ var ErrInvalidSchedule = errors.New("dureq: invalid schedule")

+ var ErrJobNotFound = errors.New("dureq: job not found")

+ var ErrLockFailed = errors.New("dureq: failed to acquire lock")

+ var ErrLockNotHeld = errors.New("dureq: lock not held")

+ var ErrNoProgressReporter = errors.New("dureq: no progress reporter in context (called outside handler?)")

+ var ErrNotLeader = errors.New("dureq: not the leader node")

+ var ErrRedisNotConnected = errors.New("dureq: Redis not connected")

+ var ErrRunNotFound = errors.New("dureq: run not found")

+ var ErrScheduleNotFound = errors.New("dureq: schedule not found")

+ var ErrScheduleToStartTimeout = errors.New("dureq: schedule-to-start timeout exceeded")

+ var ErrServerStopped = errors.New("dureq: server stopped")

+ var ErrWorkflowNotFound = errors.New("dureq: workflow not found")

+ func GetAttempt(ctx context.Context) int

+ func GetErrorClassString(errClass ErrorClassification) string

+ func GetHeaders(ctx context.Context) map[string]string

+ func GetJobID(ctx context.Context) string

+ func GetMaxRetry(ctx context.Context) int

+ func GetNodeID(ctx context.Context) string

+ func GetRetryAfter(err error) time.Duration

+ func GetRunID(ctx context.Context) string

+ func IsPanicError(err error) bool

+ func ReportProgress(ctx context.Context, data any) error

+ func WithAttempt(ctx context.Context, attempt int) context.Context

+ func WithHeaders(ctx context.Context, headers map[string]string) context.Context

+ func WithJobID(ctx context.Context, id string) context.Context

+ func WithMaxRetry(ctx context.Context, max int) context.Context

+ func WithNodeID(ctx context.Context, id string) context.Context

+ func WithPriority(ctx context.Context, p Priority) context.Context

+ func WithProgressReporter(ctx context.Context, fn ProgressReporterFunc) context.Context

+ func WithRunID(ctx context.Context, id string) context.Context

+ func WithTaskType(ctx context.Context, tt TaskType) context.Context

+ type AggregateResult struct

+ AggregatedPayload json.RawMessage

+ Count int

+ Group string

+ type AtTime struct

+ Hour uint

+ Minute uint

+ Second uint

+ type BatchDefinition struct

+ ChunkSize int

+ DefaultPriority *Priority

+ ExecutionTimeout *Duration

+ FailurePolicy BatchFailurePolicy

+ ItemRetryPolicy *RetryPolicy

+ ItemTaskType TaskType

+ Items []BatchItem

+ Name string

+ OnetimePayload json.RawMessage

+ OnetimeTaskType *TaskType

+ RetryPolicy *RetryPolicy

+ type BatchFailurePolicy string

+ const BatchContinueOnError

+ const BatchFailFast

+ type BatchInstance struct

+ Attempt int

+ CompletedAt *time.Time

+ CompletedItems int

+ CreatedAt time.Time

+ Deadline *time.Time

+ Definition BatchDefinition

+ FailedItems int

+ ID string

+ ItemStates map[string]BatchItemState

+ MaxAttempts int

+ Name string

+ NextChunkIndex int

+ OnetimeState *BatchOnetimeState

+ PendingItems int

+ RunningItems int

+ Status WorkflowStatus

+ TotalItems int

+ UpdatedAt time.Time

+ type BatchItem struct

+ ID string

+ Payload json.RawMessage

+ type BatchItemResult struct

+ BatchID string

+ Error *string

+ ItemID string

+ Output json.RawMessage

+ Success bool

+ type BatchItemState struct

+ Error *string

+ FinishedAt *time.Time

+ ItemID string

+ JobID string

+ StartedAt *time.Time

+ Status JobStatus

+ type BatchOnetimeState struct

+ Error *string

+ FinishedAt *time.Time

+ JobID string

+ ResultData json.RawMessage

+ StartedAt *time.Time

+ Status JobStatus

+ type BatchProgress struct

+ BatchID string

+ Done int

+ Failed int

+ Step string

+ Total int

+ type Duration time.Duration

+ func (d *Duration) UnmarshalJSON(b []byte) error

+ func (d Duration) MarshalJSON() ([]byte, error)

+ func (d Duration) Std() time.Duration

+ type EnqueueGroupOption struct

+ Group string

+ Payload json.RawMessage

+ TaskType TaskType

+ type ErrorClassification int

+ const ErrorClassNonRetryable

+ const ErrorClassRateLimited

+ const ErrorClassRetryable

+ func ClassifyError(err error) ErrorClassification

+ type EventType string

+ const EventBatchCancelled

+ const EventBatchCompleted

+ const EventBatchFailed

+ const EventBatchItemCompleted

+ const EventBatchItemFailed

+ const EventBatchOnetimeCompleted

+ const EventBatchOnetimeFailed

+ const EventBatchProgress

+ const EventBatchRetrying

+ const EventBatchStarted

+ const EventBatchTimedOut

+ const EventJobAutoRecovered

+ const EventJobCancelled

+ const EventJobCompleted

+ const EventJobDead

+ const EventJobDispatched

+ const EventJobEnqueued

+ const EventJobFailed

+ const EventJobRetrying

+ const EventJobScheduleToStartTimeout

+ const EventJobScheduled

+ const EventJobStarted

+ const EventLeaderElected

+ const EventLeaderLost

+ const EventNodeCrashDetected

+ const EventNodeJoined

+ const EventNodeLeft

+ const EventScheduleCreated

+ const EventScheduleRemoved

+ const EventWorkflowCancelled

+ const EventWorkflowCompleted

+ const EventWorkflowFailed

+ const EventWorkflowRetrying

+ const EventWorkflowStarted

+ const EventWorkflowTaskCompleted

+ const EventWorkflowTaskDispatched

+ const EventWorkflowTaskFailed

+ const EventWorkflowTimedOut

+ type GroupAggregator interface

+ Aggregate func(group string, payloads []json.RawMessage) (json.RawMessage, error)

+ type GroupAggregatorFunc func(group string, payloads []json.RawMessage) (json.RawMessage, error)

+ func (f GroupAggregatorFunc) Aggregate(group string, payloads []json.RawMessage) (json.RawMessage, error)

+ type GroupConfig struct

+ Aggregator GroupAggregator

+ GracePeriod time.Duration

+ MaxDelay time.Duration

+ MaxSize int

+ type GroupHandler func(ctx context.Context, group string, payload json.RawMessage) error

+ type GroupMessage struct

+ AddedAt time.Time

+ JobID string

+ Payload json.RawMessage

+ TaskType TaskType

+ type HandlerDefinition struct

+ Concurrency int

+ Handler HandlerFunc

+ HandlerWithResult HandlerFuncWithResult

+ Middlewares []MiddlewareFunc

+ RetryPolicy *RetryPolicy

+ TaskType TaskType

+ Timeout time.Duration

+ type HandlerFunc func(ctx context.Context, payload json.RawMessage) error

+ func ChainMiddleware(handler HandlerFunc, middlewares ...MiddlewareFunc) HandlerFunc

+ type HandlerFuncWithResult func(ctx context.Context, payload json.RawMessage) (json.RawMessage, error)

+ func ChainMiddlewareWithResult(handler HandlerFuncWithResult, middlewares ...MiddlewareWithResultFunc) HandlerFuncWithResult

+ type Job struct

+ Attempt int

+ BatchID *string

+ BatchItem *string

+ BatchRole *string

+ CompletedAt *time.Time

+ CreatedAt time.Time

+ DLQAfter *int

+ Headers map[string]string

+ HeartbeatTimeout *Duration

+ ID string

+ LastError *string

+ LastRunAt *time.Time

+ NextRunAt *time.Time

+ Payload json.RawMessage

+ Priority *Priority

+ RetryPolicy *RetryPolicy

+ Schedule Schedule

+ ScheduleToStartTimeout *Duration

+ Status JobStatus

+ Tags []string

+ TaskType TaskType

+ UniqueKey *string

+ UpdatedAt time.Time

+ WorkflowID *string

+ WorkflowTask *string

+ type JobEvent struct

+ AffectedRunIDs []string

+ Attempt int

+ BatchProgress *BatchProgress

+ Error *string

+ JobID string

+ NodeID string

+ RunID string

+ TaskType TaskType

+ Timestamp time.Time

+ Type EventType

+ type JobRun struct

+ Attempt int

+ Duration time.Duration

+ Error *string

+ FinishedAt *time.Time

+ ID string

+ JobID string

+ LastHeartbeatAt *time.Time

+ NodeID string

+ Progress json.RawMessage

+ StartedAt time.Time

+ Status RunStatus

+ type JobStatus string

+ const JobStatusCancelled

+ const JobStatusCompleted

+ const JobStatusDead

+ const JobStatusFailed

+ const JobStatusPending

+ const JobStatusRetrying

+ const JobStatusRunning

+ const JobStatusScheduled

+ func (s JobStatus) IsTerminal() bool

+ func (s JobStatus) String() string

+ type MiddlewareFunc func(HandlerFunc) HandlerFunc

+ type MiddlewareWithResultFunc func(HandlerFuncWithResult) HandlerFuncWithResult

+ func AdaptMiddleware(mw MiddlewareFunc) MiddlewareWithResultFunc

+ type NodeInfo struct

+ ActiveRunIDs []string

+ Address string

+ LastHeartbeat time.Time

+ NodeID string

+ PoolStats *PoolStats

+ StartedAt time.Time

+ TaskTypes []string

+ type NonRetryableError struct

+ Err error

+ func (e *NonRetryableError) Error() string

+ func (e *NonRetryableError) Unwrap() error

+ type OverlapPolicy string

+ const OverlapAllowAll

+ const OverlapBufferAll

+ const OverlapBufferOne

+ const OverlapSkip

+ type PanicError struct

+ Stacktrace string

+ Value interface{}

+ func GetPanicError(err error) *PanicError

+ func (e *PanicError) Error() string

+ type PeriodicTaskConfig struct

+ CronExpr string

+ Payload json.RawMessage

+ TaskType TaskType

+ UniqueKey string

+ type PeriodicTaskConfigProvider interface

+ GetConfigs func() ([]*PeriodicTaskConfig, error)

+ type PeriodicTaskConfigProviderFunc func() ([]*PeriodicTaskConfig, error)

+ func (f PeriodicTaskConfigProviderFunc) GetConfigs() ([]*PeriodicTaskConfig, error)

+ type PoolStats struct

+ IdleWorkers int

+ MaxConcurrency int

+ QueueLength int

+ RunningWorkers int

+ TotalCompleted uint64

+ TotalFailed uint64

+ TotalSubmitted uint64

+ type Priority int

+ const PriorityCritical

+ const PriorityHigh

+ const PriorityLow

+ const PriorityNormal

+ func GetPriority(ctx context.Context) Priority

+ type PriorityTier string

+ const TierHigh

+ const TierLow

+ const TierNormal

+ func TierForPriority(p Priority) PriorityTier

+ type ProgressReporterFunc func(ctx context.Context, data json.RawMessage) error

+ type RateLimitedError struct

+ Err error

+ RetryAfter time.Duration

+ func (e *RateLimitedError) Error() string

+ func (e *RateLimitedError) Unwrap() error

+ type RedisOptions struct

+ ClusterAddrs []string

+ DB int

+ Password string

+ PoolSize int

+ SentinelConfig *RedisSentinelConfig

+ TLSConfig *tls.Config

+ URL string

+ type RedisSentinelConfig struct

+ MasterName string

+ SentinelAddrs []string

+ SentinelPassword string

+ type RetryPolicy struct

+ InitialDelay time.Duration

+ Jitter float64

+ MaxAttempts int

+ MaxDelay time.Duration

+ Multiplier float64

+ func DefaultRetryPolicy() *RetryPolicy

+ type RetryableError struct

+ Err error

+ func (e *RetryableError) Error() string

+ func (e *RetryableError) Unwrap() error

+ type RunStatus string

+ const RunStatusCancelled

+ const RunStatusClaimed

+ const RunStatusFailed

+ const RunStatusRunning

+ const RunStatusSucceeded

+ const RunStatusTimedOut

+ func (s RunStatus) IsTerminal() bool

+ func (s RunStatus) String() string

+ type Schedule struct

+ AtTimes []AtTime

+ CatchupWindow *Duration

+ CronExpr *string

+ EndsAt *time.Time

+ IncludedDays []int

+ Interval *Duration

+ MaxBackfillPerTick *int

+ OverlapPolicy OverlapPolicy

+ RegularInterval *uint

+ RunAt *time.Time

+ StartsAt *time.Time

+ Timezone string

+ Type ScheduleType

+ func (s *Schedule) Validate() error

+ type ScheduleEntry struct

+ JobID string

+ LastProcessedAt *time.Time

+ NextRunAt time.Time

+ Schedule Schedule

+ type ScheduleType string

+ const ScheduleCron

+ const ScheduleDaily

+ const ScheduleDuration

+ const ScheduleImmediate

+ const ScheduleMonthly

+ const ScheduleOneTime

+ const ScheduleWeekly

+ type TaskType string

+ func GetTaskType(ctx context.Context) TaskType

+ func (t TaskType) String() string

+ type WorkMessage struct

+ Attempt int

+ Deadline time.Time

+ DispatchedAt time.Time

+ Headers map[string]string

+ JobID string

+ Metadata map[string]string

+ Payload json.RawMessage

+ Priority Priority

+ RunID string

+ TaskType TaskType

+ type WorkResult struct

+ Error *string

+ JobID string

+ Output json.RawMessage

+ RunID string

+ Success bool

+ type WorkflowDefinition struct

+ DefaultPriority *Priority

+ ExecutionTimeout *Duration

+ Name string

+ RetryPolicy *RetryPolicy

+ Tasks []WorkflowTask

+ type WorkflowInstance struct

+ Attempt int

+ CompletedAt *time.Time

+ CreatedAt time.Time

+ Deadline *time.Time

+ Definition WorkflowDefinition

+ ID string

+ Input json.RawMessage

+ MaxAttempts int

+ Status WorkflowStatus

+ Tasks map[string]WorkflowTaskState

+ UpdatedAt time.Time

+ WorkflowName string

+ type WorkflowStatus string

+ const WorkflowStatusCancelled

+ const WorkflowStatusCompleted

+ const WorkflowStatusFailed

+ const WorkflowStatusPending

+ const WorkflowStatusRunning

+ func (s WorkflowStatus) IsTerminal() bool

+ func (s WorkflowStatus) String() string

+ type WorkflowTask struct

+ DependsOn []string

+ Name string

+ Payload json.RawMessage

+ TaskType TaskType

+ type WorkflowTaskState struct

+ Error *string

+ FinishedAt *time.Time

+ JobID string

+ Name string

+ StartedAt *time.Time

+ Status JobStatus

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL