me.ahoo.cosid.machine

Class AbstractMachineIdDistributor

java.lang.Object

me.ahoo.cosid.machine.AbstractMachineIdDistributor

All Implemented Interfaces:

MachineIdDistributor

Direct Known Subclasses:

ManualMachineIdDistributor, StatefulSetMachineIdDistributor

public abstract class AbstractMachineIdDistributor
extends java.lang.Object
implements MachineIdDistributor

Abstract MachineIdDistributor.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NOT_FOUND_LAST_STAMP

Fields inherited from interface me.ahoo.cosid.machine.MachineIdDistributor

FOREVER_SAFE_GUARD_DURATION

Constructor Summary

Constructors

Constructor and Description
AbstractMachineIdDistributor(MachineStateStorage machineStateStorage, ClockBackwardsSynchronizer clockBackwardsSynchronizer)

Method Summary

Modifier and Type	Method and Description
MachineState	distribute(java.lang.String namespace, int machineBit, InstanceId instanceId, java.time.Duration safeGuardDuration) 1.
protected abstract MachineState	distributeRemote(java.lang.String namespace, int machineBit, InstanceId instanceId, java.time.Duration safeGuardDuration)
void	guard(java.lang.String namespace, InstanceId instanceId, java.time.Duration safeGuardDuration) Guard the machine id by heartbeat.
protected abstract void	guardRemote(java.lang.String namespace, InstanceId instanceId, MachineState machineState, java.time.Duration safeGuardDuration)
void	revert(java.lang.String namespace, InstanceId instanceId) 1.
protected abstract void	revertRemote(java.lang.String namespace, InstanceId instanceId, MachineState machineState)

Methods inherited from class java.lang.Object

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

Methods inherited from interface me.ahoo.cosid.machine.MachineIdDistributor

getSafeGuardAt, maxMachineId, totalMachineIds

Field Detail

NOT_FOUND_LAST_STAMP

public static final int NOT_FOUND_LAST_STAMP

See Also:

Constant Field Values

Constructor Detail

AbstractMachineIdDistributor

public AbstractMachineIdDistributor(MachineStateStorage machineStateStorage,
                                    ClockBackwardsSynchronizer clockBackwardsSynchronizer)

Method Detail

distribute

public MachineState distribute(java.lang.String namespace,
                               int machineBit,
                               InstanceId instanceId,
                               java.time.Duration safeGuardDuration)
                        throws MachineIdOverflowException

1. get from MachineStateStorage 2. when not found: distributeRemote(java.lang.String, int, me.ahoo.cosid.machine.InstanceId, java.time.Duration) 3. set MachineState to MachineStateStorage

Specified by:

distribute in interface MachineIdDistributor

Parameters:

namespace - namespace

machineBit - machineBit

instanceId - instanceId

safeGuardDuration - safe Guard Duration

Returns:

machine state

Throws:

MachineIdOverflowException - This exception is thrown when the machine number allocation exceeds the threshold

distributeRemote

protected abstract MachineState distributeRemote(java.lang.String namespace,
                                                 int machineBit,
                                                 InstanceId instanceId,
                                                 java.time.Duration safeGuardDuration)

revert

public void revert(java.lang.String namespace,
                   InstanceId instanceId)

1. get from MachineStateStorage 2. when not found: distributeRemote(java.lang.String, int, me.ahoo.cosid.machine.InstanceId, java.time.Duration) , no need to revert 3. revert

Specified by:

revert in interface MachineIdDistributor

Parameters:

namespace - namespace

instanceId - instanceId

revertRemote

protected abstract void revertRemote(java.lang.String namespace,
                                     InstanceId instanceId,
                                     MachineState machineState)

guard

public void guard(java.lang.String namespace,
                  InstanceId instanceId,
                  java.time.Duration safeGuardDuration)
           throws NotFoundMachineStateException,
                  MachineIdLostException

Description copied from interface: MachineIdDistributor

Guard the machine id by heartbeat.

Specified by:

guard in interface MachineIdDistributor

Parameters:

namespace - namespace

instanceId - instanceId

safeGuardDuration - safe Guard Duration

Throws:

NotFoundMachineStateException

MachineIdLostException

guardRemote

protected abstract void guardRemote(java.lang.String namespace,
                                    InstanceId instanceId,
                                    MachineState machineState,
                                    java.time.Duration safeGuardDuration)