cronworker

README

Example

Create delivery handler

package workerhandler

import (
	"context"
	"fmt"
	"time"

	"github.com/golangid/candi/codebase/factory/types"
	"github.com/golangid/candi/candihelper"
	"github.com/golangid/candi/logger"
	"github.com/golangid/candi/tracer"
)

// CronHandler struct
type CronHandler struct {
}

// NewCronHandler constructor
func NewCronHandler() *CronHandler {
	return &CronHandler{}
}

// MountHandlers return group map topic key to handler func
func (h *CronHandler) MountHandlers(group *types.WorkerHandlerGroup) {

	group.Add(candihelper.CronJobKeyToString("push-notif", "message", "30s"), h.handlePushNotif)
	group.Add(candihelper.CronJobKeyToString("heavy-push-notif", "message", "22:43:07"), h.handleHeavyPush)
}

func (h *CronHandler) handlePushNotif(ctx context.Context, message []byte) error {
	trace := tracer.StartTrace(ctx, "CronDelivery-HandlePushNotif")
	defer trace.Finish()

	logger.LogI("processing")
	logger.LogI("done")
	return nil
}

func (h *CronHandler) handleHeavyPush(ctx context.Context, message []byte) error {
	trace := tracer.StartTrace(ctx, "CronDelivery-HandleHeavyPush")
	defer trace.Finish()

	fmt.Println("processing")
	time.Sleep(30 * time.Second)
	fmt.Println("done")
	return nil
}

Register in module

package examplemodule

import (

	"example.service/internal/modules/examplemodule/delivery/workerhandler"

	"github.com/golangid/candi/codebase/factory/dependency"
	"github.com/golangid/candi/codebase/factory/types"
	"github.com/golangid/candi/codebase/interfaces"
)

type Module struct {
	// ...another delivery handler
	workerHandlers map[types.Worker]interfaces.WorkerHandler
}

func NewModules(deps dependency.Dependency) *Module {
	return &Module{
		workerHandlers: map[types.Worker]interfaces.WorkerHandler{
			// ...another worker handler
			// ...
			types.Scheduler: workerhandler.NewCronHandler(),
		},
	}
}

// ...another method

Documentation

Index

• func AddJob(job Job) error
• func CreateCronJobKey(jobName, args, interval string) string
• func NewWorker(service factory.ServiceFactory, opts ...OptionFunc) factory.AppServerFactory
• func ParseCronJobKey(str string) (jobName, args, interval string)
• func UpdateIntervalActiveJob(jobNumber int, newInterval string) (err error)
• type CronJobKey
  • func (c CronJobKey) String() string
• type Job
  • func GetActiveJobs() []*Job
• type OptionFunc
  • func SetConsul(consul *candiutils.Consul) OptionFunc
  • func SetDebugMode(debugMode bool) OptionFunc
  • func SetLocker(locker candiutils.Locker) OptionFunc
  • func SetMaxGoroutines(maxGoroutines int) OptionFunc

Functions

func AddJob

func AddJob(job Job) error

AddJob to cron worker

func CreateCronJobKey

func CreateCronJobKey(jobName, args, interval string) string

CreateCronJobKey helper

Allowed interval:

* standard time duration string, example: 2s, 10m

* custom start time and repeat duration, example:

• 23:00@daily, will repeated at 23:00 every day
• 23:00@weekly, will repeated at 23:00 every week
• 23:00@10s, will repeated at 23:00 and next repeat every 10 seconds

func NewWorker

func NewWorker(service factory.ServiceFactory, opts ...OptionFunc) factory.AppServerFactory

NewWorker create new cron worker

func ParseCronJobKey

func ParseCronJobKey(str string) (jobName, args, interval string)

ParseCronJobKey helper

func UpdateIntervalActiveJob

func UpdateIntervalActiveJob(jobNumber int, newInterval string) (err error)

UpdateIntervalActiveJob update active job

Types

type CronJobKey

type CronJobKey struct {
	JobName  string `json:"jobName"`
	Args     string `json:"args"`
	Interval string `json:"interval"`
}

CronJobKey model

func (CronJobKey) String

func (c CronJobKey) String() string

String implement stringer

type Job

type Job struct {
	HandlerName string              `json:"handler_name"`
	Interval    string              `json:"interval"`
	Handler     types.WorkerHandler `json:"-"`
	Params      string              `json:"params"`
	WorkerIndex int                 `json:"worker_index"`
	// contains filtered or unexported fields
}

Job model

func GetActiveJobs

func GetActiveJobs() []*Job

GetActiveJobs get registered jobs

type OptionFunc

type OptionFunc func(*option)

OptionFunc type

func SetConsul

func SetConsul(consul *candiutils.Consul) OptionFunc

SetConsul option func

func SetDebugMode

func SetDebugMode(debugMode bool) OptionFunc

SetDebugMode option func

func SetLocker

func SetLocker(locker candiutils.Locker) OptionFunc

SetLocker option func

func SetMaxGoroutines

func SetMaxGoroutines(maxGoroutines int) OptionFunc

SetMaxGoroutines option func