dcounter

README

DCounter

DCounter is a distributed counter library for golang.

Usage

• Install

go get github.com/rashadansari/dcounter

• Example

package main

import (
	"github.com/rashadansari/dcounter"

	"log"
	"time"

	"github.com/go-redis/redis"
)

type Counter struct {
	value int64
}

func (c *Counter) GetLastValue(key string) (int64, error) {
	return c.value, nil
}

func (c *Counter) SetLastValue(key string, count int64, payload interface{}) error {
	c.value = count
	return nil
}

func main() {
	redisOptions := &redis.Options{
		Addr: "127.0.0.1:6379",
	}
	redisClient := redis.NewClient(redisOptions)

	counter := &Counter{
		value: 0,
	}
	options := &dcounter.Options{
		Counter:     counter,
		RedisClient: redisClient,
	}
	dc := dcounter.New("name", options)

	key := "key"
	it := 100

	for i := 0; i < it; i++ {
		go func() {
			count, err := dc.Inc(key)
			if err != nil {
				log.Printf("inc err: %s", err)
			} else {
				log.Printf("inc value: %d", count)
			}
		}()
	}

	time.Sleep(20 * time.Second)
	log.Printf("counter value: %d", counter.value)

	for i := 0; i < it; i++ {
		go func() {
			count, err := dc.Dec(key)
			if err != nil {
				log.Printf("dec err: %s", err)
			} else {
				log.Printf("dec value: %d", count)
			}
		}()
	}

	time.Sleep(20 * time.Second)
	log.Printf("counter value: %d", counter.value)
}

Documentation

Index

• Constants
• type Counter
• type CounterResponse
• type DCounter
  • func New(name string, opt *Options) *DCounter
  • func (dc *DCounter) AsyncDec(key string) (chan CounterResponse, error)
  • func (dc *DCounter) AsyncDecWithPayload(key string, payload interface{}) (chan CounterResponse, error)
  • func (dc *DCounter) AsyncInc(key string) (chan CounterResponse, error)
  • func (dc *DCounter) AsyncIncWithPayload(key string, payload interface{}) (chan CounterResponse, error)
  • func (dc *DCounter) Dec(key string) (int64, error)
  • func (dc *DCounter) DecWithPayload(key string, payload interface{}) (int64, error)
  • func (dc *DCounter) Inc(key string) (int64, error)
  • func (dc *DCounter) IncWithPayload(key string, payload interface{}) (int64, error)
• type Options

Constants

const (
	RedisCounterPostfix = "-counter"
	RedisLockPostfix    = "-lock"
)

Types

type Counter

type Counter interface {
	GetLastValue(key string) (int64, error)
	SetLastValue(key string, value int64, payload interface{}) error
}

type CounterResponse

type CounterResponse struct {
	Value int64
	Error error
}

type DCounter

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

func New

func New(name string, opt *Options) *DCounter

func (*DCounter) AsyncDec

func (dc *DCounter) AsyncDec(key string) (chan CounterResponse, error)

func (*DCounter) AsyncDecWithPayload

func (dc *DCounter) AsyncDecWithPayload(key string, payload interface{}) (chan CounterResponse, error)

func (*DCounter) AsyncInc

func (dc *DCounter) AsyncInc(key string) (chan CounterResponse, error)

func (*DCounter) AsyncIncWithPayload

func (dc *DCounter) AsyncIncWithPayload(key string, payload interface{}) (chan CounterResponse, error)

func (*DCounter) Dec

func (dc *DCounter) Dec(key string) (int64, error)

func (*DCounter) DecWithPayload

func (dc *DCounter) DecWithPayload(key string, payload interface{}) (int64, error)

func (*DCounter) Inc

func (dc *DCounter) Inc(key string) (int64, error)

func (*DCounter) IncWithPayload

func (dc *DCounter) IncWithPayload(key string, payload interface{}) (int64, error)

type Options

type Options struct {
	Counter          Counter
	RedisClient      *redis.Client
	RedisLock        *redislock.Client
	RedisLockTimeout time.Duration
	RedisLockOptions *redislock.Options
	CounterPoolSize  int
}