counter

Documentation

Index

• type Counter
  • func NewCounter(initialValue uint64) Counter
  • func (c *Counter) Decrease(values ...uint64) error
  • func (c *Counter) DecreaseAndRead(values ...uint64) (uint64, error)
  • func (c *Counter) Format(f fmt.State, r rune)
  • func (c *Counter) Increase(values ...uint64) error
  • func (c *Counter) IncreaseAndRead(values ...uint64) (uint64, error)
  • func (c *Counter) Read() uint64
  • func (c *Counter) Set(value uint64)

Types

type Counter

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

func NewCounter

func NewCounter(initialValue uint64) Counter

NewCounter creates a new counter with the given initial value.

func (*Counter) Decrease

func (c *Counter) Decrease(values ...uint64) error

Decrease decreases the counter by the given value (thread-safe).

func (*Counter) DecreaseAndRead

func (c *Counter) DecreaseAndRead(values ...uint64) (uint64, error)

DecreaseAndRead decreases the counter by the given value (thread-safe) and returns the new value.

func (*Counter) Format

func (c *Counter) Format(f fmt.State, r rune)

Format implements fmt.Formatter (thread-safe).

func (*Counter) Increase

func (c *Counter) Increase(values ...uint64) error

Increase increases the counter by the given value (thread-safe).

func (*Counter) IncreaseAndRead

func (c *Counter) IncreaseAndRead(values ...uint64) (uint64, error)

IncreaseAndRead increases the counter by the given value (thread-safe) and returns the new value.

func (*Counter) Read

func (c *Counter) Read() uint64

Read returns the current value of the counter (thread-safe).

func (*Counter) Set

func (c *Counter) Set(value uint64)

Set sets the counter to the given value (thread-safe).