Documented the return value of incrementConnectionCounter().

This commit is contained in:
akwizgran
2013-04-10 00:03:38 +01:00
parent 12d28433de
commit 2daf2bf9d6
2 changed files with 5 additions and 3 deletions

View File

@@ -244,7 +244,8 @@ public interface DatabaseComponent {
/** /**
* Increments the outgoing connection counter for the given endpoint * Increments the outgoing connection counter for the given endpoint
* in the given rotation period and returns the old value of the counter. * in the given rotation period and returns the old value, or -1 if the
* counter does not exist.
*/ */
long incrementConnectionCounter(ContactId c, TransportId t, long period) long incrementConnectionCounter(ContactId c, TransportId t, long period)
throws DbException; throws DbException;

View File

@@ -577,8 +577,9 @@ interface Database<T> {
boolean hasSendableMessages(T txn, ContactId c) throws DbException; boolean hasSendableMessages(T txn, ContactId c) throws DbException;
/** /**
* Increments the outgoing connection counter for the given contact * Increments the outgoing connection counter for the given endpoint
* transport in the given rotation period and returns the old value; * in the given rotation period and returns the old value, or -1 if the
* counter does not exist.
* <p> * <p>
* Locking: window write. * Locking: window write.
*/ */