adminer/zrepl_patched
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

replication: document most important aspects of Endpoint interface

Browse Source
This commit is contained in:
Christian Schwarz
2018-08-26 15:12:43 +02:00
parent f6be5b776b
commit 7ff72fb6d9
3 changed files with 14 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
replication/fsrep/fsfsm.go
+8
View File
@@ -36,11 +36,19 @@ func getLogger(ctx context.Context) Logger {
return l
}
// A Sender is usually part of a github.com/zrepl/zrepl/replication.Endpoint.
type Sender interface {
// If a non-nil io.ReadCloser is returned, it is guaranteed to be closed before
// any next call to the parent github.com/zrepl/zrepl/replication.Endpoint.
Send(ctx context.Context, r *pdu.SendReq) (*pdu.SendRes, io.ReadCloser, error)
}
// A Sender is usually part of a github.com/zrepl/zrepl/replication.Endpoint.
type Receiver interface {
// Receive sends r and sendStream (the latter containing a ZFS send stream)
// to the parent github.com/zrepl/zrepl/replication.Endpoint.
// Implementors must guarantee that Close was called on sendStream before
// the call to Receive returns.
Receive(ctx context.Context, r *pdu.ReceiveReq, sendStream io.ReadCloser) error
}