context.go

package asynq

import (
	"context"
	"time"

	"github.com/AsynqLab/asynq/internal/base"
	asynqcontext "github.com/AsynqLab/asynq/internal/context"
)

// NewAsynqContext returns a new context for a given task message and deadline.
//
// The returned context is a child of the given context.
func NewAsynqContext(
	ctx context.Context,
	id, qname string,
	maxRetry, retryCount int,
	deadline time.Time,
) (context.Context, context.CancelFunc) {
	return asynqcontext.New(ctx, &base.TaskMessage{
		ID:      id,
		Queue:   qname,
		Retry:   maxRetry,
		Retried: retryCount,
	}, deadline)
}

// GetTaskID extracts a task ID from a context, if any.
//
// ID of a task is guaranteed to be unique.
// ID of a task doesn't change if the task is being retried.
func GetTaskID(ctx context.Context) (id string, ok bool) {
	return asynqcontext.GetTaskID(ctx)
}

// GetRetryCount extracts retry count from a context, if any.
//
// Return value n indicates the number of times associated task has been
// retried so far.
func GetRetryCount(ctx context.Context) (n int, ok bool) {
	return asynqcontext.GetRetryCount(ctx)
}

// GetMaxRetry extracts maximum retry from a context, if any.
//
// Return value n indicates the maximum number of times the associated task
// can be retried if ProcessTask returns a non-nil error.
func GetMaxRetry(ctx context.Context) (n int, ok bool) {
	return asynqcontext.GetMaxRetry(ctx)
}

// GetQueueName extracts queue name from a context, if any.
//
// Return value queue indicates which queue the task was pulled from.
func GetQueueName(ctx context.Context) (queue string, ok bool) {
	return asynqcontext.GetQueueName(ctx)
}