tasq

Jun 5, 2023

Changes in this version

type Client

+ func (c *Client) NewInspector() *Inspector

type IRepository

+ CountTasks func(ctx context.Context, taskStatuses []TaskStatus, taskTypes, queues []string) (int64, error)

+ PurgeTasks func(ctx context.Context, taskStatuses []TaskStatus, taskTypes, queues []string, ...) (int64, error)

+ ScanTasks func(ctx context.Context, taskStatuses []TaskStatus, taskTypes, queues []string, ...) ([]*Task, error)

+ type Inspector struct

+ func (o *Inspector) Count(ctx context.Context, taskStatuses []TaskStatus, taskTypes, queues []string) (int64, error)

+ func (o *Inspector) Delete(ctx context.Context, safeDelete bool, tasks ...*Task) error

+ func (o *Inspector) Purge(ctx context.Context, safeDelete bool, taskStatuses []TaskStatus, ...) (int64, error)

+ func (o *Inspector) Scan(ctx context.Context, taskStatuses []TaskStatus, taskTypes, queues []string, ...) ([]*Task, error)

Apr 24, 2023

Changes in this version

+ type HandlerFunc func(task *Task) error

Apr 21, 2023

Changes in this version

type Producer

+ func (p *Producer) SubmitTask(ctx context.Context, task *Task) (*Task, error)

Apr 21, 2023

Changes in this version

type Task

+ func (t *Task) IsLastReceive() bool

+ func (t *Task) SetVisibility(visibleAt time.Time)

Jan 11, 2023

Changes in this version

+ var ErrConsumerAlreadyRunning = errors.New("consumer has already been started")

+ var ErrConsumerAlreadyStopped = errors.New("consumer has already been stopped")

+ var ErrCouldNotActivateTasks = errors.New("a number of tasks could not be activated")

+ var ErrCouldNotPingTasks = errors.New("could not ping tasks")

+ var ErrCouldNotPollTasks = errors.New("could not poll tasks")

+ var ErrTaskTypeAlreadyLearned = errors.New("task with this type already learned")

+ var ErrTaskTypeNotFound = errors.New("task with this type not found")

+ var ErrTaskTypeNotKnown = errors.New("task with this type is not known by this consumer")

+ var ErrUnknownPollStrategy = errors.New("unknown poll strategy")

+ var ErrVisibilityTimeoutTooShort = errors.New("visibility timeout must be longer than poll interval")

+ type IRepository interface

+ CleanTasks func(ctx context.Context, minimumAge time.Duration) (int64, error)

+ DeleteTask func(ctx context.Context, task *Task) error

+ Migrate func(ctx context.Context) error

+ PingTasks func(ctx context.Context, taskIDs []uuid.UUID, visibilityTimeout time.Duration) ([]*Task, error)

+ PollTasks func(ctx context.Context, types, queues []string, visibilityTimeout time.Duration, ...) ([]*Task, error)

+ RegisterError func(ctx context.Context, task *Task, errTask error) (*Task, error)

+ RegisterFinish func(ctx context.Context, task *Task, finishStatus TaskStatus) (*Task, error)

+ RegisterStart func(ctx context.Context, task *Task) (*Task, error)

+ RequeueTask func(ctx context.Context, task *Task) (*Task, error)

+ SubmitTask func(ctx context.Context, task *Task) (*Task, error)

+ type Ordering int

+ const OrderingCreatedAtFirst

+ const OrderingPriorityFirst

type Task

+ Args []byte

+ CreatedAt time.Time

+ FinishedAt *time.Time

+ ID uuid.UUID

+ LastError *string

+ MaxReceives int32

+ Priority int16

+ Queue string

+ ReceiveCount int32

+ StartedAt *time.Time

+ Status TaskStatus

+ Type string

+ VisibleAt time.Time

+ func NewTask(taskType string, taskArgs any, queue string, priority int16, maxReceives int32) (*Task, error)

+ type TaskStatus string

+ const StatusEnqueued

+ const StatusFailed

+ const StatusInProgress

+ const StatusNew

+ const StatusSuccessful

+ func GetTaskStatuses(taskStatusGroup TaskStatusGroup) []TaskStatus

+ type TaskStatusGroup int

+ const AllTasks

+ const FinishedTasks

+ const OpenTasks

Nov 13, 2022

Changes in this version

+ var NoopLogger = log.New(io.Discard, "", 0)

Nov 10, 2022

Changes in this version

+ func NewRepository(ctx context.Context, dataSource any, driver, prefix string, migrate bool) (repository repository.IRepository, err error)

+ type Cleaner struct

+ func (c *Cleaner) Clean(ctx context.Context) (int64, error)

+ func (c *Cleaner) WithTaskAge(taskAge time.Duration) *Cleaner

+ type Client struct

+ func NewClient(ctx context.Context, repository repository.IRepository) *Client

+ func (c *Client) NewCleaner() *Cleaner

+ func (c *Client) NewConsumer() *Consumer

+ func (c *Client) NewProducer() *Producer

+ func (c *Client) Repository() repository.IRepository

+ type Consumer struct

+ func (c *Consumer) Channel() <-chan *Job

+ func (c *Consumer) Forget(name string) error

+ func (c *Consumer) Learn(name string, tF taskFunc, override bool) error

+ func (c *Consumer) Start(ctx context.Context) error

+ func (c *Consumer) Stop(ctx context.Context) error

+ func (c *Consumer) WithAutoDeleteOnSuccess(autoDeleteOnSuccess bool) *Consumer

+ func (c *Consumer) WithChannelSize(channelSize int) *Consumer

+ func (c *Consumer) WithLogger(logger Logger) *Consumer

+ func (c *Consumer) WithMaxActiveTasks(maxActiveTasks int) *Consumer

+ func (c *Consumer) WithPollInterval(pollInterval time.Duration) *Consumer

+ func (c *Consumer) WithPollLimit(pollLimit int) *Consumer

+ func (c *Consumer) WithPollStrategy(pollStrategy PollStrategy) *Consumer

+ func (c *Consumer) WithQueues(queues ...string) *Consumer

+ func (c *Consumer) WithVisibilityTimeout(visibilityTimeout time.Duration) *Consumer

+ type Job func()

+ type Logger interface

+ Print func(v ...any)

+ Printf func(format string, v ...any)

+ type PollStrategy string

+ const PollStrategyByCreatedAt

+ const PollStrategyByPriority

+ type Producer struct

+ func (p *Producer) Submit(ctx context.Context, taskType string, taskArgs any, queue string, ...) (submittedTask *model.Task, err error)

+ type Task interface

+ GetDetails func() *model.Task

+ UnmarshalArgs func(v any) error