counters

Documentation

Index

• type PersistentAutoDecrementCounter
  • func NewPersistentAutoDecrementCounter(ctx context.Context, gcsClient gcs.GCSClient, path string, d time.Duration) (*PersistentAutoDecrementCounter, error)
  • func (c *PersistentAutoDecrementCounter) Get() int64
  • func (c *PersistentAutoDecrementCounter) GetDecrementTimes() []time.Time
  • func (c *PersistentAutoDecrementCounter) Inc(ctx context.Context) error
  • func (c *PersistentAutoDecrementCounter) Reset(ctx context.Context) error

Types

type PersistentAutoDecrementCounter

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

PersistentAutoDecrementCounter is an AutoDecrementCounter which uses a file in GCS to persist its value between program restarts.

func NewPersistentAutoDecrementCounter

func NewPersistentAutoDecrementCounter(ctx context.Context, gcsClient gcs.GCSClient, path string, d time.Duration) (*PersistentAutoDecrementCounter, error)

NewPersistentAutoDecrementCounter returns a PersistentAutoDecrementCounter instance using the given file.

func (*PersistentAutoDecrementCounter) Get

func (c *PersistentAutoDecrementCounter) Get() int64

Get returns the current value of the PersistentAutoDecrementCounter.

func (*PersistentAutoDecrementCounter) GetDecrementTimes

func (c *PersistentAutoDecrementCounter) GetDecrementTimes() []time.Time

GetDecrementTimes returns a slice of time.Time which indicate *roughly* when the counter will be decremented. This is informational only, and the caller should not rely on the times to be perfectly accurate.

func (*PersistentAutoDecrementCounter) Inc

func (c *PersistentAutoDecrementCounter) Inc(ctx context.Context) error

Inc increments the PersistentAutoDecrementCounter and schedules a decrement.

func (*PersistentAutoDecrementCounter) Reset

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

Reset resets the value of the PersistentAutoDecrementCounter to zero.