driver

Documentation

Index

• Constants
• Variables
• func GetKeyPre(serviceName string) string
• func GetNodeId(serviceName string) string
• func GetNodeIdKeyPrefix() string
• func SetNodeIdKeyPrefix(prefix string)
• func TimePre(t time.Time, preDuration time.Duration) int64
• type DriverV2
  • func NewEtcdDriver(etcdCli *etcdv3.Client) DriverV2
  • func NewRedisDriver(redisClient *redis.Client) DriverV2
  • func NewRedisZSetDriver(redisClient *redis.Client) DriverV2
• type EtcdDriver
  • func (e *EtcdDriver) GetNodes(ctx context.Context) (nodes []string, err error)
  • func (e *EtcdDriver) Init(serverName string, opts ...Option)
  • func (e *EtcdDriver) NodeID() string
  • func (e *EtcdDriver) Start(ctx context.Context) (err error)
  • func (e *EtcdDriver) Stop(ctx context.Context) (err error)
  • func (e *EtcdDriver) WithOption(opt Option) (err error)
• type Option
• type RedisDriver
  • func (rd *RedisDriver) GetNodes(ctx context.Context) (nodes []string, err error)
  • func (rd *RedisDriver) Init(serviceName string, opts ...Option)
  • func (rd *RedisDriver) NodeID() string
  • func (rd *RedisDriver) Start(ctx context.Context) (err error)
  • func (rd *RedisDriver) Stop(ctx context.Context) (err error)
  • func (rd *RedisDriver) WithOption(opt Option) (err error)
• type RedisZSetDriver
  • func (rd *RedisZSetDriver) GetNodes(ctx context.Context) (nodes []string, err error)
  • func (rd *RedisZSetDriver) Init(serviceName string, opts ...Option)
  • func (rd *RedisZSetDriver) NodeID() string
  • func (rd *RedisZSetDriver) Start(ctx context.Context) (err error)
  • func (rd *RedisZSetDriver) Stop(ctx context.Context) (err error)
  • func (rd *RedisZSetDriver) WithOption(opt Option) (err error)
• type TimeoutOption
  • func NewTimeoutOption(timeout time.Duration) TimeoutOption
  • func (to TimeoutOption) Type() int

Constants

const GlobalKeyPrefix = "Distributed-Cron:"

GlobalKeyPrefix is a global redis key prefix

const (
	OptionTypeTimeout = 0x600
)

Variables

var KeyPreFix string

Functions

func GetKeyPre

func GetKeyPre(serviceName string) string

func GetNodeId

func GetNodeId(serviceName string) string

func GetNodeIdKeyPrefix

func GetNodeIdKeyPrefix() string

func SetNodeIdKeyPrefix

func SetNodeIdKeyPrefix(prefix 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 task. 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.

func NewEtcdDriver

func NewEtcdDriver(etcdCli *etcdv3.Client) DriverV2

func NewRedisDriver

func NewRedisDriver(redisClient *redis.Client) DriverV2

func NewRedisZSetDriver

func NewRedisZSetDriver(redisClient *redis.Client) DriverV2

type EtcdDriver

type EtcdDriver struct {
	// contains filtered or unexported fields
}

func (*EtcdDriver) GetNodes

func (e *EtcdDriver) GetNodes(ctx context.Context) (nodes []string, err error)

func (*EtcdDriver) Init

func (e *EtcdDriver) Init(serverName string, opts ...Option)

func (*EtcdDriver) NodeID

func (e *EtcdDriver) NodeID() string

func (*EtcdDriver) Start

func (e *EtcdDriver) Start(ctx context.Context) (err error)

func (*EtcdDriver) Stop

func (e *EtcdDriver) Stop(ctx context.Context) (err error)

func (*EtcdDriver) WithOption

func (e *EtcdDriver) WithOption(opt Option) (err error)

type Option

type Option interface {
	Type() int
}

type RedisDriver

type RedisDriver struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func (*RedisDriver) GetNodes

func (rd *RedisDriver) GetNodes(ctx context.Context) (nodes []string, err error)

func (*RedisDriver) Init

func (rd *RedisDriver) Init(serviceName string, opts ...Option)

func (*RedisDriver) NodeID

func (rd *RedisDriver) NodeID() string

func (*RedisDriver) Start

func (rd *RedisDriver) Start(ctx context.Context) (err error)

func (*RedisDriver) Stop

func (rd *RedisDriver) Stop(ctx context.Context) (err error)

func (*RedisDriver) WithOption

func (rd *RedisDriver) WithOption(opt Option) (err error)

type RedisZSetDriver

type RedisZSetDriver struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func (*RedisZSetDriver) GetNodes

func (rd *RedisZSetDriver) GetNodes(ctx context.Context) (nodes []string, err error)

func (*RedisZSetDriver) Init

func (rd *RedisZSetDriver) Init(serviceName string, opts ...Option)

func (*RedisZSetDriver) NodeID

func (rd *RedisZSetDriver) NodeID() string

func (*RedisZSetDriver) Start

func (rd *RedisZSetDriver) Start(ctx context.Context) (err error)

func (*RedisZSetDriver) Stop

func (rd *RedisZSetDriver) Stop(ctx context.Context) (err error)

func (*RedisZSetDriver) WithOption

func (rd *RedisZSetDriver) WithOption(opt Option) (err error)

type TimeoutOption

type TimeoutOption struct {
	// contains filtered or unexported fields
}

func NewTimeoutOption

func NewTimeoutOption(timeout time.Duration) TimeoutOption

func (TimeoutOption) Type

func (to TimeoutOption) Type() int