synctree

Documentation

Index

• Variables
• func NewRequest(peerId, spaceId, objectId string, heads []string, snapshotPath []string, ...) *objectmessages.Request
• func NewSyncHandler(tree SyncTree, syncClient SyncClient, spaceId string) syncdeps.ObjectSyncHandler
• type BroadcastOptions
• type BuildDeps
• type HeadNotifiable
• type InnerHeadUpdate
  • func (h *InnerHeadUpdate) Heads() []string
  • func (h *InnerHeadUpdate) Marshall(data objectmessages.ObjectMeta) ([]byte, error)
  • func (h *InnerHeadUpdate) MsgSize() (size uint64)
  • func (h *InnerHeadUpdate) ObjectType() spacesyncproto.ObjectType
  • func (h *InnerHeadUpdate) Prepare() error
• type InnerRequest
  • func (r *InnerRequest) Marshall() ([]byte, error)
  • func (r *InnerRequest) MsgSize() uint64
• type ListenerSetter
• type RequestFactory
  • func NewRequestFactory(spaceId string) RequestFactory
• type ResponsiblePeersGetter
• type SyncClient
  • func NewSyncClient(spaceId string, syncService sync.SyncService) SyncClient
• type SyncTree
  • func BuildSyncTreeOrGetRemote(ctx context.Context, id string, deps BuildDeps) (t SyncTree, err error)
  • func PutSyncTree(ctx context.Context, payload treestorage.TreeStorageCreatePayload, ...) (t SyncTree, err error)
• type TreeStats
• type TreeStatsCollector
  • func NewTreeStatsCollector(spaceId string) *TreeStatsCollector
  • func (t *TreeStatsCollector) Collect() []TreeStats
  • func (t *TreeStatsCollector) Register(tree *syncTree)
  • func (t *TreeStatsCollector) Unregister(tree SyncTree)

Variables

var (
	ErrUnexpectedMessageType  = errors.New("unexpected message type")
	ErrUnexpectedRequestType  = errors.New("unexpected request type")
	ErrUnexpectedResponseType = errors.New("unexpected response type")
)

var (
	ErrSyncTreeClosed  = errors.New("sync tree is closed")
	ErrSyncTreeDeleted = errors.New("sync tree is deleted")
)

var (
	ErrNoResponsiblePeers = errors.New("no responsible peers")
)

Functions

func NewRequest

func NewRequest(peerId, spaceId, objectId string, heads []string, snapshotPath []string, root *treechangeproto.RawTreeChangeWithId) *objectmessages.Request

func NewSyncHandler

func NewSyncHandler(tree SyncTree, syncClient SyncClient, spaceId string) syncdeps.ObjectSyncHandler

Types

type BroadcastOptions

type BroadcastOptions struct {
	EmptyPeers []string
}

type BuildDeps

type BuildDeps struct {
	SpaceId            string
	SyncClient         SyncClient
	Configuration      nodeconf.NodeConf
	HeadNotifiable     HeadNotifiable
	Listener           updatelistener.UpdateListener
	AclList            list.AclList
	SpaceStorage       spacestorage.SpaceStorage
	TreeStorage        objecttree.Storage
	OnClose            func(id string)
	SyncStatus         syncstatus.StatusUpdater
	PeerGetter         ResponsiblePeersGetter
	BuildObjectTree    objecttree.BuildObjectTreeFunc
	ValidateObjectTree objecttree.ValidatorFunc
	StatsCollector     *TreeStatsCollector
}

type HeadNotifiable

type HeadNotifiable interface {
	UpdateHeads(id string, heads []string)
}

type InnerHeadUpdate

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

func (*InnerHeadUpdate) Heads

func (h *InnerHeadUpdate) Heads() []string

func (*InnerHeadUpdate) Marshall

func (h *InnerHeadUpdate) Marshall(data objectmessages.ObjectMeta) ([]byte, error)

func (*InnerHeadUpdate) MsgSize

func (h *InnerHeadUpdate) MsgSize() (size uint64)

func (*InnerHeadUpdate) ObjectType

func (h *InnerHeadUpdate) ObjectType() spacesyncproto.ObjectType

func (*InnerHeadUpdate) Prepare

func (h *InnerHeadUpdate) Prepare() error

type InnerRequest

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

func (*InnerRequest) Marshall

func (r *InnerRequest) Marshall() ([]byte, error)

func (*InnerRequest) MsgSize

func (r *InnerRequest) MsgSize() uint64

type ListenerSetter

type ListenerSetter interface {
	SetListener(listener updatelistener.UpdateListener)
}

type RequestFactory

type RequestFactory interface {
	CreateHeadUpdate(t objecttree.ObjectTree, ignoredPeer string, added []*treechangeproto.RawTreeChangeWithId) (headUpdate *objectmessages.HeadUpdate, err error)
	CreateNewTreeRequest(peerId, objectId string) *objectmessages.Request
	CreateFullSyncRequest(peerId string, t objecttree.ObjectTree) (*objectmessages.Request, error)
	CreateResponseProducer(t objecttree.ObjectTree, theirHeads, theirSnapshotPath []string) (response.ResponseProducer, error)
}

func NewRequestFactory

func NewRequestFactory(spaceId string) RequestFactory

type ResponsiblePeersGetter

type ResponsiblePeersGetter interface {
	GetResponsiblePeers(ctx context.Context) (peers []peer.Peer, err error)
}

type SyncClient

type SyncClient interface {
	RequestFactory
	Broadcast(ctx context.Context, headUpdate *objectmessages.HeadUpdate) error
	SendTreeRequest(ctx context.Context, req syncdeps.Request, collector syncdeps.ResponseCollector) (err error)
	QueueRequest(ctx context.Context, req syncdeps.Request) (err error)
}

func NewSyncClient

func NewSyncClient(spaceId string, syncService sync.SyncService) SyncClient

type SyncTree

type SyncTree interface {
	ListenerSetter
	SyncWithPeer(ctx context.Context, p peer.Peer) (err error)
	// contains filtered or unexported methods
}

func BuildSyncTreeOrGetRemote

func BuildSyncTreeOrGetRemote(ctx context.Context, id string, deps BuildDeps) (t SyncTree, err error)

func PutSyncTree

func PutSyncTree(ctx context.Context, payload treestorage.TreeStorageCreatePayload, deps BuildDeps) (t SyncTree, err error)

type TreeStats

type TreeStats struct {
	TreeLen         int      `json:"tree_len"`
	SnapshotCounter int      `json:"snapshot_counter"`
	Heads           []string `json:"heads"`
	ObjectId        string   `json:"object_id"`
	SpaceId         string   `json:"space_id"`
	BuildTimeMillis int      `json:"build_time_millis"`
}

type TreeStatsCollector

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

func NewTreeStatsCollector

func NewTreeStatsCollector(spaceId string) *TreeStatsCollector

func (*TreeStatsCollector) Collect

func (t *TreeStatsCollector) Collect() []TreeStats

func (*TreeStatsCollector) Register

func (t *TreeStatsCollector) Register(tree *syncTree)

func (*TreeStatsCollector) Unregister

func (t *TreeStatsCollector) Unregister(tree SyncTree)