claimablejob

README

redisjob

A redis job

Documentation

Index

• type ClaimableJob
• type ClaimableRedisJob
  • func New(key string, conn Conn) *ClaimableRedisJob
  • func NewFromJob(job Job, conn Conn) *ClaimableRedisJob
  • func (job *ClaimableRedisJob) Claim() (bool, error)
  • func (job *ClaimableRedisJob) GetKey() string
  • func (job *ClaimableRedisJob) PushKeyIntoQueue(queueName string) error
• type Conn
• type Job

Types

type ClaimableJob

type ClaimableJob interface {
	Claim() (bool, error)
	GetKey() string
	PushKeyIntoQueue(name string) error
}

ClaimableJob represents a job in the queue that can know if it should have action taken upon it

type ClaimableRedisJob

type ClaimableRedisJob struct {
	// contains filtered or unexported fields
}

ClaimableRedisJob implements ClaimableJob and stores/retrieves jobs from Redis

func New

func New(key string, conn Conn) *ClaimableRedisJob

New returns a new job

func NewFromJob

func NewFromJob(job Job, conn Conn) *ClaimableRedisJob

NewFromJob returns a new job based on a Job

func (*ClaimableRedisJob) Claim

func (job *ClaimableRedisJob) Claim() (bool, error)

Claim returns true when the caller succesfully claims the job

func (*ClaimableRedisJob) GetKey

func (job *ClaimableRedisJob) GetKey() string

GetKey returns the key to store the information about the job

func (*ClaimableRedisJob) PushKeyIntoQueue

func (job *ClaimableRedisJob) PushKeyIntoQueue(queueName string) error

PushKeyIntoQueue pushes a key into a queue

type Conn

type Conn interface {
	Do(commandName string, args ...interface{}) (interface{}, error)
}

Conn is what all claimable jobs require

type Job

type Job interface {
	GetKey() string
}

Job represents a job in the queue