collection

Documentation

Index

• Variables
• type Bucket
• type Cache
  • func NewCache(expire time.Duration, opts ...CacheOption) (*Cache, error)
  • func (c *Cache) Del(key string)
  • func (c *Cache) Get(key string) (any, bool)
  • func (c *Cache) Set(key string, value any)
  • func (c *Cache) SetWithExpire(key string, value any, expire time.Duration)
  • func (c *Cache) Take(key string, fetch func() (any, error)) (any, error)
• type CacheOption
  • func WithLimit(limit int) CacheOption
  • func WithName(name string) CacheOption
• type Execute
• type Queue
  • func NewQueue(size int) *Queue
  • func (q *Queue) Empty() bool
  • func (q *Queue) Put(element any)
  • func (q *Queue) Take() (any, bool)
• type Ring
  • func NewRing(n int) *Ring
  • func (r *Ring) Add(v any)
  • func (r *Ring) Take() []any
• type RollingWindow
  • func NewRollingWindow(size int, interval time.Duration, opts ...RollingWindowOption) *RollingWindow
  • func (rw *RollingWindow) Add(v float64)
  • func (rw *RollingWindow) Reduce(fn func(b *Bucket))
• type RollingWindowOption
  • func IgnoreCurrentBucket() RollingWindowOption
• type SafeMap
  • func NewSafeMap() *SafeMap
  • func (m *SafeMap) Del(key any)
  • func (m *SafeMap) Get(key any) (any, bool)
  • func (m *SafeMap) Range(f func(key, val any) bool)
  • func (m *SafeMap) Set(key, value any)
  • func (m *SafeMap) Size() int
• type Set
  • func NewSet() *Set
  • func NewUnmanagedSet() *Set
  • func (s *Set) Add(i ...any)
  • func (s *Set) AddInt(ii ...int)
  • func (s *Set) AddInt64(ii ...int64)
  • func (s *Set) AddStr(ss ...string)
  • func (s *Set) AddUint(ii ...uint)
  • func (s *Set) AddUint64(ii ...uint64)
  • func (s *Set) Contains(i any) bool
  • func (s *Set) Count() int
  • func (s *Set) Keys() []any
  • func (s *Set) KeysInt() []int
  • func (s *Set) KeysInt64() []int64
  • func (s *Set) KeysStr() []string
  • func (s *Set) KeysUint() []uint
  • func (s *Set) KeysUint64() []uint64
  • func (s *Set) Remove(i any)
• type TimingWheel
  • func NewTimingWheel(interval time.Duration, numSlots int, execute Execute) (*TimingWheel, error)
  • func NewTimingWheelWithTicker(interval time.Duration, numSlots int, execute Execute, ticker timex.Ticker) (*TimingWheel, error)
  • func (tw *TimingWheel) Drain(fn func(key, value any)) error
  • func (tw *TimingWheel) MoveTimer(key any, delay time.Duration) error
  • func (tw *TimingWheel) RemoveTimer(key any) error
  • func (tw *TimingWheel) SetTimer(key, value any, delay time.Duration) error
  • func (tw *TimingWheel) Stop()

Variables

var (
	ErrClosed   = errors.New("TimingWheel is closed already")
	ErrArgument = errors.New("incorrect task argument")
)

Types

type Bucket

type Bucket struct {
	Sum   float64
	Count int64
}

Bucket defines the bucket that holds sum and num of additions.

type Cache

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

A Cache object is an in-memory cache.

func NewCache

func NewCache(expire time.Duration, opts ...CacheOption) (*Cache, error)

NewCache returns a Cache with given expire.

func (*Cache) Del

func (c *Cache) Del(key string)

Del deletes the item with the given key from c.

func (*Cache) Get

func (c *Cache) Get(key string) (any, bool)

Get returns the item with the given key from c.

func (*Cache) Set

func (c *Cache) Set(key string, value any)

Set sets value into c with key.

func (*Cache) SetWithExpire

func (c *Cache) SetWithExpire(key string, value any, expire time.Duration)

SetWithExpire sets value into c with key and expire with the given value.

func (*Cache) Take

func (c *Cache) Take(key string, fetch func() (any, error)) (any, error)

Take returns the item with the given key. If the item is in c, return it directly. If not, use fetch method to get the item, set into c and return it.

type CacheOption

type CacheOption func(cache *Cache)

CacheOption defines the method to customize a Cache.

func WithLimit

func WithLimit(limit int) CacheOption

WithLimit customizes a Cache with items up to limit.

func WithName

func WithName(name string) CacheOption

WithName customizes a Cache with the given name.

type Execute

type Execute func(key, value any)

Execute defines the method to execute the task.

type Queue

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

A Queue is a FIFO queue.

func NewQueue

func NewQueue(size int) *Queue

NewQueue returns a Queue object.

func (*Queue) Empty

func (q *Queue) Empty() bool

Empty checks if q is empty.

func (*Queue) Put

func (q *Queue) Put(element any)

Put puts element into q at the last position.

func (*Queue) Take

func (q *Queue) Take() (any, bool)

Take takes the first element out of q if not empty.

type Ring

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

A Ring can be used as fixed size ring.

func NewRing

func NewRing(n int) *Ring

NewRing returns a Ring object with the given size n.

func (*Ring) Add

func (r *Ring) Add(v any)

Add adds v into r.

func (*Ring) Take

func (r *Ring) Take() []any

Take takes all items from r.

type RollingWindow

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

RollingWindow defines a rolling window to calculate the events in buckets with time interval.

func NewRollingWindow

func NewRollingWindow(size int, interval time.Duration, opts ...RollingWindowOption) *RollingWindow

NewRollingWindow returns a RollingWindow that with size buckets and time interval, use opts to customize the RollingWindow.

func (*RollingWindow) Add

func (rw *RollingWindow) Add(v float64)

Add adds value to current bucket.

func (*RollingWindow) Reduce

func (rw *RollingWindow) Reduce(fn func(b *Bucket))

Reduce runs fn on all buckets, ignore current bucket if ignoreCurrent was set.

type RollingWindowOption

type RollingWindowOption func(rollingWindow *RollingWindow)

RollingWindowOption let callers customize the RollingWindow.

func IgnoreCurrentBucket

func IgnoreCurrentBucket() RollingWindowOption

IgnoreCurrentBucket lets the Reduce call ignore current bucket.

type SafeMap

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

SafeMap provides a map alternative to avoid memory leak. This implementation is not needed until issue below fixed. https://github.com/golang/go/issues/20135

func NewSafeMap

func NewSafeMap() *SafeMap

NewSafeMap returns a SafeMap.

func (*SafeMap) Del

func (m *SafeMap) Del(key any)

Del deletes the value with the given key from m.

func (*SafeMap) Get

func (m *SafeMap) Get(key any) (any, bool)

Get gets the value with the given key from m.

func (*SafeMap) Range

func (m *SafeMap) Range(f func(key, val any) bool)

Range calls f sequentially for each key and value present in the map. If f returns false, range stops the iteration.

func (*SafeMap) Set

func (m *SafeMap) Set(key, value any)

Set sets the value into m with the given key.

func (*SafeMap) Size

func (m *SafeMap) Size() int

Size returns the size of m.

type Set

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

Set is not thread-safe, for concurrent use, make sure to use it with synchronization.

func NewSet

func NewSet() *Set

NewSet returns a managed Set, can only put the values with the same type.

func NewUnmanagedSet

func NewUnmanagedSet() *Set

NewUnmanagedSet returns an unmanaged Set, which can put values with different types.

func (*Set) Add

func (s *Set) Add(i ...any)

Add adds i into s.

func (*Set) AddInt

func (s *Set) AddInt(ii ...int)

AddInt adds int values ii into s.

func (*Set) AddInt64

func (s *Set) AddInt64(ii ...int64)

AddInt64 adds int64 values ii into s.

func (*Set) AddStr

func (s *Set) AddStr(ss ...string)

AddStr adds string values ss into s.

func (*Set) AddUint

func (s *Set) AddUint(ii ...uint)

AddUint adds uint values ii into s.

func (*Set) AddUint64

func (s *Set) AddUint64(ii ...uint64)

AddUint64 adds uint64 values ii into s.

func (*Set) Contains

func (s *Set) Contains(i any) bool

Contains checks if i is in s.

func (*Set) Count

func (s *Set) Count() int

Count returns the number of items in s.

func (*Set) Keys

func (s *Set) Keys() []any

Keys returns the keys in s.

func (*Set) KeysInt

func (s *Set) KeysInt() []int

KeysInt returns the int keys in s.

func (*Set) KeysInt64

func (s *Set) KeysInt64() []int64

KeysInt64 returns int64 keys in s.

func (*Set) KeysStr

func (s *Set) KeysStr() []string

KeysStr returns string keys in s.

func (*Set) KeysUint

func (s *Set) KeysUint() []uint

KeysUint returns uint keys in s.

func (*Set) KeysUint64

func (s *Set) KeysUint64() []uint64

KeysUint64 returns uint64 keys in s.

func (*Set) Remove

func (s *Set) Remove(i any)

Remove removes i from s.

type TimingWheel

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

A TimingWheel is a timing wheel object to schedule tasks.

func NewTimingWheel

func NewTimingWheel(interval time.Duration, numSlots int, execute Execute) (*TimingWheel, error)

NewTimingWheel returns a TimingWheel.

func NewTimingWheelWithTicker

func NewTimingWheelWithTicker(interval time.Duration, numSlots int, execute Execute,
	ticker timex.Ticker) (*TimingWheel, error)

NewTimingWheelWithTicker returns a TimingWheel with the given ticker.

func (*TimingWheel) Drain

func (tw *TimingWheel) Drain(fn func(key, value any)) error

Drain drains all items and executes them.

func (*TimingWheel) MoveTimer

func (tw *TimingWheel) MoveTimer(key any, delay time.Duration) error

MoveTimer moves the task with the given key to the given delay.

func (*TimingWheel) RemoveTimer

func (tw *TimingWheel) RemoveTimer(key any) error

RemoveTimer removes the task with the given key.

func (*TimingWheel) SetTimer

func (tw *TimingWheel) SetTimer(key, value any, delay time.Duration) error

SetTimer sets the task value with the given key to the delay.

func (*TimingWheel) Stop

func (tw *TimingWheel) Stop()

Stop stops tw. No more actions after stopping a TimingWheel.