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

Add javadocs for CleanupManager and CleanupHook.

Browse Source
This commit is contained in:
akwizgran
2021-02-26 11:13:29 +00:00
committed by Torsten Grote
parent ec0a59db01
commit e9249a9463
2 changed files with 29 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,14 +1,26 @@
package org.briarproject.bramble.api.cleanup; package org.briarproject.bramble.api.cleanup;
import org.briarproject.bramble.api.cleanup.event.MessagesCleanedUpEvent;
import org.briarproject.bramble.api.db.DbException; import org.briarproject.bramble.api.db.DbException;
import org.briarproject.bramble.api.db.Transaction; import org.briarproject.bramble.api.db.Transaction;
import org.briarproject.bramble.api.nullsafety.NotNullByDefault; import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
import org.briarproject.bramble.api.sync.GroupId; import org.briarproject.bramble.api.sync.GroupId;
import org.briarproject.bramble.api.sync.MessageId; import org.briarproject.bramble.api.sync.MessageId;
/**
* An interface for registering a hook with the {@link CleanupManager}
* that will be called when a message's cleanup deadline is reached.
*/
@NotNullByDefault @NotNullByDefault
public interface CleanupHook { public interface CleanupHook {
/**
* Called when a message's cleanup deadline is reached. If this method
* returns true, a {@link MessagesCleanedUpEvent} will be broadcast.
*
* @return True if the message has been deleted, or false if it has not,
* in which case the message's cleanup timer will be stopped
*/
boolean deleteMessage(Transaction txn, GroupId g, MessageId m) boolean deleteMessage(Transaction txn, GroupId g, MessageId m)
throws DbException; throws DbException;
} }

17
bramble-api/src/main/java/org/briarproject/bramble/api/cleanup/CleanupManager.java
View File

@@ -1,10 +1,27 @@
package org.briarproject.bramble.api.cleanup; package org.briarproject.bramble.api.cleanup;
import org.briarproject.bramble.api.cleanup.event.CleanupTimerStartedEvent;
import org.briarproject.bramble.api.crypto.SecretKey; import org.briarproject.bramble.api.crypto.SecretKey;
import org.briarproject.bramble.api.db.DatabaseComponent;
import org.briarproject.bramble.api.db.Transaction;
import org.briarproject.bramble.api.lifecycle.LifecycleManager; import org.briarproject.bramble.api.lifecycle.LifecycleManager;
import org.briarproject.bramble.api.nullsafety.NotNullByDefault; import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
import org.briarproject.bramble.api.sync.ClientId; import org.briarproject.bramble.api.sync.ClientId;
import org.briarproject.bramble.api.sync.MessageId;
/**
* The CleanupManager is responsible for tracking the cleanup deadlines of
* messages and passing them to their respective
* {@link CleanupHook CleanupHooks} when the deadlines are reached.
* <p>
* The CleanupManager responds to
* {@link CleanupTimerStartedEvent CleanupTimerStartedEvents} broadcast by the
* {@link DatabaseComponent}.
* <p>
* See {@link DatabaseComponent#setCleanupTimerDuration(Transaction, MessageId, long)},
* {@link DatabaseComponent#startCleanupTimer(Transaction, MessageId)},
* {@link DatabaseComponent#stopCleanupTimer(Transaction, MessageId)}.
*/
@NotNullByDefault @NotNullByDefault
public interface CleanupManager { public interface CleanupManager {