Skip to content

Commit

Permalink
38: Javadoc improvement
Browse files Browse the repository at this point in the history
An explanation was added that the estimations returned by Archiver need not be accurate.
  • Loading branch information
guusdk committed Jun 3, 2019
1 parent 4e0d78b commit 2c9b4d7
Showing 1 changed file with 5 additions and 0 deletions.
Expand Up @@ -953,6 +953,11 @@ void queueParticipantLeft(Conversation conversation, JID user, ConversationParti
* Returns an estimation on how long it takes for all data that arrived before a certain instant will have become
* available in the data store. When data is immediately available, 'zero', is returned;
*
* Beware: implementations are free to apply a low-effort mechanism to determine a non-zero estimate. Notably,
* an implementation can choose to not obtain ETAs from individual cluster nodes, when the local cluster node
* is reporting a non-zero ETA. However, a return value of 'zero' must be true for the entire cluster (and is,
* in effect, not an 'estimate', but a matter of fact.
*
* This method is intended to be used to determine if it's safe to construct an answer (based on database
* content) to a request for archived data. Such response should only be generated after all data that was
* queued before the request arrived has been written to the database.
Expand Down

0 comments on commit 2c9b4d7

Please sign in to comment.