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

Add javadocs to DB hook interfaces.

Browse Source
This commit is contained in:
akwizgran
2019-04-26 16:42:36 +01:00
parent 56fbc93962
commit 891c82b2e5
8 changed files with 52 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
bramble-api/src/main/java/org/briarproject/bramble/api/client/BdfIncomingMessageHook.java
View File

@@ -33,7 +33,8 @@ public abstract class BdfIncomingMessageHook implements IncomingMessageHook {
/**
* Called once for each incoming message that passes validation.
*
* @return whether or not this message should be shared
* @param txn A read-write transaction
* @return Whether or not this message should be shared
* @throws DbException Should only be used for real database errors.
* If this is thrown, delivery will be attempted again at next startup,
* whereas if a FormatException is thrown, the message will be permanently

12
bramble-api/src/main/java/org/briarproject/bramble/api/contact/ContactManager.java
View File

@@ -164,8 +164,20 @@ public interface ContactManager {
interface ContactHook {
/**
* Called when a contact is being added.
*
* @param txn A read-write transaction
* @param c The contact that is being added
*/
void addingContact(Transaction txn, Contact c) throws DbException;
/**
* Called when a contact is being removed
*
* @param txn A read-write transaction
* @param c The contact that is being removed
*/
void removingContact(Transaction txn, Contact c) throws DbException;
}
}

3
bramble-api/src/main/java/org/briarproject/bramble/api/lifecycle/LifecycleManager.java
View File

@@ -102,6 +102,9 @@ public interface LifecycleManager {
enum Priority {EARLY, NORMAL, LATE}
/**
* @param txn A read-write transaction
*/
void onDatabaseOpened(Transaction txn) throws DbException;
}
}

3
bramble-api/src/main/java/org/briarproject/bramble/api/sync/validation/IncomingMessageHook.java
View File

@@ -11,7 +11,8 @@ public interface IncomingMessageHook {
/**
* Called once for each incoming message that passes validation.
*
* @return whether or not this message should be shared
* @param txn A read-write transaction
* @return Whether or not this message should be shared
* @throws DbException Should only be used for real database errors.
* If this is thrown, delivery will be attempted again at next startup,
* whereas if an InvalidMessageException is thrown,

9
bramble-api/src/main/java/org/briarproject/bramble/api/versioning/ClientVersioningManager.java
View File

@@ -46,7 +46,14 @@ public interface ClientVersioningManager {
ClientId clientId, int majorVersion) throws DbException;
interface ClientVersioningHook {
/**
* Called when the visibility of a client with respect to a contact is
* changing.
*
* @param txn A read-write transaction
* @param c The contact affected by the visibility change
* @param v The new visibility of the client
*/
void onClientVisibilityChanging(Transaction txn, Contact c,
Visibility v) throws DbException;
}