job

Documentation

Index

• type Job
  • func (j *Job) Execute()
  • func (Job) Mail(payload string) (bool, error)
  • func (Job) PutOnFailed(queue, payload string, db *gorm.DB, err error)
  • func (j *Job) Schedule(queueName string, redis *redis.Client)
• type MailStruct
• type Param

Types

type Job

type Job struct {
	Name       string
	MethodName string
	Params     Param
	Queue      string
}

Job structure will be used to handle every jobs. Every method (except "Schedule" and "Execute") accept only one string parameter. This param will be decoded into a specific structure (manually defined into your job). Redis and MySQL is mandatory to use this feature. Redis will be used to handle every queue and MySQL to store failed jobs.

func (*Job) Execute

func (j *Job) Execute()

Execute specific job

func (Job) Mail

func (Job) Mail(payload string) (bool, error)

Mail method will sends an email The payload must be a JSON object compliant with the MailStruct structure.

func (Job) PutOnFailed

func (Job) PutOnFailed(queue, payload string, db *gorm.DB, err error)

PutOnFailed inserts failed job in failed_job table

func (*Job) Schedule

func (j *Job) Schedule(queueName string, redis *redis.Client)

Schedule specific job

type MailStruct

type MailStruct struct {
	To      []string `json:"to"`
	Message string   `json:"message"`
}

type Param

type Param struct {
	Name    string
	Payload string
	Type    string
}