mon/PaxosService: update docs a bit

Signed-off-by: Sage Weil <sage@inktank.com>
This commit is contained in:
Sage Weil 2013-07-08 22:06:31 -07:00
parent 44db2ac548
commit 8799872d0e

View File

@ -461,11 +461,6 @@ public:
*/
virtual void tick() {}
/**
* called at same interval as tick. consider a trim.
*/
void maybe_trim();
/**
* Get health information
*
@ -649,6 +644,13 @@ public:
* @defgroup PaxosService_h_Trim
* @{
*/
/**
* trim service states if appropriate
*
* Called at same interval as tick()
*/
void maybe_trim();
/**
* Auxiliary function to trim our state from version @from to version @to,
* not including; i.e., the interval [from, to[
@ -670,12 +672,15 @@ public:
/**
* Get the version we should trim to.
*
* Should be overloaded by service if it wants to trim states.
*
* @returns the version we should trim to; if we return zero, it should be
* assumed that there's no version to trim to.
*/
virtual version_t get_trim_to() {
return 0;
}
/**
* @}
*/