seedmanager

Documentation

Index

• Constants
• type Expiration
• type Seed
  • func SeedFromBytes(slice []byte) *Seed
• type SeedGenerator
  • func (sg *SeedGenerator) Next() (*Seed, error)
• type SeedManager
  • func New() *SeedManager
  • func NewSpecified(ttl time.Duration, cleanPeriod time.Duration) *SeedManager
  • func (sm *SeedManager) Add(seed Seed, pulse insolar.PulseNumber)
  • func (sm *SeedManager) Pop(seed Seed) (insolar.PulseNumber, bool)
  • func (sm *SeedManager) Stop()

Constants

const DefaultCleanPeriod = 5 * time.Second

DefaultCleanPeriod default time period for launching cleaning goroutine

const DefaultTTL = 5 * time.Second

DefaultTTL is default time period for deleting expired seeds

const SeedSize uint = 32

SeedSize is size of seed

Types

type Expiration

type Expiration = int64

Expiration represents time of expiration

type Seed

type Seed = [SeedSize]byte

Seed is a type of seed

func SeedFromBytes

func SeedFromBytes(slice []byte) *Seed

SeedFromBytes converts slice of bytes to Seed. Returns nil if slice's size is not equal to SeedSize

type SeedGenerator

type SeedGenerator struct {
}

SeedGenerator holds logic with seed generation

func (*SeedGenerator) Next

func (sg *SeedGenerator) Next() (*Seed, error)

Next returns next random seed

type SeedManager

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

SeedManager manages working with seed pool It's thread safe

func New

func New() *SeedManager

New creates new seed manager with default params

func NewSpecified

func NewSpecified(ttl time.Duration, cleanPeriod time.Duration) *SeedManager

NewSpecified creates new seed manager with custom params

func (*SeedManager) Add

func (sm *SeedManager) Add(seed Seed, pulse insolar.PulseNumber)

Add adds seed to pool

func (*SeedManager) Pop

func (sm *SeedManager) Pop(seed Seed) (insolar.PulseNumber, bool)

Exists checks whether seed in the pool

func (*SeedManager) Stop

func (sm *SeedManager) Stop()