endpoint

package

Go to main page

Versions in this module

v0

v0.9.3

Dec 12, 2024

v0.9.2

Nov 21, 2024

Changes in this version

type SenderConfig

+ ListPlaceholders bool

v0.9.1

Nov 14, 2024

Changes in this version

+ type Closer struct

+ func NewCloser(r io.Reader, closer func() error) *Closer

+ func (self *Closer) Close() error

type Receiver

+ func (s *Receiver) WithSemaphore(sem *semaphore.Weighted) *Receiver

type ReceiverConfig

+ Concurrency int64

type Sender

+ func (s *Sender) WithSemaphore(sem *semaphore.Weighted) *Sender

type SenderConfig

+ Concurrency int64

+ type WeightedReader struct

+ func NewWeightedReader(ctx context.Context, sem *semaphore.Weighted, r io.ReadCloser) *WeightedReader

+ func (self *WeightedReader) Close() error

+ func (self *WeightedReader) Read(p []byte) (n int, err error)

v0.9.0

Nov 8, 2024

v0.8.10

Oct 27, 2024

Changes in this version

type FSFilter

+ Empty func() bool

v0.8.9

Oct 20, 2024

v0.8.8

Oct 18, 2024

Changes in this version

+ const ClientIdentityKey

+ const LastReceivedHoldTagNamePrefix

+ var AbstractionTypesAll = AbstractionTypeSet

+ var ErrV1ReplicationCursor = errors.New("bookmark name is a v1-replication cursor")

+ func AbstractionEquals(a, b Abstraction) bool

+ func AbstractionsCacheInvalidate(fs string)

+ func BatchDestroy(ctx context.Context, abs []Abstraction) <-chan BatchDestroyResult

+ func GetMostRecentReplicationCursorOfJob(ctx context.Context, fs string, jobID JobID) (*zfs.FilesystemVersion, error)

+ func GetReplicationCursors(ctx context.Context, dp *zfs.DatasetPath, jobID JobID) ([]zfs.FilesystemVersion, error)

+ func LastReceivedHoldTag(jobID JobID) (string, error)

+ func ListAbstractions(ctx context.Context, query ListZFSHoldsAndBookmarksQuery) (out []Abstraction, outErrs []ListAbstractionsError, err error)

+ func ListAbstractionsStreamed(ctx context.Context, query ListZFSHoldsAndBookmarksQuery) (_ <-chan Abstraction, _ <-chan ListAbstractionsError, drainDone func(), ...)

+ func RegisterMetrics(r prometheus.Registerer)

+ func ReplicationCursorBookmarkName(fs string, guid uint64, id JobID) (string, error)

+ func StepHoldTag(jobid JobID) (string, error)

+ func TentativeReplicationCursorBookmarkName(fs string, guid uint64, id JobID) (string, error)

+ type Abstraction interface

+ Destroy func(context.Context) error

+ GetCreateTXG func() uint64

+ GetFS func() string

+ GetFilesystemVersion func() zfs.FilesystemVersion

+ GetFullPath func() string

+ GetJobID func() *JobID

+ GetName func() string

+ GetType func() AbstractionType

+ String func() string

+ func CreateLastReceivedHold(ctx context.Context, fs string, to zfs.FilesystemVersion, jobID JobID) (Abstraction, error)

+ func CreateReplicationCursor(ctx context.Context, fs string, target zfs.FilesystemVersion, jobID JobID) (a Abstraction, err error)

+ func CreateTentativeReplicationCursor(ctx context.Context, fs string, target zfs.FilesystemVersion, jobID JobID) (a Abstraction, err error)

+ func HoldStep(ctx context.Context, fs string, v zfs.FilesystemVersion, jobID JobID) (Abstraction, error)

+ func LastReceivedHoldExtractor(fs *zfs.DatasetPath, v zfs.FilesystemVersion, holdTag string) Abstraction

+ func ReplicationCursorV1Extractor(fs *zfs.DatasetPath, v zfs.FilesystemVersion) (_ Abstraction)

+ func ReplicationCursorV2Extractor(fs *zfs.DatasetPath, v zfs.FilesystemVersion) (_ Abstraction)

+ func StepHoldExtractor(fs *zfs.DatasetPath, v zfs.FilesystemVersion, holdTag string) Abstraction

+ func TentativeReplicationCursorExtractor(fs *zfs.DatasetPath, v zfs.FilesystemVersion) (_ Abstraction)

+ type AbstractionJSON struct

+ func (a AbstractionJSON) MarshalJSON() ([]byte, error)

+ type AbstractionType string

+ const AbstractionLastReceivedHold

+ const AbstractionReplicationCursorBookmarkV1

+ const AbstractionReplicationCursorBookmarkV2

+ const AbstractionStepHold

+ const AbstractionTentativeReplicationCursorBookmark

+ func (t AbstractionType) BookmarkExtractor() BookmarkExtractor

+ func (t AbstractionType) BookmarkNamer() func(fs string, guid uint64, jobId JobID) (string, error)

+ func (t AbstractionType) HoldExtractor() HoldExtractor

+ func (t AbstractionType) IsSnapshotOrBookmark() bool

+ func (t AbstractionType) MustValidate() error

+ func (t AbstractionType) Validate() error

+ type AbstractionTypeSet map[AbstractionType]bool

+ func AbstractionTypeSetFromStrings(sts []string) (AbstractionTypeSet, error)

+ func (s AbstractionTypeSet) ContainsAll(q AbstractionTypeSet) bool

+ func (s AbstractionTypeSet) ContainsAnyOf(q AbstractionTypeSet) bool

+ func (s AbstractionTypeSet) ExtractBookmark(dp *zfs.DatasetPath, v *zfs.FilesystemVersion) Abstraction

+ func (s AbstractionTypeSet) String() string

+ func (s AbstractionTypeSet) Validate() error

+ type BatchDestroyResult struct

+ DestroyErr error

+ func (r BatchDestroyResult) MarshalJSON() ([]byte, error)

+ type BookmarkExtractor func(fs *zfs.DatasetPath, v zfs.FilesystemVersion) Abstraction

+ type CreateTXGRange struct

+ Since *CreateTXGRangeBound

+ Until *CreateTXGRangeBound

+ func (r *CreateTXGRange) Contains(qCreateTxg uint64) bool

+ func (r *CreateTXGRange) IsUnbounded() bool

+ func (r *CreateTXGRange) String() string

+ func (r *CreateTXGRange) Validate() error

+ type CreateTXGRangeBound struct

+ CreateTXG uint64

+ Inclusive *nodefault.Bool

+ func (i *CreateTXGRangeBound) Validate() error

+ type FSFilter interface

+ Filter func(path *zfs.DatasetPath) (pass bool, err error)

+ UserSpecifiedDatasets func() zfs.UserSpecifiedDatasetsSet

+ type FSMap interface

+ AsFilter func() FSFilter

+ Invert func() (FSMap, error)

+ Map func(path *zfs.DatasetPath) (*zfs.DatasetPath, error)

+ type HoldExtractor = func(fs *zfs.DatasetPath, v zfs.FilesystemVersion, tag string) Abstraction

+ type JobID struct

+ func MakeJobID(s string) (JobID, error)

+ func MustMakeJobID(s string) JobID

+ func ParseLastReceivedHoldTag(tag string) (JobID, error)

+ func ParseReplicationCursorBookmarkName(fullname string) (uint64, JobID, error)

+ func ParseStepHoldTag(tag string) (JobID, error)

+ func ParseTentativeReplicationCursorBookmarkName(fullname string) (guid uint64, jobID JobID, err error)

+ func (j *JobID) UnmarshalJSON(b []byte) error

+ func (j JobID) MarshalJSON() ([]byte, error)

+ func (j JobID) MustValidate()

+ func (j JobID) String() string

+ type ListAbstractionsError struct

+ Err error

+ FS string

+ Snap string

+ What string

+ func (e ListAbstractionsError) Error() string

+ type ListAbstractionsErrors []ListAbstractionsError

+ func (e ListAbstractionsErrors) Error() string

+ type ListStaleQueryError struct

+ type ListZFSHoldsAndBookmarksQuery struct

+ Concurrency int64

+ CreateTXG CreateTXGRange

+ FS ListZFSHoldsAndBookmarksQueryFilesystemFilter

+ JobID *JobID

+ What AbstractionTypeSet

+ func (q *ListZFSHoldsAndBookmarksQuery) Validate() error

+ type ListZFSHoldsAndBookmarksQueryFilesystemFilter struct

+ FS *string

+ Filter zfs.DatasetFilter

+ func (f *ListZFSHoldsAndBookmarksQueryFilesystemFilter) Filesystems(ctx context.Context) ([]string, error)

+ func (f *ListZFSHoldsAndBookmarksQueryFilesystemFilter) Validate() error

+ type Logger = logger.Logger

+ type PlaceholderCreationEncryptionProperty int

+ const PlaceholderCreationEncryptionPropertyInherit

+ const PlaceholderCreationEncryptionPropertyOff

+ const PlaceholderCreationEncryptionPropertyUnspecified

+ func PlaceholderCreationEncryptionPropertyString(s string) (PlaceholderCreationEncryptionProperty, error)

+ func PlaceholderCreationEncryptionPropertyValues() []PlaceholderCreationEncryptionProperty

+ func (i PlaceholderCreationEncryptionProperty) IsAPlaceholderCreationEncryptionProperty() bool

+ func (i PlaceholderCreationEncryptionProperty) String() string

+ type Receiver struct

+ Test_OverrideClientIdentityFunc func() string

+ func NewReceiver(config ReceiverConfig) *Receiver

+ func (p *Receiver) SendCompleted(ctx context.Context, _ *pdu.SendCompletedReq) (*pdu.SendCompletedRes, error)

+ func (s *Receiver) DestroySnapshots(ctx context.Context, req *pdu.DestroySnapshotsReq) (*pdu.DestroySnapshotsRes, error)

+ func (s *Receiver) ListFilesystemVersions(ctx context.Context, req *pdu.ListFilesystemVersionsReq) (*pdu.ListFilesystemVersionsRes, error)

+ func (s *Receiver) ListFilesystems(ctx context.Context, req *pdu.ListFilesystemReq) (*pdu.ListFilesystemRes, error)

+ func (s *Receiver) Ping(ctx context.Context, req *pdu.PingReq) (*pdu.PingRes, error)

+ func (s *Receiver) PingDataconn(ctx context.Context, req *pdu.PingReq) (*pdu.PingRes, error)

+ func (s *Receiver) Receive(ctx context.Context, req *pdu.ReceiveReq, receive io.ReadCloser) (*pdu.ReceiveRes, error)

+ func (s *Receiver) ReplicationCursor(ctx context.Context, _ *pdu.ReplicationCursorReq) (*pdu.ReplicationCursorRes, error)

+ func (s *Receiver) Send(ctx context.Context, req *pdu.SendReq) (*pdu.SendRes, io.ReadCloser, error)

+ func (s *Receiver) SendDry(ctx context.Context, r *pdu.SendReq) (*pdu.SendRes, error)

+ func (s *Receiver) WaitForConnectivity(ctx context.Context) error

+ func (s *Receiver) WithClientIdentity(identity string) *Receiver

+ type ReceiverConfig struct

+ AppendClientIdentity bool

+ BandwidthLimit bandwidthlimit.Config

+ ExecPipe [][]string

+ InheritProperties []zfsprop.Property

+ JobID JobID

+ OverrideProperties map[zfsprop.Property]string

+ PlaceholderEncryption PlaceholderCreationEncryptionProperty

+ RootWithoutClientComponent *zfs.DatasetPath

+ func (c *ReceiverConfig) Validate() error

+ type ReplicationCursorV1 struct

+ FS string

+ Type AbstractionType

+ func (c ReplicationCursorV1) Destroy(ctx context.Context) error

+ func (c ReplicationCursorV1) GetFS() string

+ func (c ReplicationCursorV1) GetFilesystemVersion() zfs.FilesystemVersion

+ func (c ReplicationCursorV1) GetFullPath() string

+ func (c ReplicationCursorV1) GetJobID() *JobID

+ func (c ReplicationCursorV1) GetType() AbstractionType

+ func (c ReplicationCursorV1) MarshalJSON() ([]byte, error)

+ func (c ReplicationCursorV1) String() string

+ type ReplicationGuaranteeIncremental struct

+ func (g ReplicationGuaranteeIncremental) Kind() ReplicationGuaranteeKind

+ func (g ReplicationGuaranteeIncremental) ReceiverPostRecv(ctx context.Context, jid JobID, fs string, toRecvd zfs.FilesystemVersion) (keep []Abstraction, err error)

+ func (g ReplicationGuaranteeIncremental) SenderPostRecvConfirmed(ctx context.Context, jid JobID, fs string, to zfs.FilesystemVersion) (keep []Abstraction, err error)

+ func (g ReplicationGuaranteeIncremental) SenderPreSend(ctx context.Context, jid JobID, sendArgs *zfs.ZFSSendArgsValidated) (keep []Abstraction, err error)

+ func (g ReplicationGuaranteeIncremental) String() string

+ type ReplicationGuaranteeKind int

+ const ReplicationGuaranteeKindIncremental

+ const ReplicationGuaranteeKindNone

+ const ReplicationGuaranteeKindResumability

+ func ReplicationGuaranteeKindString(s string) (ReplicationGuaranteeKind, error)

+ func ReplicationGuaranteeKindValues() []ReplicationGuaranteeKind

+ func (i *ReplicationGuaranteeKind) UnmarshalJSON(data []byte) error

+ func (i ReplicationGuaranteeKind) IsAReplicationGuaranteeKind() bool

+ func (i ReplicationGuaranteeKind) MarshalJSON() ([]byte, error)

+ func (i ReplicationGuaranteeKind) String() string

+ type ReplicationGuaranteeNone struct

+ func (g ReplicationGuaranteeNone) Kind() ReplicationGuaranteeKind

+ func (g ReplicationGuaranteeNone) ReceiverPostRecv(ctx context.Context, jid JobID, fs string, toRecvd zfs.FilesystemVersion) (keep []Abstraction, err error)

+ func (g ReplicationGuaranteeNone) SenderPostRecvConfirmed(ctx context.Context, jid JobID, fs string, to zfs.FilesystemVersion) (keep []Abstraction, err error)

+ func (g ReplicationGuaranteeNone) SenderPreSend(ctx context.Context, jid JobID, sendArgs *zfs.ZFSSendArgsValidated) (keep []Abstraction, err error)

+ func (g ReplicationGuaranteeNone) String() string

+ type ReplicationGuaranteeOptions struct

+ Incremental ReplicationGuaranteeKind

+ Initial ReplicationGuaranteeKind

+ func (o ReplicationGuaranteeOptions) Strategy(incremental bool) ReplicationGuaranteeStrategy

+ type ReplicationGuaranteeResumability struct

+ func (g ReplicationGuaranteeResumability) Kind() ReplicationGuaranteeKind

+ func (g ReplicationGuaranteeResumability) ReceiverPostRecv(ctx context.Context, jid JobID, fs string, toRecvd zfs.FilesystemVersion) (keep []Abstraction, err error)

+ func (g ReplicationGuaranteeResumability) SenderPostRecvConfirmed(ctx context.Context, jid JobID, fs string, to zfs.FilesystemVersion) (keep []Abstraction, err error)

+ func (g ReplicationGuaranteeResumability) SenderPreSend(ctx context.Context, jid JobID, sendArgs *zfs.ZFSSendArgsValidated) (keep []Abstraction, err error)

+ func (g ReplicationGuaranteeResumability) String() string

+ type ReplicationGuaranteeStrategy interface

+ Kind func() ReplicationGuaranteeKind

+ ReceiverPostRecv func(ctx context.Context, jid JobID, fs string, toRecvd zfs.FilesystemVersion) (keep []Abstraction, err error)

+ SenderPostRecvConfirmed func(ctx context.Context, jid JobID, fs string, to zfs.FilesystemVersion) (keep []Abstraction, err error)

+ SenderPreSend func(ctx context.Context, jid JobID, sendArgs *zfs.ZFSSendArgsValidated) (keep []Abstraction, err error)

+ func ReplicationGuaranteeFromKind(k ReplicationGuaranteeKind) ReplicationGuaranteeStrategy

+ type Sender struct

+ FSFilter zfs.DatasetFilter

+ func NewSender(conf SenderConfig) *Sender

+ func (p *Sender) DestroySnapshots(ctx context.Context, req *pdu.DestroySnapshotsReq) (*pdu.DestroySnapshotsRes, error)

+ func (p *Sender) Ping(ctx context.Context, req *pdu.PingReq) (*pdu.PingRes, error)

+ func (p *Sender) PingDataconn(ctx context.Context, req *pdu.PingReq) (*pdu.PingRes, error)

+ func (p *Sender) Receive(ctx context.Context, r *pdu.ReceiveReq, _ io.ReadCloser) (*pdu.ReceiveRes, error)

+ func (p *Sender) ReplicationCursor(ctx context.Context, req *pdu.ReplicationCursorReq) (*pdu.ReplicationCursorRes, error)

+ func (p *Sender) SendCompleted(ctx context.Context, r *pdu.SendCompletedReq) (*pdu.SendCompletedRes, error)

+ func (p *Sender) WaitForConnectivity(ctx context.Context) error

+ func (s *Sender) ListFilesystemVersions(ctx context.Context, r *pdu.ListFilesystemVersionsReq) (*pdu.ListFilesystemVersionsRes, error)

+ func (s *Sender) ListFilesystems(ctx context.Context, r *pdu.ListFilesystemReq) (*pdu.ListFilesystemRes, error)

+ func (s *Sender) Send(ctx context.Context, r *pdu.SendReq) (*pdu.SendRes, io.ReadCloser, error)

+ func (s *Sender) SendDry(ctx context.Context, r *pdu.SendReq) (*pdu.SendRes, error)

+ type SenderConfig struct

+ BandwidthLimit bandwidthlimit.Config

+ Encrypt *nodefault.Bool

+ ExecPipe [][]string

+ FSF zfs.DatasetFilter

+ JobID JobID

+ SendBackupProperties bool

+ SendCompressed bool

+ SendEmbeddedData bool

+ SendLargeBlocks bool

+ SendProperties bool

+ SendRaw bool

+ SendSaved bool

+ func (c *SenderConfig) Validate() error

+ type StalenessInfo struct

+ ConstructedWithQuery ListZFSHoldsAndBookmarksQuery

+ Live []Abstraction

+ Stale []Abstraction

+ func ListStale(ctx context.Context, q ListZFSHoldsAndBookmarksQuery) (*StalenessInfo, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL