commons

README

COMMONS

This is a mod for everyone who want to customize theirself dcron drivers.

Documentation

Index

• Constants
• func GetKeyPre(serviceName string) string
• func GetNodeId(serviceName string) string
• func TimePre(t time.Time, preDuration time.Duration) int64
• type DriverV2
• type LoggerOption
  • func NewLoggerOption(logger dlog.Logger) LoggerOption
  • func (to LoggerOption) Type() int
• type Option
• type TimeoutOption
  • func NewTimeoutOption(timeout time.Duration) TimeoutOption
  • func (to TimeoutOption) Type() int

Constants

const (
	OptionTypeTimeout = 0x600
	OptionTypeLogger  = 0x601
)

const GlobalKeyPrefix = "distributed-cron:"

GlobalKeyPrefix is a global redis key prefix

Functions

func GetKeyPre

func GetKeyPre(serviceName string) string

func GetNodeId

func GetNodeId(serviceName string) string

func TimePre

func TimePre(t time.Time, preDuration time.Duration) int64

Types

type DriverV2

type DriverV2 interface {
	// init driver
	Init(serviceName string, opts ...Option)
	// get nodeID
	NodeID() string
	// get nodes
	GetNodes(ctx context.Context) (nodes []string, err error)

	// register node to remote server (like etcd/redis),
	// will create a goroutine to keep the connection.
	// And then continue for other work.
	Start(ctx context.Context) (err error)

	// stop the goroutine of keep connection.
	Stop(ctx context.Context) (err error)

	WithOption(opt Option) (err error)
}

There is only one driver for one dcron. Tips for write a user-defined Driver by yourself.

1. Confirm that `Stop` and `Start` can be called for more times.
2. Must make `GetNodes` will return error when timeout.

type LoggerOption

type LoggerOption struct{ Logger dlog.Logger }

func NewLoggerOption

func NewLoggerOption(logger dlog.Logger) LoggerOption

func (LoggerOption) Type

func (to LoggerOption) Type() int

type Option

type Option interface {
	Type() int
}

type TimeoutOption

type TimeoutOption struct{ Timeout time.Duration }

func NewTimeoutOption

func NewTimeoutOption(timeout time.Duration) TimeoutOption

func (TimeoutOption) Type

func (to TimeoutOption) Type() int