keycounter

Documentation

Overview

Package keycounter string型计数器

Index

• Variables
• func WithAutoRefreshInterval(autoRefreshInterval string) optparams.Option[Options]
• func WithKey(key string) optparams.Option[Options]
• func WithMaxTTL(maxTTL time.Duration) optparams.Option[Options]
• func WithNamespace(ns ...string) optparams.Option[Options]
• func WithSpecifiedKey(key string) optparams.Option[Options]
• func WithTaskCron(taskCron *cron.Cron) optparams.Option[Options]
• type Counter
  • func New(cli redis.UniversalClient, opts ...optparams.Option[Options]) (*Counter, error)
  • func (c *Counter) Len(ctx context.Context) (int64, error)
  • func (c *Counter) Next(ctx context.Context) (int64, error)
  • func (c *Counter) NextN(ctx context.Context, value int64) (int64, error)
  • func (c *Counter) Reset(ctx context.Context) error
• type Options

Variables

var Defaultopt = Options{
	MiddlewareOpts: []optparams.Option[middlewarehelper.Options]{},
}

Defaultopt 默认的可选配置

Functions

func WithAutoRefreshInterval

func WithAutoRefreshInterval(autoRefreshInterval string) optparams.Option[Options]

WithAutoRefreshInterval 设置自动刷新过期时间的设置

func WithKey

func WithKey(key string) optparams.Option[Options]

WithKey 中间件通用设置,指定使用的键,注意设置后namespace依然有效

func WithMaxTTL

func WithMaxTTL(maxTTL time.Duration) optparams.Option[Options]

WithMaxTTL 设置token消减间隔时长,单位s

func WithNamespace

func WithNamespace(ns ...string) optparams.Option[Options]

WithNamespace 中间件通用设置,指定锁的命名空间

func WithSpecifiedKey

func WithSpecifiedKey(key string) optparams.Option[Options]

WithSpecifiedKey 中间件通用设置,指定使用的键,注意设置key后namespace将失效

func WithTaskCron

func WithTaskCron(taskCron *cron.Cron) optparams.Option[Options]

WithTaskCron 设置定时器

Types

type Counter

type Counter struct {
	*middlewarehelper.MiddleWareAbc
	// contains filtered or unexported fields
}

Counter 分布式计数器

func New

func New(cli redis.UniversalClient, opts ...optparams.Option[Options]) (*Counter, error)

New 创建一个新的位图对象 @params cli redis.UniversalClient redis客户端对象 @params opts ...optparams.Option[Options] 配置项

func (*Counter) Len

func (c *Counter) Len(ctx context.Context) (int64, error)

Len 当前的计数量 @params ctx context.Context 上下文信息,用于控制请求的结束

func (*Counter) Next

func (c *Counter) Next(ctx context.Context) (int64, error)

Next 加1后的当前计数值 如果设置了MaxTTL则会在执行好后刷新TTL @params ctx context.Context 上下文信息,用于控制请求的结束

func (*Counter) NextN

func (c *Counter) NextN(ctx context.Context, value int64) (int64, error)

NextN 加m后的当前计数 如果设置了MaxTTL则会在执行好后刷新TTL @params ctx context.Context 上下文信息,用于控制请求的结束 @params value int64 要增加的值.这个值可以为负

func (*Counter) Reset

func (c *Counter) Reset(ctx context.Context) error

Reset 重置当前计数器 @params ctx context.Context 上下文信息,用于控制请求的结束

type Options

type Options struct {
	MiddlewareOpts []optparams.Option[middlewarehelper.Options] //初始化Middleware的配置
}

Options broker的配置