ControllerBB (GemFire XD Java API Documentation)

java.lang.Object
- hydra.blackboard.Blackboard
- - splitBrain.ControllerBB

public class ControllerBB
extends Blackboard

Ack alert Blackboard

Field Summary

Fields
Modifier and Type	Field and Description
`static ControllerBB`	`bbInstance`
`static String`	`EnableDeadKey`
`static String`	`EnableSickKey`
`static String`	`EnableSlowListenerKey`
`static String`	`ErrorKey`
`static int`	`ExceptionCounter`
`static String`	`InitIsCompleteKey`
`static String`	`IsDeadKey`
`static String`	`IsSickKey`
`static String`	`MembershipFailureBegunKey`
`static String`	`MembershipFailureCompleteKey`
`static int`	`metCounter`
`static String`	`NumForcedDiscEventsKey`
`static String`	`ReadyForInitKey`
`static String`	`SevereAlertKey`
`static String`	`VmRestarted`

Fields inherited from class hydra.blackboard.Blackboard
counterNames, GemFire, RMI

Constructor Summary

Constructors
Constructor and Description

ControllerBB()

ControllerBB(String name, String type)
Creates a sample blackboard using the specified name and transport type.

Constructors
Constructor and Description
`ControllerBB()`
`ControllerBB(String name, String type)` Creates a sample blackboard using the specified name and transport type.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`checkEventCounters(String baseKey, List vmList, int expectedCount)` Check event counters in the ControllerBB shared map.
`static void`	`checkForError()` Check if an error has been recorded in the blackboard.
`static void`	`enablePlayDead()` Enable becoming dead for the current vm
`static void`	`enablePlayDead(int vmID)` Enable becoming dead for the given vmid
`static void`	`enableSickness()` Enable sickness for the current vm
`static void`	`enableSickness(int vmID)` Enable sickness for the given vmid
`static void`	`enableSlowListener()` Enable slow listeners for the current vm
`static void`	`enableSlowListener(int vmID)` Enable slow listeners for the given vmid
`static ControllerBB`	`getBB()` Get the Blackboard
`static int`	`getMapCounter(String keyBase)` Get the value of the shared map counter for this vm.
`static long`	`getMembershipFailureCompletionTime()` Return the currentTimeMillis value of when membership failure completed
`static long`	`getMembershipFailureStartTime()` Return the currentTimeMillis value of when membership failure started
`static int`	`getVmIdForPid(int pid)` Return the vmid for the given pid, assuming this was recorded in the bb during init tasks.
`static void`	`incMapCounter(String keyBase)` Atomically increment a counter in the ControllerBB sharedMap.
`static boolean`	`isAlertEnabled(int vmID)` Alerts are enable if enabled for sick or slow, but if dead is also enabled, we expect a forced disconnect, not an alert.
`static boolean`	`isMembershipFailureComplete()` Return whether membership failure is complete for this vm.
`static boolean`	`isPlayDeadEnabled()` Return whether the current vm is enabled for being dead.
`static boolean`	`isPlayDeadEnabled(int vmID)` Return whether the given vm is enabled for being dead.
`static boolean`	`isReadyForInit()` Return whether this vm is ready for initialization.
`static boolean`	`isReadyForInit(int vmID)` Return whether this vm is ready for initialization (typically after disconnecting).
`static boolean`	`isSicknessEnabled()` Return whether sickness is enabled for the current vm.
`static boolean`	`isSicknessEnabled(int vmID)` Return whether sickness is enabled for the given vm.
`static boolean`	`isSlowListenerEnabled()` Return whether slow listeners are enabled for the current vm.
`static boolean`	`isSlowListenerEnabled(int vmID)` Return whether slow listeners are enabled for the given vm.
`static boolean`	`receivedSevereAlert()` Return whether the current vm has received a severe alert.
`static boolean`	`receivedSevereAlert(int vmID)` Return whether the given vm has received a severe alert.
`static void`	`reset(int vmID)` Clear all blackboard signals.
`static void`	`signalInitIsComplete()` Signal that initialization for this VM is complete.
`static void`	`signalInitIsComplete(int vmID)` Signal that initialization for the given VM is complete.
`static void`	`signalIsDead()` Signal that the current vm is dead.
`static void`	`signalIsDead(int vmID)` Signal that the given vm is dead.
`static void`	`signalIsSick()` Signal that the current vm is sick.
`static void`	`signalIsSick(int vmID)` Signal that the given vm is sick.
`static void`	`signalMembershipFailureBegun()` Signal that the membershipFailure has begun.
`static void`	`signalMembershipFailureComplete()` Signal that the membershipFailure is complete.
`static void`	`signalReadyForInit()` Signal that this vm is ready for intialization.
`static void`	`signalReadyForInit(int vmID)` Signal that the given vm is ready for intialization.
`static void`	`signalSevereAlert()` Signal that a severe alert occurred in the current vm.
`static void`	`signalSevereAlert(int vmID)` Signal that a severe alert occurred for the given vm.
`static void`	`signalVmRestarted(int vmID)` Signal that the given vm has restarted.
`static void`	`waitForInitialization()` Wait for the current vm to complete initialization
`static void`	`waitForInitialization(int vmID)` Wait for the given vm to complete initialization
`static void`	`waitForIsDead()` Wait for the current vm to become dead.
`static void`	`waitForIsDead(int vmID)` Wait for the given vmid to become dead.
`static void`	`waitForIsSick()` Wait for the current vm to become sick.
`static void`	`waitForIsSick(int vmID)` Wait for the given vmid to become sick.
`static void`	`waitForRestartedVm(int vmID)` Wait for the given vm to restart.
`static void`	`waitForSevereAlert()` Wait for the current vm to recognize a severe alert.
`static void`	`waitForSevereAlert(int vmID)` Wait for the given vmid to recognize a severe alert.
`static void`	`waitMembershipFailureComplete()` Wait for membership failure to complete.
`static void`	`waitMembershipFailureComplete(int vmID)` Wait for membership failure to complete.

Methods inherited from class hydra.blackboard.Blackboard
createSharedCounters, createSharedLock, createSharedMap, getCounterNames, getSharedCounter, getSharedCounters, getSharedLock, getSharedMap, print, printSharedCounters, printSharedMap

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - bbInstance
```
public static ControllerBB bbInstance
```
  - ExceptionCounter
```
public static int ExceptionCounter
```
  - metCounter
```
public static int metCounter
```
  - ErrorKey
```
public static final String ErrorKey
```
    See Also:
    
    Constant Field Values
  - EnableSlowListenerKey
```
public static final String EnableSlowListenerKey
```
    See Also:
    
    Constant Field Values
  - EnableSickKey
```
public static final String EnableSickKey
```
    See Also:
    
    Constant Field Values
  - EnableDeadKey
```
public static final String EnableDeadKey
```
    See Also:
    
    Constant Field Values
  - ReadyForInitKey
```
public static final String ReadyForInitKey
```
    See Also:
    
    Constant Field Values
  - InitIsCompleteKey
```
public static final String InitIsCompleteKey
```
    See Also:
    
    Constant Field Values
  - MembershipFailureBegunKey
```
public static final String MembershipFailureBegunKey
```
    See Also:
    
    Constant Field Values
  - MembershipFailureCompleteKey
```
public static final String MembershipFailureCompleteKey
```
    See Also:
    
    Constant Field Values
  - SevereAlertKey
```
public static final String SevereAlertKey
```
    See Also:
    
    Constant Field Values
  - IsSickKey
```
public static final String IsSickKey
```
    See Also:
    
    Constant Field Values
  - IsDeadKey
```
public static final String IsDeadKey
```
    See Also:
    
    Constant Field Values
  - NumForcedDiscEventsKey
```
public static final String NumForcedDiscEventsKey
```
    See Also:
    
    Constant Field Values
  - VmRestarted
```
public static final String VmRestarted
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ControllerBB
```
public ControllerBB()
```
  - ControllerBB
```
public ControllerBB(String name,
                    String type)
```
    Creates a sample blackboard using the specified name and transport type.
- Method Detail
  - getBB
```
public static ControllerBB getBB()
```
    Get the Blackboard
  - isAlertEnabled
```
public static boolean isAlertEnabled(int vmID)
```
    Alerts are enable if enabled for sick or slow, but if dead is also enabled, we expect a forced disconnect, not an alert.
  - enableSlowListener
```
public static void enableSlowListener()
```
    Enable slow listeners for the current vm
  - enableSlowListener
```
public static void enableSlowListener(int vmID)
```
    Enable slow listeners for the given vmid
  - isSlowListenerEnabled
```
public static boolean isSlowListenerEnabled()
```
    Return whether slow listeners are enabled for the current vm.
  - isSlowListenerEnabled
```
public static boolean isSlowListenerEnabled(int vmID)
```
    Return whether slow listeners are enabled for the given vm.
  - signalReadyForInit
```
public static void signalReadyForInit()
```
    Signal that this vm is ready for intialization.
  - signalReadyForInit
```
public static void signalReadyForInit(int vmID)
```
    Signal that the given vm is ready for intialization.
  - isReadyForInit
```
public static boolean isReadyForInit()
```
    Return whether this vm is ready for initialization.
  - isReadyForInit
```
public static boolean isReadyForInit(int vmID)
```
    Return whether this vm is ready for initialization (typically after disconnecting).
  - signalInitIsComplete
```
public static void signalInitIsComplete()
```
    Signal that initialization for this VM is complete.
  - signalInitIsComplete
```
public static void signalInitIsComplete(int vmID)
```
    Signal that initialization for the given VM is complete.
  - waitForInitialization
```
public static void waitForInitialization()
```
    Wait for the current vm to complete initialization
  - waitForInitialization
```
public static void waitForInitialization(int vmID)
```
    Wait for the given vm to complete initialization
  - signalVmRestarted
```
public static void signalVmRestarted(int vmID)
```
    Signal that the given vm has restarted.
  - waitForRestartedVm
```
public static void waitForRestartedVm(int vmID)
```
    Wait for the given vm to restart.
  - signalMembershipFailureBegun
```
public static void signalMembershipFailureBegun()
```
    Signal that the membershipFailure has begun.
  - signalMembershipFailureComplete
```
public static void signalMembershipFailureComplete()
```
    Signal that the membershipFailure is complete.
  - getMembershipFailureStartTime
```
public static long getMembershipFailureStartTime()
```
    Return the currentTimeMillis value of when membership failure started
  - getMembershipFailureCompletionTime
```
public static long getMembershipFailureCompletionTime()
```
    Return the currentTimeMillis value of when membership failure completed
  - isMembershipFailureComplete
```
public static boolean isMembershipFailureComplete()
```
    Return whether membership failure is complete for this vm.
  - waitMembershipFailureComplete
```
public static void waitMembershipFailureComplete()
```
    Wait for membership failure to complete.
  - waitMembershipFailureComplete
```
public static void waitMembershipFailureComplete(int vmID)
```
    Wait for membership failure to complete.
  - enableSickness
```
public static void enableSickness()
```
    Enable sickness for the current vm
  - enableSickness
```
public static void enableSickness(int vmID)
```
    Enable sickness for the given vmid
  - isSicknessEnabled
```
public static boolean isSicknessEnabled()
```
    Return whether sickness is enabled for the current vm.
  - isSicknessEnabled
```
public static boolean isSicknessEnabled(int vmID)
```
    Return whether sickness is enabled for the given vm.
  - signalIsSick
```
public static void signalIsSick()
```
    Signal that the current vm is sick.
  - signalIsSick
```
public static void signalIsSick(int vmID)
```
    Signal that the given vm is sick.
  - waitForIsSick
```
public static void waitForIsSick()
```
    Wait for the current vm to become sick.
  - waitForIsSick
```
public static void waitForIsSick(int vmID)
```
    Wait for the given vmid to become sick.
  - enablePlayDead
```
public static void enablePlayDead()
```
    Enable becoming dead for the current vm
  - enablePlayDead
```
public static void enablePlayDead(int vmID)
```
    Enable becoming dead for the given vmid
  - isPlayDeadEnabled
```
public static boolean isPlayDeadEnabled()
```
    Return whether the current vm is enabled for being dead.
  - isPlayDeadEnabled
```
public static boolean isPlayDeadEnabled(int vmID)
```
    Return whether the given vm is enabled for being dead.
  - signalIsDead
```
public static void signalIsDead()
```
    Signal that the current vm is dead.
  - signalIsDead
```
public static void signalIsDead(int vmID)
```
    Signal that the given vm is dead.
  - waitForIsDead
```
public static void waitForIsDead()
```
    Wait for the current vm to become dead.
  - waitForIsDead
```
public static void waitForIsDead(int vmID)
```
    Wait for the given vmid to become dead.
  - signalSevereAlert
```
public static void signalSevereAlert()
```
    Signal that a severe alert occurred in the current vm.
  - signalSevereAlert
```
public static void signalSevereAlert(int vmID)
```
    Signal that a severe alert occurred for the given vm.
  - receivedSevereAlert
```
public static boolean receivedSevereAlert()
```
    Return whether the current vm has received a severe alert.
  - receivedSevereAlert
```
public static boolean receivedSevereAlert(int vmID)
```
    Return whether the given vm has received a severe alert.
  - waitForSevereAlert
```
public static void waitForSevereAlert()
```
    Wait for the current vm to recognize a severe alert.
  - waitForSevereAlert
```
public static void waitForSevereAlert(int vmID)
```
    Wait for the given vmid to recognize a severe alert.
  - getMapCounter
```
public static int getMapCounter(String keyBase)
```
    Get the value of the shared map counter for this vm.
  - incMapCounter
```
public static void incMapCounter(String keyBase)
```
    Atomically increment a counter in the ControllerBB sharedMap.
    
    Parameters:
    
    keyBase - A string from ControllerBB that prefixes a vm id to use as a key in the ControllerBB shared map. The VM id used is the current vm's id.
  - checkForError
```
public static void checkForError()
```
    Check if an error has been recorded in the blackboard.
  - getVmIdForPid
```
public static int getVmIdForPid(int pid)
```
    Return the vmid for the given pid, assuming this was recorded in the bb during init tasks.
  - reset
```
public static void reset(int vmID)
```
    Clear all blackboard signals.
  - checkEventCounters
```
public static void checkEventCounters(String baseKey,
                                      List vmList,
                                      int expectedCount)
```
    Check event counters in the ControllerBB shared map. For example, if baseKey is ControllerBB.NumForcedDiscEventsKey and vmList is a list containing vmId 2, and expectedCount is 1, then the event count of key with base NumForcedDiscEvents plus vmId 2 is expected to be 1, and any other key found in the map that is prefixed by baseKey should have value be 0. Throws an exception if the conditions are not satisfied.
    
    Parameters:
    
    baseKey - The base string of the key to check (the prefix to the vm id)
    
    vmList - The vms (ClientVmInfo) for the baseKey should have a value of expectedCount.
    
    expectedCount - The expected value of any baseKeys that refer to the given vmIds, otherwise the expectedCount is 0.

Class ControllerBB

Field Summary

Fields inherited from class hydra.blackboard.Blackboard

Constructor Summary

Method Summary

Methods inherited from class hydra.blackboard.Blackboard

Methods inherited from class java.lang.Object

Field Detail

bbInstance

ExceptionCounter

metCounter

ErrorKey

EnableSlowListenerKey

EnableSickKey

EnableDeadKey

ReadyForInitKey

InitIsCompleteKey

MembershipFailureBegunKey

MembershipFailureCompleteKey

SevereAlertKey

IsSickKey

IsDeadKey

NumForcedDiscEventsKey

VmRestarted

Constructor Detail

ControllerBB

ControllerBB

Method Detail

getBB

isAlertEnabled

enableSlowListener

enableSlowListener

isSlowListenerEnabled

isSlowListenerEnabled

signalReadyForInit

signalReadyForInit

isReadyForInit

isReadyForInit

signalInitIsComplete

signalInitIsComplete

waitForInitialization

waitForInitialization

signalVmRestarted

waitForRestartedVm

signalMembershipFailureBegun

signalMembershipFailureComplete

getMembershipFailureStartTime

getMembershipFailureCompletionTime

isMembershipFailureComplete

waitMembershipFailureComplete

waitMembershipFailureComplete

enableSickness

enableSickness

isSicknessEnabled

isSicknessEnabled

signalIsSick

signalIsSick

waitForIsSick

waitForIsSick

enablePlayDead

enablePlayDead

isPlayDeadEnabled

isPlayDeadEnabled

signalIsDead

signalIsDead

waitForIsDead

waitForIsDead

signalSevereAlert

signalSevereAlert

receivedSevereAlert

receivedSevereAlert

waitForSevereAlert

waitForSevereAlert

getMapCounter

incMapCounter

checkForError

getVmIdForPid

reset

checkEventCounters