SynchronyMonitor (Atlassian Confluence 8.0.0 API)

All Known Implementing Classes:

DefaultSynchronyMonitor
```
public interface SynchronyMonitor
```
Provides methods for monitoring the Synchrony service, whether managed by Confluence or external.

Since:

6.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`cancelHeartbeat()`	Cancels polling the Synchrony heartbeat rest endpoint if a poll is currently in progress, useful when Synchrony is shutdown before it is able to resolve a successful heartbeat result.
`boolean`	`isSynchronyUp()`	Determines if the Synchrony that Confluence uses to connect to is currently running or not.
`io.atlassian.util.concurrent.Promise<Boolean>`	`pollHeartbeat()`	Ping the Synchrony heartbeat rest endpoint, until the result is a 200 OK or a timeout is reached.

- Method Detail
  - isSynchronyUp
```
boolean isSynchronyUp()
```
    Determines if the Synchrony that Confluence uses to connect to is currently running or not.
    
    Returns:
    
    true iff Synchrony is running and responding to requests.
  - pollHeartbeat
```
io.atlassian.util.concurrent.Promise<Boolean> pollHeartbeat()
```
    Ping the Synchrony heartbeat rest endpoint, until the result is a 200 OK or a timeout is reached.
    
    Returns:
    
    a Promise with value true iff Synchrony responds with a successful heartbeat within the timeout.
  - cancelHeartbeat
```
void cancelHeartbeat()
```
    Cancels polling the Synchrony heartbeat rest endpoint if a poll is currently in progress, useful when Synchrony is shutdown before it is able to resolve a successful heartbeat result.
    
    Since:
    
    6.0.2