sync

Documentation

Index

• type Config
  • func DefaultConfig() *Config
  • func (conf *Config) BasicCheck() error
  • func (conf *Config) CacheSize() int
  • func (conf *Config) SessionTimeout() time.Duration
• type MockSync
  • func MockingSync(ts *testsuite.TestSuite) *MockSync
  • func (*MockSync) ClockOffset() (time.Duration, error)
  • func (*MockSync) IsClockOutOfSync() bool
  • func (*MockSync) Moniker() string
  • func (m *MockSync) PeerSet() *peerset.PeerSet
  • func (m *MockSync) SelfID() peer.ID
  • func (m *MockSync) Services() service.Services
  • func (*MockSync) Start() error
  • func (*MockSync) Stop()
• type Synchronizer
  • func NewSynchronizer(conf *Config, valKeys []*bls.ValidatorKey, state state.Facade, ...) (Synchronizer, error)

Types

type Config

type Config struct {
	Moniker           string           `toml:"moniker"`
	SessionTimeoutStr string           `toml:"session_timeout"`
	Firewall          *firewall.Config `toml:"firewall"`

	// Private configs
	MaxSessions         int              `toml:"-"`
	BlockPerSession     uint32           `toml:"-"`
	BlockPerMessage     uint32           `toml:"-"`
	PruneWindow         uint32           `toml:"-"`
	LatestSupportingVer version.Version  `toml:"-"`
	Services            service.Services `toml:"-"`
}

func DefaultConfig

func DefaultConfig() *Config

func (*Config) BasicCheck

func (conf *Config) BasicCheck() error

BasicCheck performs basic checks on the configuration.

func (*Config) CacheSize

func (conf *Config) CacheSize() int

func (*Config) SessionTimeout

func (conf *Config) SessionTimeout() time.Duration

type MockSync

type MockSync struct {
	TestID       peer.ID
	TestPeerSet  *peerset.PeerSet
	TestServices service.Services
}

func MockingSync

func MockingSync(ts *testsuite.TestSuite) *MockSync

func (*MockSync) ClockOffset

func (*MockSync) ClockOffset() (time.Duration, error)

func (*MockSync) IsClockOutOfSync

func (*MockSync) IsClockOutOfSync() bool

func (*MockSync) Moniker

func (*MockSync) Moniker() string

func (*MockSync) PeerSet

func (m *MockSync) PeerSet() *peerset.PeerSet

func (*MockSync) SelfID

func (m *MockSync) SelfID() peer.ID

func (*MockSync) Services

func (m *MockSync) Services() service.Services

func (*MockSync) Start

func (*MockSync) Start() error

func (*MockSync) Stop

func (*MockSync) Stop()

type Synchronizer

type Synchronizer interface {
	Start() error
	Stop()
	Moniker() string
	SelfID() peer.ID
	PeerSet() *peerset.PeerSet
	Services() service.Services
	ClockOffset() (time.Duration, error)
	IsClockOutOfSync() bool
}

func NewSynchronizer

func NewSynchronizer(
	conf *Config,
	valKeys []*bls.ValidatorKey,
	state state.Facade,
	consMgr consensus.Manager,
	network network.Network,
	broadcastCh <-chan message.Message,
) (Synchronizer, error)