syncapi

May 4, 2026

Changes in this version

+ func ValidatePairingSecret(secret string, tokens []*v1.Multihost_PairingToken, now time.Time) (*v1.Multihost_PairingToken, error)

type BackrestSyncStateHandler

+ func (h *BackrestSyncStateHandler) SetRemoteClientConfig(ctx context.Context, req *connect.Request[v1sync.SetRemoteClientConfigRequest]) (*connect.Response[v1sync.SetRemoteClientConfigResponse], error)

type SyncManager

+ func (m *SyncManager) GetConnectedPeer(keyID string) *connectedPeerHandle

Jan 16, 2026

Changes in this version

+ const PeerContextKey

+ func ContextWithPeer(ctx context.Context, peer *v1.Multihost_Peer) context.Context

+ func PeerFromContext(ctx context.Context) *v1.Multihost_Peer

Aug 4, 2025

Changes in this version

+ type BackrestSyncStateHandler struct

+ func NewBackrestSyncStateHandler(mgr *SyncManager) *BackrestSyncStateHandler

+ func (h *BackrestSyncStateHandler) GetPeerSyncStatesStream(ctx context.Context, req *connect.Request[v1.SyncStateStreamRequest], ...) error

+ type InMemoryPeerStateManager struct

+ func NewInMemoryPeerStateManager() *InMemoryPeerStateManager

+ func (m *InMemoryPeerStateManager) Close() error

+ func (m *InMemoryPeerStateManager) GetAll() []*PeerState

+ func (m *InMemoryPeerStateManager) GetPeerState(keyID string) *PeerState

+ func (m *InMemoryPeerStateManager) OnStateChanged() eventemitter.Receiver[*PeerState]

+ func (m *InMemoryPeerStateManager) SetPeerState(keyID string, state *PeerState)

+ type PeerState struct

+ Config *v1.RemoteConfig

+ ConnectionState v1.SyncConnectionState

+ ConnectionStateMessage string

+ InstanceID string

+ KeyID string

+ KnownPlans map[string]struct{}

+ KnownRepos map[string]struct{}

+ LastHeartbeat time.Time

+ func (ps *PeerState) Clone() *PeerState

+ type PeerStateManager interface

+ Close func() error

+ GetAll func() []*PeerState

+ GetPeerState func(keyID string) *PeerState

+ OnStateChanged func() eventemitter.Receiver[*PeerState]

+ SetPeerState func(keyID string, state *PeerState)

+ type SqlitePeerStateManager struct

+ func NewSqlitePeerStateManager(dbpool *sqlitex.Pool) (*SqlitePeerStateManager, error)

+ func (m *SqlitePeerStateManager) Close() error

+ func (m *SqlitePeerStateManager) GetAll() []*PeerState

+ func (m *SqlitePeerStateManager) GetPeerState(keyID string) *PeerState

+ func (m *SqlitePeerStateManager) OnStateChanged() eventemitter.Receiver[*PeerState]

+ func (m *SqlitePeerStateManager) SetPeerState(keyID string, state *PeerState)

+ type SyncError struct

+ Message error

+ State v1.SyncConnectionState

+ func NewSyncErrorAuth(message error) *SyncError

+ func NewSyncErrorConnected(message error) *SyncError

+ func NewSyncErrorDisconnected(message error) *SyncError

+ func NewSyncErrorInternal(message error) *SyncError

+ func NewSyncErrorPending(message error) *SyncError

+ func NewSyncErrorProtocol(message error) *SyncError

+ func NewSyncErrorRetryWait(message error) *SyncError

+ func NewSyncErrorUnknown(message error) *SyncError

+ func (e *SyncError) Error() string

+ func (e *SyncError) Unwrap() error

Jan 10, 2025

Changes in this version

+ const SyncProtocolVersion

+ var ErrNotBackrestURI = errors.New("not a backrest URI")

+ var ErrRemoteConfigNotFound = errors.New("remote config not found")

+ func CreateRemoteRepoURI(instanceUrl string) (string, error)

+ func GetRepoConfig(store RemoteConfigStore, instanceID, repoID string) (*v1.RemoteRepo, error)

+ func InstanceForBackrestURI(repoUri string) (string, error)

+ func IsBackrestRemoteRepoURI(repoUri string) bool

+ func RepoForBackrestURI(repoUri string) (string, error)

+ type BackrestSyncHandler struct

+ func NewBackrestSyncHandler(mgr *SyncManager) *BackrestSyncHandler

+ func (h *BackrestSyncHandler) Sync(ctx context.Context, ...) error

+ type Identity struct

+ InstanceID string

+ func NewIdentity(instanceID, credentialFile string) (*Identity, error)

+ func (i *Identity) SignMessage(message []byte) ([]byte, error)

+ func (i *Identity) VerifySignature(message, sig []byte) error

+ type RemoteConfigStore interface

+ Delete func(instanceID string) error

+ Get func(instanceID string) (*v1.RemoteConfig, error)

+ Update func(instanceID string, config *v1.RemoteConfig) error

+ func NewJSONDirRemoteConfigStore(dir string) RemoteConfigStore

+ type SyncClient struct

+ func NewSyncClient(mgr *SyncManager, localInstanceID string, peer *v1.Multihost_Peer, ...) (*SyncClient, error)

+ func (c *SyncClient) GetConnectionState() (v1.SyncConnectionState, string)

+ func (c *SyncClient) RunSync(ctx context.Context)

+ type SyncManager struct

+ func NewSyncManager(configMgr *config.ConfigManager, remoteConfigStore RemoteConfigStore, ...) *SyncManager

+ func (m *SyncManager) GetSyncClients() map[string]*SyncClient

+ func (m *SyncManager) RunSync(ctx context.Context)