endpoint

Documentation

Overview

Package endpoint provides some specific factories to provide Endpoints to the sync library

Index

• func DefaultDirForURI(uri string) string
• func EndpointFromURI(uri string, otherUri string, browseOnly ...bool) (ep model.Endpoint, e error)
• func NewSnapshotFactory(configPath string, left model.Endpoint, right model.Endpoint) model.SnapshotFactory
• type PatchStore
  • func NewPatchStore(folderPath string, source model.Endpoint, target model.Endpoint) (*PatchStore, error)
  • func (p *PatchStore) Load(offset, limit int) (patches []merger.Patch, e error)
  • func (p *PatchStore) PublishPatch(patch merger.Patch)
  • func (p *PatchStore) Stop()
  • func (p *PatchStore) Store(patch merger.Patch)
• type SnapshotFactory
  • func (f *SnapshotFactory) Close(ctx context.Context) error
  • func (f *SnapshotFactory) Load(source model.PathSyncSource) (model.Snapshoter, error)
  • func (f *SnapshotFactory) Reset(ctx context.Context) error

Functions

func DefaultDirForURI

func DefaultDirForURI(uri string) string

DefaultDirForURI tries to find a default directory to display to user when they choose a specific endpoint. Currently only used for FS, returning ${HOMEDIR}/Cells

func EndpointFromURI

func EndpointFromURI(uri string, otherUri string, browseOnly ...bool) (ep model.Endpoint, e error)

EndpointFromURI parse an URI string to instantiate a proper Endpoint

func NewSnapshotFactory

func NewSnapshotFactory(configPath string, left model.Endpoint, right model.Endpoint) model.SnapshotFactory

NewSnapshotFactory opens a new SnapshotFactory.

Types

type PatchStore

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

PatchStore is a persistence layer for storing patches. It is based on BoltDB

func NewPatchStore

func NewPatchStore(folderPath string, source model.Endpoint, target model.Endpoint) (*PatchStore, error)

NewPatchStore opens a new PatchStore

func (*PatchStore) Load

func (p *PatchStore) Load(offset, limit int) (patches []merger.Patch, e error)

Load list all patches

func (*PatchStore) PublishPatch

func (p *PatchStore) PublishPatch(patch merger.Patch)

PublishPatch pushes patch to the persist queue

func (*PatchStore) Stop

func (p *PatchStore) Stop()

Stop closes the DB.

func (*PatchStore) Store

func (p *PatchStore) Store(patch merger.Patch)

Store pushes the patch to the DB.

type SnapshotFactory

type SnapshotFactory struct {
	sync.Mutex
	// contains filtered or unexported fields
}

SnapshotFactory implements model.SnapshotProvider interface for persisting snapshots in a BoltDB.

func (*SnapshotFactory) Close

func (f *SnapshotFactory) Close(ctx context.Context) error

Close closes the BoltDB.

func (*SnapshotFactory) Load

func (f *SnapshotFactory) Load(source model.PathSyncSource) (model.Snapshoter, error)

Load creates or loads an existing snapshot from within the application dir

func (*SnapshotFactory) Reset

func (f *SnapshotFactory) Reset(ctx context.Context) error

Reset clears all snapshots (left and right)