sync

Documentation

Index

• Variables
• type Config
  • func DefaultConfig() *Config
  • func (conf *Config) BasicCheck() error
• type MockSync
  • func MockingSync(ts *testsuite.TestSuite) *MockSync
  • func (m *MockSync) Moniker() string
  • func (m *MockSync) PeerSet() *peerset.PeerSet
  • func (m *MockSync) SelfID() peer.ID
  • func (m *MockSync) Start() error
  • func (m *MockSync) Stop()
• type Synchronizer
  • func NewSynchronizer(conf *Config, valKeys []*bls.ValidatorKey, state state.Facade, ...) (Synchronizer, error)

Variables

var LatestBlockInterval = uint32(720) // 720 blocks is about two hours

Types

type Config

type Config struct {
	Moniker         string           `toml:"moniker"`
	SessionTimeout  time.Duration    `toml:"session_timeout"`
	BlockPerMessage uint32           `toml:"block_per_message"` // TODO: Does the user need to change it?
	CacheSize       int              `toml:"cache_size"`        // TODO: Does the user need to change it?
	NodeNetwork     bool             `toml:"node_network"`
	Firewall        *firewall.Config `toml:"firewall"`
}

func DefaultConfig

func DefaultConfig() *Config

func (*Config) BasicCheck

func (conf *Config) BasicCheck() error

BasicCheck performs basic checks on the configuration.

type MockSync

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

func MockingSync

func MockingSync(ts *testsuite.TestSuite) *MockSync

func (*MockSync) Moniker

func (m *MockSync) Moniker() string

func (*MockSync) PeerSet

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

func (*MockSync) SelfID

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

func (*MockSync) Start

func (m *MockSync) Start() error

func (*MockSync) Stop

func (m *MockSync) Stop()

type Synchronizer

type Synchronizer interface {
	Start() error
	Stop()
	Moniker() string
	SelfID() peer.ID
	PeerSet() *peerset.PeerSet
}

func NewSynchronizer

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