Kaladaran/briar
0
0
Fork 0
mirror of https://code.briarproject.org/briar/briar.git synced 2026-02-11 18:29:05 +01:00
Code Issues Projects Releases Wiki Activity

Update javadoc to explain that a new timer can be set.

Browse Source
This commit is contained in:
akwizgran
2021-02-26 13:48:39 +00:00
committed by Torsten Grote
parent 4bd8ee8ccf
commit e3c5497283
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
bramble-api/src/main/java/org/briarproject/bramble/api/cleanup/CleanupHook.java
View File

@@ -1,6 +1,7 @@
package org.briarproject.bramble.api.cleanup;
import org.briarproject.bramble.api.cleanup.event.MessagesCleanedUpEvent;
import org.briarproject.bramble.api.db.DatabaseComponent;
import org.briarproject.bramble.api.db.DbException;
import org.briarproject.bramble.api.db.Transaction;
import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
@@ -20,6 +21,11 @@ public interface CleanupHook {
* Called when the cleanup deadlines of one or more messages are reached.
* When this method returns, a {@link MessagesCleanedUpEvent} will be
* broadcast.
* <p>
* The callee is not required to delete the messages, but the hook won't be
* called again for these messages unless another cleanup timer is set (see
* {@link DatabaseComponent#setCleanupTimerDuration(Transaction, MessageId, long)}
* and {@link DatabaseComponent#startCleanupTimer(Transaction, MessageId)}).
*/
void deleteMessages(Transaction txn, GroupId g,
Collection<MessageId> messageIds) throws DbException;