redisqueue

package

v0.0.0-...-122f59b Latest Latest Go to latest Published: Apr 23, 2024 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/authgear/authgear-server

Documentation ¶

Index ¶

Variables
func RedisKeyForQueue(queueName string) string
func RedisKeyForTask(appID string, taskID string) string
type Producer
type QueueItem
- func (i *QueueItem) RedisKey() string
type Task
- func (t *Task) RedisKey() string
- func (t *Task) ToQueueItem() *QueueItem
type TaskStatus
type UserImportProducer
- func NewUserImportProducer(redis *appredis.Handle, clock clock.Clock) *UserImportProducer
type UserReindexProducer
- func NewUserReindexProducer(redis *appredis.Handle, clock clock.Clock) *UserReindexProducer

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrTaskNotFound = apierrors.NotFound.WithReason("TaskNotFound").New("task not found")

View Source

var ProducerDependencySet = wire.NewSet(
	NewUserImportProducer,
	NewUserReindexProducer,
)

View Source

var QueueUserImport = "user-import"

View Source

var QueueUserReindex = "user-reindex"

View Source

var TTL = 24 * time.Hour

Functions ¶

func RedisKeyForQueue ¶

func RedisKeyForQueue(queueName string) string

func RedisKeyForTask ¶

func RedisKeyForTask(appID string, taskID string) string

Types ¶

type Producer ¶

type Producer struct {
	QueueName string
	Redis     *appredis.Handle
	Clock     clock.Clock
}

func (*Producer) EnqueueTask ¶

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

func (*Producer) GetTask ¶

func (p *Producer) GetTask(ctx context.Context, item *QueueItem) (*Task, error)

func (*Producer) NewTask ¶

func (p *Producer) NewTask(appID string, input json.RawMessage) *Task

type QueueItem ¶

type QueueItem struct {
	AppID  string `json:"app_id,omitempty"`
	TaskID string `json:"task_id,omitempty"`
}

func (*QueueItem) RedisKey ¶

func (i *QueueItem) RedisKey() string

type Task ¶

type Task struct {
	ID          string          `json:"id,omitempty"`
	AppID       string          `json:"app_id,omitempty"`
	CreatedAt   *time.Time      `json:"created_at,omitempty"`
	CompletedAt *time.Time      `json:"completed_at,omitempty"`
	Status      TaskStatus      `json:"status,omitempty"`
	Input       json.RawMessage `json:"input,omitempty"`
	Output      json.RawMessage `json:"output,omitempty"`
}

func (*Task) RedisKey ¶

func (t *Task) RedisKey() string

func (*Task) ToQueueItem ¶

func (t *Task) ToQueueItem() *QueueItem

type TaskStatus ¶

type TaskStatus string

const (
	TaskStatusPending   TaskStatus = "pending"
	TaskStatusCompleted TaskStatus = "completed"
)

type UserImportProducer ¶

type UserImportProducer struct {
	*Producer
}

func NewUserImportProducer ¶

func NewUserImportProducer(redis *appredis.Handle, clock clock.Clock) *UserImportProducer

type UserReindexProducer ¶

type UserReindexProducer struct {
	*Producer
}

func NewUserReindexProducer ¶

func NewUserReindexProducer(redis *appredis.Handle, clock clock.Clock) *UserReindexProducer

Source Files ¶

View all Source files

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