proto

type HashSource interface {
	// Documents retrieves all documents in the HashSource.
	Documents() ([]model.DocumentDescriptor, error)
	// AddDocument adds a document.
	AddDocument(model.Document) error
	// HasContentsForDocument determines whether we have the contents for the specified document. If we have the contents,
	// true is returned. If we don't have the contents or don't know the hash at all, false is returned.
	HasContentsForDocument(hash model.Hash) (bool, error)
	// GetDocument retrieves the document given the specified hash. If the document is not known, ErrUnknownDocument is returned.
	GetDocument(hash model.Hash) (*model.DocumentDescriptor, error)
	// GetDocumentContents retrieves the contents of the document given the specified hash. If the document is not known or we don't have its contents, ErrMissingDocumentContents is returned.
	GetDocumentContents(hash model.Hash) (io.ReadCloser, error)
	// FindByContentsHash searches for documents which contents match the given SHA-1 hash.
	FindByContentsHash(hash model.Hash) ([]model.DocumentDescriptor, error)
	// AddDocumentWithContents adds a document including contents.
	AddDocumentWithContents(timestamp time.Time, documentType string, contents io.Reader) (*model.Document, error)
	// AddDocumentContents adds a contents to an already known document.
	AddDocumentContents(hash model.Hash, contents io.Reader) (*model.Document, error)
}

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

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

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

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

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

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

type PeerHash struct {
	// Peer holds the ID of the peer we got the hash from.
	Peer model.PeerID
	// Hash holds the hash we received.
	Hash model.Hash
}

type PeerHashQueue interface {
	// Get blocks until there's an PeerHash available and returns it.
	Get() *PeerHash
}

type Protocol interface {
	stats.StatsProvider
	// Configure configures the Protocol. Must be called before Start().
	Configure(p2pNetwork p2p.P2PNetwork, source HashSource)
	// Starts the Protocol (sending and receiving of messages).
	Start()
	// Stops the Protocol.
	Stop()
	// ReceivedConsistencyHashes returns a queue with consistency hashes we received from our peers. It must be drained, because when its buffer is full the producer is blocked.
	ReceivedConsistencyHashes() PeerHashQueue
	// AdvertConsistencyHash is used to tell our peers of our last consistency hash, so they can match their DocumentLog with ours (so replication can occur).
	AdvertConsistencyHash(hash model.Hash)
	// QueryHashList is used to query a peer for their document hash list.
	QueryHashList(peer model.PeerID) error
}