com.hazelcast.cp.internal.datastructures.atomicref

Class RaftAtomicRefService

java.lang.Object

com.hazelcast.cp.internal.datastructures.atomicref.RaftAtomicRefService

All Implemented Interfaces:

RaftManagedService, RaftRemoteService, SnapshotAwareService<RaftAtomicRefSnapshot>, RaftNodeLifecycleAwareService, ManagedService

public class RaftAtomicRefService
extends Object
implements RaftManagedService, RaftRemoteService, RaftNodeLifecycleAwareService, SnapshotAwareService<RaftAtomicRefSnapshot>

Contains Raft-based atomic reference instances, implements snapshotting, and creates proxies

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME Name of the service

Constructor Summary

Constructors

Constructor and Description
RaftAtomicRefService(NodeEngine nodeEngine)

Method Summary

Modifier and Type	Method and Description
IAtomicReference	createProxy(String proxyName) Creates a proxy for a CP data structure.
boolean	destroyRaftObject(CPGroupId groupId, String name) Destroys the given CP data structure on the CP group.
RaftAtomicRef	getAtomicRef(CPGroupId groupId, String name)
void	init(NodeEngine nodeEngine, Properties properties) Initializes this service.
void	onCPSubsystemRestart() Called when the CP subsystem is restarted.
void	onRaftGroupDestroyed(CPGroupId groupId) Called on the thread of the Raft group when the given Raft node is destroyed, either gracefully or forcefully.
void	onRaftNodeSteppedDown(CPGroupId groupId) Called on the thread of the Raft group when the given Raft node is stepped down, either because it is shutting down, or it could not be added to the Raft group
void	reset() Resets this service back to its initial state.
void	restoreSnapshot(CPGroupId groupId, long commitIndex, RaftAtomicRefSnapshot snapshot) Restores the snapshot for specified CPGroupId.
void	shutdown(boolean terminate) Shuts down this service.
RaftAtomicRefSnapshot	takeSnapshot(CPGroupId groupId, long commitIndex) Creates a snapshot for specified CPGroupId.

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_NAME

public static final String SERVICE_NAME

Name of the service

See Also:

Constant Field Values

Constructor Detail

RaftAtomicRefService

public RaftAtomicRefService(NodeEngine nodeEngine)

Method Detail

init

public void init(NodeEngine nodeEngine,
                 Properties properties)

Description copied from interface: ManagedService

Initializes this service.

Specified by:

init in interface ManagedService

Parameters:

nodeEngine - the NodeEngine that this service belongs to

properties - the Properties (can be used to pass settings to the service)

reset

public void reset()

Description copied from interface: ManagedService

Resets this service back to its initial state.

TODO: what is the purpose of reset

Specified by:

reset in interface ManagedService

shutdown

public void shutdown(boolean terminate)

Description copied from interface: ManagedService

Shuts down this service.

TODO: what is the purpose of the terminate variable

Specified by:

shutdown in interface ManagedService

Parameters:

terminate - true to shut down this service

onCPSubsystemRestart

public void onCPSubsystemRestart()

Description copied from interface: RaftManagedService

Called when the CP subsystem is restarted.

Specified by:

onCPSubsystemRestart in interface RaftManagedService

takeSnapshot

public RaftAtomicRefSnapshot takeSnapshot(CPGroupId groupId,
                                          long commitIndex)

Description copied from interface: SnapshotAwareService

Creates a snapshot for specified CPGroupId. The snapshot object returned from this method will be stored among the Raft log and it can be sent to other Raft nodes anytime. Therefore, this method must not return a snapshot object that can mutate after the takeSnapshot() call.

Specified by:

takeSnapshot in interface SnapshotAwareService<RaftAtomicRefSnapshot>

Parameters:

groupId - CPGroupId which is snapshot requested for

commitIndex - commitIndex of the taken snapshot

Returns:

snapshot for specified CPGroupId.

restoreSnapshot

public void restoreSnapshot(CPGroupId groupId,
                            long commitIndex,
                            RaftAtomicRefSnapshot snapshot)

Description copied from interface: SnapshotAwareService

Restores the snapshot for specified CPGroupId.

Specified by:

restoreSnapshot in interface SnapshotAwareService<RaftAtomicRefSnapshot>

Parameters:

groupId - CPGroupId of the snapshot to be restored

commitIndex - commitIndex of the restored snapshot

snapshot - snapshot for specified CPGroupId

onRaftGroupDestroyed

public void onRaftGroupDestroyed(CPGroupId groupId)

Description copied from interface: RaftNodeLifecycleAwareService

Called on the thread of the Raft group when the given Raft node is destroyed, either gracefully or forcefully.

Specified by:

onRaftGroupDestroyed in interface RaftNodeLifecycleAwareService

onRaftNodeSteppedDown

public void onRaftNodeSteppedDown(CPGroupId groupId)

Description copied from interface: RaftNodeLifecycleAwareService

Called on the thread of the Raft group when the given Raft node is stepped down, either because it is shutting down, or it could not be added to the Raft group

Specified by:

onRaftNodeSteppedDown in interface RaftNodeLifecycleAwareService

destroyRaftObject

public boolean destroyRaftObject(CPGroupId groupId,
                                 String name)

Description copied from interface: RaftRemoteService

Destroys the given CP data structure on the CP group. This operation is committed on the given CP group.

Specified by:

destroyRaftObject in interface RaftRemoteService

getAtomicRef

public RaftAtomicRef getAtomicRef(CPGroupId groupId,
                                  String name)

createProxy

public IAtomicReference createProxy(String proxyName)

Description copied from interface: RaftRemoteService

Creates a proxy for a CP data structure. This method is called outside of the Raft layer.

Specified by:

createProxy in interface RaftRemoteService

Parameters:

proxyName - the name of the CP data structure

Returns:

the created proxy