leaderredis

Documentation

Overview

Package leaderredis provides a redis driver for package leader

Index

• type Option
  • func WithExpiration(duration time.Duration) Option
  • func WithPollInterval(duration time.Duration) Option
• type RedisDriver
  • func NewRedisDriver(client redis.UniversalClient, keyer contract.Keyer, opts ...Option) *RedisDriver
  • func (r *RedisDriver) Campaign(ctx context.Context) error
  • func (r *RedisDriver) Resign(ctx context.Context) error

Types

type Option

type Option func(driver *RedisDriver)

Option is type of the options to config *RedisDriver

func WithExpiration

func WithExpiration(duration time.Duration) Option

WithExpiration is an option that configures the expiration of redis key. A new round of leader election will start after the key expires.

func WithPollInterval

func WithPollInterval(duration time.Duration) Option

WithPollInterval is an option that configures the poll interval of followers. The followers will periodically try to overthrown the leader, but only succeed when the leader key is missing in redis.

type RedisDriver

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

RedisDriver is a simple redis leader election implementation.

func NewRedisDriver

func NewRedisDriver(client redis.UniversalClient, keyer contract.Keyer, opts ...Option) *RedisDriver

NewRedisDriver creates the newly created *RedisDriver with the given configuration.

func (*RedisDriver) Campaign

func (r *RedisDriver) Campaign(ctx context.Context) error

Campaign starts the leader election using redis. It will bock until this node becomes leader or the context is expired.

func (*RedisDriver) Resign

func (r *RedisDriver) Resign(ctx context.Context) error

Resign gives up the leadership using redis. If the current node is not a leader, this is an no op.