io.aeron.cluster

Class ClusterBackup

java.lang.Object

io.aeron.cluster.ClusterBackup

All Implemented Interfaces:

AutoCloseable

public final class ClusterBackup
extends Object
implements AutoCloseable

Backup component which can run remote from a cluster which polls for snapshots and replicates the log.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClusterBackup.Configuration Configuration options for ClusterBackup with defaults and constants for system properties lookup.
static class	ClusterBackup.Context Context for overriding default configuration for ClusterBackup.
static class	ClusterBackup.State State of the cluster backup state machine.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BACKUP_STATE_TYPE_ID The type id of the Counter used for the backup state.
static int	CLUSTER_BACKUP_ERROR_COUNT_TYPE_ID The type id of the Counter used for keeping track of the number of errors that have occurred.
static int	LIVE_LOG_POSITION_TYPE_ID The type id of the Counter used for the live log position counter.
static int	QUERY_DEADLINE_TYPE_ID The type id of the Counter used for the next query deadline counter.

Method Summary

Modifier and Type	Method and Description
void	close()
AgentInvoker	conductorAgentInvoker() Get the AgentInvoker for the cluster backup.
ClusterBackup.Context	context() Get the ClusterBackup.Context that is used by this ClusterBackup.
static ClusterBackup	launch() Launch an ClusterBackup using a default configuration.
static ClusterBackup	launch(ClusterBackup.Context ctx) Launch an ClusterBackup by providing a configuration context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BACKUP_STATE_TYPE_ID

public static final int BACKUP_STATE_TYPE_ID

The type id of the Counter used for the backup state.

See Also:

Constant Field Values

LIVE_LOG_POSITION_TYPE_ID

public static final int LIVE_LOG_POSITION_TYPE_ID

The type id of the Counter used for the live log position counter.

See Also:

Constant Field Values

QUERY_DEADLINE_TYPE_ID

public static final int QUERY_DEADLINE_TYPE_ID

The type id of the Counter used for the next query deadline counter.

See Also:

Constant Field Values

CLUSTER_BACKUP_ERROR_COUNT_TYPE_ID

public static final int CLUSTER_BACKUP_ERROR_COUNT_TYPE_ID

The type id of the Counter used for keeping track of the number of errors that have occurred.

See Also:

Constant Field Values

Method Detail

launch

public static ClusterBackup launch()

Launch an ClusterBackup using a default configuration.

Returns:

a new instance of an ClusterBackup.

launch

public static ClusterBackup launch(ClusterBackup.Context ctx)

Launch an ClusterBackup by providing a configuration context.

Parameters:

ctx - for the configuration parameters.

Returns:

a new instance of an ClusterBackup.

context

public ClusterBackup.Context context()

Get the ClusterBackup.Context that is used by this ClusterBackup.

Returns:

the ClusterBackup.Context that is used by this ClusterBackup.

conductorAgentInvoker

public AgentInvoker conductorAgentInvoker()

Get the AgentInvoker for the cluster backup.

Returns:

the AgentInvoker for the cluster backup.

close

public void close()

Specified by:

close in interface AutoCloseable