ENT-1716 Documentation for hot cold ha (#628)

This commit is contained in:
cburlinchon 2018-03-28 11:44:07 +01:00 committed by GitHub
parent 1c9ab33a10
commit 4558651b58
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 2 deletions

View File

@ -42,6 +42,17 @@ The configuration snippet below shows the relevant settings.
}
}
Fields
------
:on: Whether hot cold high availability is turned on, defaulted to ``false``.
:machineName: Unique name for node.
:updateInterval: Rate(milliseconds) at which the running node updates the mutual exclusion lease.
:waitInterval: Amount of time(milliseconds) to wait since last mutual exclusion lease update before being able to become the master node. This has to be greater than updateInterval.
Hot Warm
~~~~~~~~

View File

@ -35,10 +35,11 @@ const val VERSION = "version"
* Makes sure only one node is able to write to database.
* Running node updates row whilst running. When a node starts up, it checks no one has updated row within a specified time frame.
*
* @property pid process id
* @property machineName unique name for node.
* @property pid process id.
* @property updateInterval rate(milliseconds) at which the running node updates row.
* @property waitInterval amount of time(milliseconds) to wait since last row update before being able to become the master node.
* @property updateExecutor runs a row update every [updateInterval] milliseconds
* @property updateExecutor runs a row update every [updateInterval] milliseconds.
*/
class RunOnceService(private val database: CordaPersistence, private val machineName: String, private val pid: String,
private val updateInterval: Long, private val waitInterval: Long,