sync

Documentation

Index

• Constants
• Variables
• type Chunk
  • func NewChunk(blockChain *core.BlockChain) *Chunk
• type Service
  • func NewService(blockChain *core.BlockChain, netService net.Service) *Service
  • func (ss *Service) IsActiveSyncing() bool
  • func (ss *Service) Start()
  • func (ss *Service) StartActiveSync() bool
  • func (ss *Service) Stop()
  • func (ss *Service) StopActiveSync()
  • func (ss *Service) WaitingForFinish()
• type Task
  • func NewTask(blockChain *core.BlockChain, netService net.Service, chunk *Chunk) *Task
  • func (st *Task) Start()
  • func (st *Task) Stop()

Constants

const (
	MaxChunkPerSyncRequest       = 10
	ConcurrentSyncChunkDataCount = 10
	GetChunkDataTimeout          = 10 // 10s.
)

Contants

Variables

var (
	ErrInvalidChainSyncMessageData     = errors.New("invalid ChainSync message data")
	ErrInvalidChainGetChunkMessageData = errors.New("invalid ChainGetChunk message data")
)

Errors

var (
	ErrInvalidChainChunksMessageData    = errors.New("invalid ChainChunks message data")
	ErrWrongChainChunksMessageData      = errors.New("wrong ChainChunks message data")
	ErrInvalidChainChunkDataMessageData = errors.New("invalid ChainChunkData message data")
	ErrWrongChainChunkDataMessageData   = errors.New("wrong ChainChunkData message data")
	ErrInvalidChunkHeaderSourcePeer     = errors.New("invalid chunk headers source peer")
)

Errors

var (
	ErrTooSmallGapToSync        = errors.New("the gap between syncpoint and current tail is smaller than a dynasty interval, ignore the sync task")
	ErrCannotFindBlockByHeight  = errors.New("cannot find the block at given height")
	ErrCannotFindBlockByHash    = errors.New("cannot find the block with the given hash")
	ErrWrongChunkHeaderRootHash = errors.New("wrong chunk header root hash")
	ErrWrongChunkDataRootHash   = errors.New("wrong chunk data root hash")
	ErrWrongChunkDataSize       = errors.New("wrong chunk data size")
	ErrInvalidBlockHashInChunk  = errors.New("invalid block hash in chunk data")
	ErrWrongBlockHashInChunk    = errors.New("wrong block hash in chunk data compared with chunk header")
)

Error Types

Types

type Chunk

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

Chunk packs some blocks

func NewChunk

func NewChunk(blockChain *core.BlockChain) *Chunk

NewChunk return a new chunk

type Service

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

Service manage sync tasks

func NewService

func NewService(blockChain *core.BlockChain, netService net.Service) *Service

NewService return new Service.

func (*Service) IsActiveSyncing

func (ss *Service) IsActiveSyncing() bool

IsActiveSyncing return if there is active task now

func (*Service) Start

func (ss *Service) Start()

Start start sync service.

func (*Service) StartActiveSync

func (ss *Service) StartActiveSync() bool

StartActiveSync starts an active sync task

func (*Service) Stop

func (ss *Service) Stop()

Stop stop sync service.

func (*Service) StopActiveSync

func (ss *Service) StopActiveSync()

StopActiveSync stops current sync task

func (*Service) WaitingForFinish

func (ss *Service) WaitingForFinish()

WaitingForFinish wait for finishing current sync task

type Task

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

Task is a sync task

func NewTask

func NewTask(blockChain *core.BlockChain, netService net.Service, chunk *Chunk) *Task

NewTask return a new sync task

func (*Task) Start

func (st *Task) Start()

Start the sync task

func (*Task) Stop

func (st *Task) Stop()

Stop the sync task