gokiq

README

Gokiq

Gokiq is a small library to easily enqueue Sidekiq jobs from Go.

Usage

import (
  "github.com/duosrx/gokiq"
  "github.com/garyburd/redigo/redis"
  "time"
)

// Create a Redis Pool first
pool := redis.NewPool(func() (redis.Conn, error) {
  c, err := redis.Dial("tcp", ":6379")
  if err != nil {
    return nil, err
  }
  return c, err
}, 3)

job := NewJob("HardWorder", "default", []string{"foo", "bar"})

// Enqueue immediately...
job.Enqueue(pool)

// ... or enqueue in the future
now := time.Now()
job.EnqueueAt(now, pool)

Documentation

Index

• type Job
  • func NewJob(class, queue string, args []interface{}, retry int) *Job
  • func (job *Job) Enqueue(pool *redis.Pool) error
  • func (job *Job) EnqueueAt(time time.Time, pool *redis.Pool) error
  • func (job *Job) EnqueueIn(duration time.Duration, pool *redis.Pool) error

Types

type Job

type Job struct {
	JID        string        `json:"jid"`
	Retry      int           `json:"retry"`
	Queue      string        `json:"queue"`
	Class      string        `json:"class"`
	Args       []interface{} `json:"args"`
	EnqueuedAt int64         `json:"enqueued_at"`
}

Job holds all the information about the job to be enqueued.

func NewJob

func NewJob(class, queue string, args []interface{}, retry int) *Job

NewJob initialize a new job given a class, queue and arguments.

func (*Job) Enqueue

func (job *Job) Enqueue(pool *redis.Pool) error

Enqueue inserts the job into the Sidekiq queue instantly.

func (*Job) EnqueueAt

func (job *Job) EnqueueAt(time time.Time, pool *redis.Pool) error

EnqueueAt insert the job into the Sidekiq scheduled queue at the given time.

func (*Job) EnqueueIn

func (job *Job) EnqueueIn(duration time.Duration, pool *redis.Pool) error

EnqueueIn insert the job into the queue after the given duration.