worker

Documentation

Index

• func Run(key string, task CronJob)
• type CronJob
• type TestWorker
  • func (job TestWorker) Job() captain.Worker
  • func (job TestWorker) LockProvider() captain.LockProvider
  • func (job TestWorker) ResultProcessor() captain.ResultProcessor
  • func (job TestWorker) RuntimeProcessor() captain.RuntimeProcessor
  • func (job TestWorker) ShouldRun(key string) bool

Examples

• Run

Functions

func Run

func Run(key string, task CronJob)

Run a particular job

Example

package main

import (
	"github.com/fossapps/starter/mock"
	"github.com/fossapps/starter/worker"
)

func main() {
	mock := mock.ExampleMockJob{}
	worker.Run("key", mock)
}

Output:

running mock job

Types

type CronJob

type CronJob interface {
	Job() captain.Worker
	LockProvider() captain.LockProvider
	ResultProcessor() captain.ResultProcessor
	RuntimeProcessor() captain.RuntimeProcessor
	ShouldRun(key string) bool
}

CronJob any cron must satisfy this permission to run

type TestWorker

type TestWorker struct{}

TestWorker a sample worker

func (TestWorker) Job

func (job TestWorker) Job() captain.Worker

Job actual task to be performed by worker

func (TestWorker) LockProvider

func (job TestWorker) LockProvider() captain.LockProvider

LockProvider no lock provider implementation for now

func (TestWorker) ResultProcessor

func (job TestWorker) ResultProcessor() captain.ResultProcessor

ResultProcessor act on result

func (TestWorker) RuntimeProcessor

func (job TestWorker) RuntimeProcessor() captain.RuntimeProcessor

RuntimeProcessor monitors worker every tick

func (TestWorker) ShouldRun

func (job TestWorker) ShouldRun(key string) bool

ShouldRun returns weather or not this worker should run given a particular key