uptask

package module

Go to main page

Versions in this module

v0

v0.5.0

May 19, 2025

Changes in this version

+ func AddEventHandlerSafely[E Event](service *TaskService, handlerName string, handler EventHandler[E]) error

+ func AddEventHandler[E Event](service *TaskService, handlerName string, handler EventHandler[E])

+ type Container struct

+ Args T

+ CreatedAt time.Time

+ Id string

+ InsertOpts InsertOpts

+ Retried int

+ Scheduled bool

+ type Event TaskArgs

+ type EventFanoutArgs struct

+ EventType string

+ Handlers []string

+ Payload any

+ func (e EventFanoutArgs) Kind() string

+ type EventFanoutWorker struct

+ func (w *EventFanoutWorker) ProcessTask(ctx context.Context, task *Container[EventFanoutArgs]) error

+ type EventHandler interface

+ ProcessEvent func(ctx context.Context, task *Container[T]) error

+ Timeout func(task *Container[T]) time.Duration

+ type InsertOpts struct

+ MaxRetries int

+ Queue string

+ ScheduledAt time.Time

+ Tags []string

+ func (o *InsertOpts) FromCloudEvent(ce cloudevents.Event) error

+ type TaskEvent struct

+ EventType string

+ PayloadData any

+ func (e TaskEvent) Kind() string

+ func (e TaskEvent) Payload() any

+ type TaskEventGen struct

+ Event T

+ HandlerName string

+ func (e TaskEventGen[T]) Kind() string

type TaskService

+ func (c *TaskService) PublishEvent(ctx context.Context, event Event, opts *InsertOpts) (string, error)

+ func (c *TaskService) StartTask(ctx context.Context, args TaskArgs, opts *InsertOpts) (string, error)

+ func (t *TaskService) UseSend(middlewares ...Middleware)

+ type UpstashClientOpts func(c *UpstashTransport)

+ func WithDlq(dlq string) UpstashClientOpts

+ func WithUpstashLogger(logger Logger) UpstashClientOpts

v0.4.2

Apr 1, 2025

v0.4.1

Apr 1, 2025

v0.4.0

Mar 20, 2025

v0.3.6

Mar 20, 2025

Changes in this version

type TaskClient

+ func (t *TaskClient) Use(middlewares ...Middleware)

v0.2.0

Mar 3, 2025

v0.1.0

Feb 28, 2025

Changes in this version

type AnyTask

+ MaxRetries int

+ type ErrorCode string

+ const ErrBadResponse

+ const ErrClientCreation

+ const ErrDeliveryFailed

+ const ErrInvalidRequest

+ const ErrInvalidSchedule

+ const ErrTransportCreation

type Task

+ MaxRetries int

type TaskExecution

+ MaxRetries int

+ Retried int

+ type UpstashTaskError struct

+ Cause error

+ Code ErrorCode

+ Event *v2.Event

+ Message string

+ Metadata map[string]interface{}

+ Operation string

+ func NewUpstashTaskError(code ErrorCode, operation string, message string, cause error) *UpstashTaskError

+ func (e *UpstashTaskError) Error() string

+ func (e *UpstashTaskError) Unwrap() error

+ func (e *UpstashTaskError) WithEvent(event v2.Event) *UpstashTaskError

+ func (e *UpstashTaskError) WithMetadata(key string, value interface{}) *UpstashTaskError

v0.0.9

Dec 3, 2024

Changes in this version

type RedisConfig

+ Secure bool

type RedisTaskStore

+ func (s *RedisTaskStore) TaskExists(ctx context.Context, taskID string) (bool, error)

type TaskStore

+ TaskExists func(ctx context.Context, taskID string) (bool, error)

v0.0.8

Nov 29, 2024

v0.0.7

Nov 27, 2024

Changes in this version

type AnyTask

+ QstashMessageId string

+ ScheduleId string

v0.0.6

Nov 27, 2024

v0.0.5

Nov 27, 2024

Changes in this version

type RedisTaskStore

+ func (s *RedisTaskStore) UpdateTaskSnoozedTask(ctx context.Context, taskID string, scheduledAt time.Time) error

type TaskStore

+ UpdateTaskSnoozedTask func(ctx context.Context, taskID string, scheduledAt time.Time) error

v0.0.4

Nov 27, 2024

v0.0.3

Nov 27, 2024

v0.0.2

Nov 27, 2024

Changes in this version

type RedisTaskStore

+ func (s *RedisTaskStore) UpdateTaskScheduledAt(ctx context.Context, taskID string, scheduledAt time.Time) error

type TaskStore

+ UpdateTaskScheduledAt func(ctx context.Context, taskID string, scheduledAt time.Time) error

v0.0.1

Nov 27, 2024

Changes in this version

+ func AddTaskHandlerSafely[T TaskArgs](service *TaskService, handler TaskHandler[T]) error

+ func AddTaskHandler[T TaskArgs](service *TaskService, handler TaskHandler[T])

+ func JobSnooze(duration time.Duration) error

+ type AnyTask struct

+ Args interface{}

+ Attempt int

+ CreatedAt time.Time

+ Id string

+ Retried int

+ Scheduled bool

+ type ClientOption func(*TaskClient)

+ func WithClientLogger(l Logger) ClientOption

+ func WithClientStore(s TaskStore) ClientOption

+ type Handler interface

+ HandleEvent func(context.Context, cloudevents.Event) error

+ type HandlerFunc func(context.Context, cloudevents.Event) error

+ func (f HandlerFunc) HandleEvent(ctx context.Context, event cloudevents.Event) error

+ type Logger interface

+ Debug func(string, ...any)

+ Error func(string, ...any)

+ Info func(string, ...any)

+ Warn func(string, ...any)

+ type Middleware func(HandlerFunc) HandlerFunc

+ type MiddlewareFunc func(handler Handler) Handler

+ type RedisConfig struct

+ Addr string

+ DB int

+ Password string

+ Username string

+ type RedisTaskStore struct

+ func NewRedisTaskStore(cfg RedisConfig) (*RedisTaskStore, error)

+ func (s *RedisTaskStore) AddTaskError(ctx context.Context, taskID string, taskError TaskError) error

+ func (s *RedisTaskStore) CleanupOldTaskExecutions(ctx context.Context, olderThan time.Duration) error

+ func (s *RedisTaskStore) CreateTaskExecution(ctx context.Context, task *TaskExecution) error

+ func (s *RedisTaskStore) DeleteTaskExecution(ctx context.Context, taskID string) error

+ func (s *RedisTaskStore) GetMostRecentTaskExecutions(ctx context.Context, limit int) ([]*TaskExecution, error)

+ func (s *RedisTaskStore) GetTaskExecution(ctx context.Context, taskID string) (*TaskExecution, error)

+ func (s *RedisTaskStore) ListTaskExecutions(ctx context.Context, filter TaskFilter) ([]*TaskExecution, error)

+ func (s *RedisTaskStore) UpdateTaskStatus(ctx context.Context, taskID string, status TaskStatus) error

+ type ServiceOption func(*TaskService)

+ func WithLogger(l Logger) ServiceOption

+ func WithStore(s TaskStore) ServiceOption

+ type Task struct

+ Args T

+ Attempt int

+ CreatedAt time.Time

+ Id string

+ Retried int

+ Scheduled bool

+ type TaskArgs interface

+ Kind func() string

+ type TaskClient struct

+ func NewTaskClient(transport Transport, opts ...ClientOption) *TaskClient

+ func (c *TaskClient) StartTask(ctx context.Context, args TaskArgs, opts *TaskInsertOpts) (string, error)

+ type TaskError struct

+ Details map[string]interface{}

+ Message string

+ Timestamp time.Time

+ type TaskExecution struct

+ Args interface{}

+ Attempt int

+ AttemptID string

+ AttemptedAt time.Time

+ CreatedAt time.Time

+ Errors []TaskError

+ FinalizedAt time.Time

+ ID string

+ MaxAttempts int

+ QstashMessageID string

+ Queue string

+ ScheduleID string

+ ScheduledAt time.Time

+ Status TaskStatus

+ TaskKind string

+ type TaskFilter struct

+ FromDate time.Time

+ Limit int

+ Queue string

+ Status *TaskStatus

+ ToDate time.Time

+ type TaskHandler interface

+ ProcessTask func(ctx context.Context, task *Task[T]) error

+ Timeout func(task *Task[T]) time.Duration

+ func ProcessTaskFunc[T TaskArgs](f func(context.Context, *Task[T]) error) TaskHandler[T]

+ type TaskHandlerDefaults struct

+ func (w TaskHandlerDefaults[T]) NextRetry(*Task[T]) time.Time

+ func (w TaskHandlerDefaults[T]) Timeout(*Task[T]) time.Duration

+ type TaskInsertOpts struct

+ MaxRetries int

+ Queue string

+ ScheduledAt time.Time

+ Tags []string

+ func (o *TaskInsertOpts) FromCloudEvent(ce cloudevents.Event) error

+ type TaskService struct

+ func NewTaskService(transport Transport, opts ...ServiceOption) *TaskService

+ func (t *TaskService) Use(middlewares ...Middleware)

+ func (w *TaskService) HandleEvent(ctx context.Context, ce cloudevents.Event) error

+ type TaskStatus string

+ const TaskStatusFailed

+ const TaskStatusPending

+ const TaskStatusRunning

+ const TaskStatusSuccess

+ type TaskStore interface

+ AddTaskError func(ctx context.Context, taskID string, err TaskError) error

+ CleanupOldTaskExecutions func(ctx context.Context, olderThan time.Duration) error

+ CreateTaskExecution func(ctx context.Context, task *TaskExecution) error

+ DeleteTaskExecution func(ctx context.Context, taskID string) error

+ GetMostRecentTaskExecutions func(ctx context.Context, limit int) ([]*TaskExecution, error)

+ GetTaskExecution func(ctx context.Context, taskID string) (*TaskExecution, error)

+ ListTaskExecutions func(ctx context.Context, filter TaskFilter) ([]*TaskExecution, error)

+ UpdateTaskStatus func(ctx context.Context, taskID string, status TaskStatus) error

+ type Transport interface

+ Send func(ctx context.Context, event cloudevents.Event, opts *TaskInsertOpts) error

+ type UpstashTransport struct

+ func NewUpstashTransport(qstashToken, targetUrl string) *UpstashTransport

+ func (c *UpstashTransport) Send(ctx context.Context, ce v2.Event, opts *TaskInsertOpts) error

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