mirrors/bitcoinj
1
0
Fork 0
mirror of https://github.com/bitcoinj/bitcoinj.git synced 2025-03-13 11:36:15 +01:00
Code Issues Projects Releases Packages Wiki Activity

PeerFilterProvider: Rework JavaDoc.

Browse source
This commit is contained in:
Andreas Schildbach 2019-11-26 16:25:35 +01:00
parent ded215e69e
commit c14e9240ad
1 changed files with 19 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
core/src/main/java/org/bitcoinj/core/PeerFilterProvider.java
View file

@ -1,5 +1,6 @@
/*
* Copyright 2013 Google Inc.
* Copyright 2019 Andreas Schildbach
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -16,30 +17,30 @@
package org.bitcoinj.core;
/**
* An interface which provides the information required to properly filter data downloaded from Peers.
* Note that an implementer is responsible for calling {@link PeerGroup#recalculateFastCatchupAndFilter(PeerGroup.FilterRecalculateMode)}
* whenever a change occurs which effects the data provided via this interface.
* An interface which provides the information required to properly filter data downloaded from Peers. Note that an
* implementer is responsible for calling
* {@link PeerGroup#recalculateFastCatchupAndFilter(PeerGroup.FilterRecalculateMode)} whenever a change occurs which
* effects the data provided via this interface.
*/
public interface PeerFilterProvider {
/**
* Returns the earliest timestamp (seconds since epoch) for which full/bloom-filtered blocks must be downloaded.
* Blocks with timestamps before this time will only have headers downloaded. 0 requires that all blocks be
* downloaded, and thus this should default to {@link System#currentTimeMillis()}/1000.
* Blocks with timestamps before this time will only have headers downloaded. {@code 0} requires that all
* blocks be downloaded, and thus this should default to {@link System#currentTimeMillis()}/1000.
*/
long getEarliestKeyCreationTime();
/**
* Called on all registered filter providers before getBloomFilterElementCount and getBloomFilter are called.
* Once called, the provider should ensure that the items it will want to insert into the filter don't change.
* The reason is that all providers will have their element counts queried, and then a filter big enough for
* all of them will be specified. So the provider must use consistent state. There is guaranteed to be a matching
* call to endBloomFilterCalculation that can be used to e.g. unlock a lock.
* Called on all registered filter providers before {@link #getBloomFilterElementCount()} and
* {@link #getBloomFilter(int, double, long)} are called. Once called, the provider should ensure that the items
* it will want to insert into the filter don't change. The reason is that all providers will have their element
* counts queried, and then a filter big enough for all of them will be specified. So the provider must use
* consistent state. There is guaranteed to be a matching call to {@link #endBloomFilterCalculation()} that can
* be used to e.g. unlock a lock.
*/
void beginBloomFilterCalculation();
/**
* Gets the number of elements that will be added to a bloom filter returned by
* {@link PeerFilterProvider#getBloomFilter(int, double, long)}
@ -52,8 +53,13 @@ public interface PeerFilterProvider {
*/
BloomFilter getBloomFilter(int size, double falsePositiveRate, long nTweak);
/** Whether this filter provider depends on the server updating the filter on all matches */
/**
* Whether this filter provider depends on the server updating the filter on all matches.
*/
boolean isRequiringUpdateAllBloomFilter();
/**
* See {@link #beginBloomFilterCalculation()}.
*/
void endBloomFilterCalculation();
}