SyncReplPolicy (GigaSpaces XAP 14.2.0 API)

java.lang.Object
- com.gigaspaces.cluster.replication.sync.SyncReplPolicy

All Implemented Interfaces:

Externalizable, Serializable
```
public class SyncReplPolicy
extends Object
implements Externalizable
```
This class contains all configuration information about Synchronize Replication.

Version:

4.0

Author:

Igor Goldenberg

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`DEFAULT_ACK_INTERVAL`
`static long`	`DEFAULT_ASYNC_INTERVAL_TO_CHECK`
`static long`	`DEFAULT_ASYNC_ONE_WAY_HEARTBEAT_INTERVAL`
`static ConsistencyLevel`	`DEFAULT_CONSISTENCY_LEVEL`
`static String`	`DEFAULT_IP_GROUP`
`static int`	`DEFAULT_MAX_THROTTLE_TP_WHEN_INACTIVE`
`static int`	`DEFAULT_MIN_THROTTLE_TP_WHEN_ACTIVE`
`static int`	`DEFAULT_MULTICAST_MAX_WORK_THREADS`
`static int`	`DEFAULT_MULTICAST_MIN_WORK_THREADS`
`static int`	`DEFAULT_MULTICAST_TTL`
`static int`	`DEFAULT_MULTIPLE_OPERATION_CHUNK_SIZE`
`static int`	`DEFAULT_PORT`
`static long`	`DEFAULT_RESPONSE_TIMEOUT`
`static long`	`DEFAULT_TARGET_CONSUME_TIMEOUT`
`static boolean`	`DEFAULT_THROTTLE_WHEN_INACTIVE`
`static long`	`DEFAULT_TODO_QUEUE_TIMEOUT`
`static int`	`DEFAULT_UNICAST_MAX_WORK_THREADS`
`static int`	`DEFAULT_UNICAST_MIN_WORK_THREADS`
`String`	`nodeName`

Constructor Summary

Constructors
Constructor and Description

SyncReplPolicy()
Empty constructor for externalizable.

SyncReplPolicy(String nodeName)
Constructor.

Constructors
Constructor and Description
`SyncReplPolicy()` Empty constructor for externalizable.
`SyncReplPolicy(String nodeName)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`getAckIntervalTime()`
`long`	`getAsyncIntervalToCheck()`
`long`	`getAsyncOneWayHeartBeatInterval()`
`ConsistencyLevel`	`getConsistencyLevel()`
`String`	`getDump()` Debug dump info.
`int`	`getMaxThrottleTPWhenInactive()`
`int`	`getMinThrottleTPWhenActive()`
`String`	`getMulticastIpGroup()`
`int`	`getMulticastMaxThreadPoolSize()`
`int`	`getMulticastMinThreadPoolSize()`
`int`	`getMulticastPort()`
`int`	`getMulticastTTL()`
`int`	`getMultipleOperationChunkSize()`
`String`	`getNodeName()`
`long`	`getResponseTimeout()`
`long`	`getTargetConsumeTimeout()`
`long`	`getTodoQueueTimeout()`
`int`	`getUnicastMaxThreadPoolSize()`
`int`	`getUnicastMinThreadPoolSize()`
`boolean`	`isAdaptiveMulticast()`
`boolean`	`isHoldTxnLockUntilSyncReplication()`
`boolean`	`isThrottleWhenInactive()`
`void`	`readExternal(ObjectInput in)`
`void`	`setAdaptiveMulticast(boolean isAdaptive)` if `true` multicast protocol will be adopted with TCP/IP.
`void`	`setAsyncOneWayHeartBeatInterval(long heartBeatIntervalTime)`
`void`	`setConsistencyLevel(ConsistencyLevel consistencyLevel)`
`void`	`setHoldTxnLockUntilSyncReplication(boolean isHoldTxnLock)` Set sync-replication mode under transactions.
`void`	`setMaxThrottleTPWhenInactive(int maxThrottleTPWhenInactive)`
`void`	`setMinThrottleTPWhenActive(int minThrottleTPWhenActive)`
`void`	`setMulticastIpGroup(String multicastIpGroup)`
`void`	`setMulticastMaxThreadPoolSize(int multicastMaxThreadPoolSize)`
`void`	`setMulticastMinThreadPoolSize(int multicastMinThreadPoolSize)`
`void`	`setMulticastPort(int multicastPort)`
`void`	`setMulticastTTL(int timeToLeave)`
`void`	`setMultipleOperationChunkSize(int chunkSmultipleOperChunkSizeize)`
`void`	`setNodeName(String nodeName)`
`void`	`setTargetConsumeTimeout(long targetConsumeTimeout)`
`void`	`setThrottleWhenInactive(boolean throttleWhenInactive)`
`void`	`setTodoQueueTimeout(long todoQueueTimeout)` Set todoQueue timeout.
`void`	`setUnicastMaxThreadPoolSize(int unicastMaxThreadPoolSize)`
`void`	`setUnicastMinThreadPoolSize(int unicastMinThreadPoolSize)`
`String`	`toString()`
`void`	`writeExternal(ObjectOutput out)`

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

- Field Detail
  - DEFAULT_IP_GROUP
```
public static final String DEFAULT_IP_GROUP
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PORT
```
public static final int DEFAULT_PORT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MULTICAST_TTL
```
public static final int DEFAULT_MULTICAST_TTL
```
    See Also:
    
    Constant Field Values
  - DEFAULT_TODO_QUEUE_TIMEOUT
```
public static final long DEFAULT_TODO_QUEUE_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ASYNC_INTERVAL_TO_CHECK
```
public static final long DEFAULT_ASYNC_INTERVAL_TO_CHECK
```
    See Also:
    
    Constant Field Values
  - DEFAULT_RESPONSE_TIMEOUT
```
public static final long DEFAULT_RESPONSE_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ACK_INTERVAL
```
public static final long DEFAULT_ACK_INTERVAL
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ASYNC_ONE_WAY_HEARTBEAT_INTERVAL
```
public static final long DEFAULT_ASYNC_ONE_WAY_HEARTBEAT_INTERVAL
```
    See Also:
    
    Constant Field Values
  - DEFAULT_UNICAST_MIN_WORK_THREADS
```
public static final int DEFAULT_UNICAST_MIN_WORK_THREADS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_UNICAST_MAX_WORK_THREADS
```
public static final int DEFAULT_UNICAST_MAX_WORK_THREADS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MULTICAST_MIN_WORK_THREADS
```
public static final int DEFAULT_MULTICAST_MIN_WORK_THREADS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MULTICAST_MAX_WORK_THREADS
```
public static final int DEFAULT_MULTICAST_MAX_WORK_THREADS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MULTIPLE_OPERATION_CHUNK_SIZE
```
public static final int DEFAULT_MULTIPLE_OPERATION_CHUNK_SIZE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_THROTTLE_WHEN_INACTIVE
```
public static final boolean DEFAULT_THROTTLE_WHEN_INACTIVE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_THROTTLE_TP_WHEN_INACTIVE
```
public static final int DEFAULT_MAX_THROTTLE_TP_WHEN_INACTIVE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MIN_THROTTLE_TP_WHEN_ACTIVE
```
public static final int DEFAULT_MIN_THROTTLE_TP_WHEN_ACTIVE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_TARGET_CONSUME_TIMEOUT
```
public static final long DEFAULT_TARGET_CONSUME_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CONSISTENCY_LEVEL
```
public static final ConsistencyLevel DEFAULT_CONSISTENCY_LEVEL
```
  - nodeName
```
public String nodeName
```
- Constructor Detail
  - SyncReplPolicy
```
public SyncReplPolicy()
```
    Empty constructor for externalizable. Should not be used for other purposes.
  - SyncReplPolicy
```
public SyncReplPolicy(String nodeName)
```
    Constructor.
    
    Parameters:
    
    nodeNameThe - name of node.
- Method Detail
  - writeExternal
```
public void writeExternal(ObjectOutput out)
                   throws IOException
```
    Specified by:
    
    writeExternal in interface Externalizable
    
    Throws:
    
    IOException
  - readExternal
```
public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
```
    Specified by:
    
    readExternal in interface Externalizable
    
    Throws:
    
    IOException
    
    ClassNotFoundException
  - isHoldTxnLockUntilSyncReplication
```
public boolean isHoldTxnLockUntilSyncReplication()
```
    Returns:
    
    if true hold transaction lock until sync replication will be finished.
  - setHoldTxnLockUntilSyncReplication
```
public void setHoldTxnLockUntilSyncReplication(boolean isHoldTxnLock)
```
    Set sync-replication mode under transactions.
    
    Parameters:
    
    isHoldTxnLock - If true holds transaction lock until sync-replication will be finished. NOTE: If true, may cause to the distributed sync-replication dead-locks. Use only if special cases.
  - setAsyncOneWayHeartBeatInterval
```
public void setAsyncOneWayHeartBeatInterval(long heartBeatIntervalTime)
```
  - getAsyncOneWayHeartBeatInterval
```
public long getAsyncOneWayHeartBeatInterval()
```
  - getAsyncIntervalToCheck
```
public long getAsyncIntervalToCheck()
```
    Returns:
    
    Returns the asyncIntervalToCheck.
  - getMulticastIpGroup
```
public String getMulticastIpGroup()
```
  - getMulticastPort
```
public int getMulticastPort()
```
  - getMulticastTTL
```
public int getMulticastTTL()
```
  - setMulticastTTL
```
public void setMulticastTTL(int timeToLeave)
```
  - setNodeName
```
public void setNodeName(String nodeName)
```
    Parameters:
    
    nodeName - The nodeName to set.
  - getNodeName
```
public String getNodeName()
```
  - getMulticastMaxThreadPoolSize
```
public int getMulticastMaxThreadPoolSize()
```
    Returns:
    
    Returns the multicastMaxThreadPoolSize.
  - setMulticastMaxThreadPoolSize
```
public void setMulticastMaxThreadPoolSize(int multicastMaxThreadPoolSize)
```
    Parameters:
    
    multicastMaxThreadPoolSize - The multicastMaxThreadPoolSize to set.
  - getMulticastMinThreadPoolSize
```
public int getMulticastMinThreadPoolSize()
```
    Returns:
    
    Returns the multicastMinThreadPoolSize.
  - setMulticastMinThreadPoolSize
```
public void setMulticastMinThreadPoolSize(int multicastMinThreadPoolSize)
```
    Parameters:
    
    multicastMinThreadPoolSize - The multicastMinThreadPoolSize to set.
  - getResponseTimeout
```
public long getResponseTimeout()
```
    Returns:
    
    Returns the responseTimeout.
  - getTodoQueueTimeout
```
public long getTodoQueueTimeout()
```
    Returns:
    
    Returns the todoQueueTimeout.
  - setTodoQueueTimeout
```
public void setTodoQueueTimeout(long todoQueueTimeout)
```
    Set todoQueue timeout. According this time calculate: responseTimeout and ackIntervalTime time. responseTimeout = todoQueueTimeout + (long)( todoQueueTimeout * 0.3 ); ackIntervalTime = todoQueueTimeout / 2; Multicast Sync replication
    
    Parameters:
    
    todoQueueTimeout - The todoQueueTimeout to set.
  - setAdaptiveMulticast
```
public void setAdaptiveMulticast(boolean isAdaptive)
```
    if true multicast protocol will be adopted with TCP/IP. Adoptive binary algorithm will find an max event size threshold for multicast packet. if the multicast packet is greater that max threashold this packet packet will be sent by TCP/IP.
    
    Parameters:
    
    isAdaptive - isAdaptive multicast.
  - isAdaptiveMulticast
```
public boolean isAdaptiveMulticast()
```
  - getUnicastMaxThreadPoolSize
```
public int getUnicastMaxThreadPoolSize()
```
    Returns:
    
    Returns the unicastMaxThreadPoolSize.
  - setUnicastMaxThreadPoolSize
```
public void setUnicastMaxThreadPoolSize(int unicastMaxThreadPoolSize)
```
    Parameters:
    
    unicastMaxThreadPoolSize - The unicastMaxThreadPoolSize to set.
  - getUnicastMinThreadPoolSize
```
public int getUnicastMinThreadPoolSize()
```
    Returns:
    
    Returns the unicastMinThreadPoolSize.
  - setUnicastMinThreadPoolSize
```
public void setUnicastMinThreadPoolSize(int unicastMinThreadPoolSize)
```
    Parameters:
    
    unicastMinThreadPoolSize - The unicastMinThreadPoolSize to set.
  - getAckIntervalTime
```
public long getAckIntervalTime()
```
    Returns:
    
    The ackIntervalTime.
  - setMulticastIpGroup
```
public void setMulticastIpGroup(String multicastIpGroup)
```
    Parameters:
    
    multicastIpGroup - The multicastIpGroup to set.
  - setMulticastPort
```
public void setMulticastPort(int multicastPort)
```
    Parameters:
    
    multicastPort - The multicastPort to set.
  - setMultipleOperationChunkSize
```
public void setMultipleOperationChunkSize(int chunkSmultipleOperChunkSizeize)
```
    Parameters:
    
    chunkSize - maximum operations chunk size, or -1 if chunk mechanism disabled.
  - getMultipleOperationChunkSize
```
public int getMultipleOperationChunkSize()
```
    Returns:
    
    the defined maximum chunk for multiple operations, or -1 if chunk mechanism disabled.
  - isThrottleWhenInactive
```
public boolean isThrottleWhenInactive()
```
  - setThrottleWhenInactive
```
public void setThrottleWhenInactive(boolean throttleWhenInactive)
```
  - getMaxThrottleTPWhenInactive
```
public int getMaxThrottleTPWhenInactive()
```
  - setMaxThrottleTPWhenInactive
```
public void setMaxThrottleTPWhenInactive(int maxThrottleTPWhenInactive)
```
  - getMinThrottleTPWhenActive
```
public int getMinThrottleTPWhenActive()
```
  - setMinThrottleTPWhenActive
```
public void setMinThrottleTPWhenActive(int minThrottleTPWhenActive)
```
  - getTargetConsumeTimeout
```
public long getTargetConsumeTimeout()
```
  - setTargetConsumeTimeout
```
public void setTargetConsumeTimeout(long targetConsumeTimeout)
```
  - getConsistencyLevel
```
public ConsistencyLevel getConsistencyLevel()
```
  - setConsistencyLevel
```
public void setConsistencyLevel(ConsistencyLevel consistencyLevel)
```
  - getDump
```
public String getDump()
```
    Debug dump info.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SyncReplPolicy

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_IP_GROUP

DEFAULT_PORT

DEFAULT_MULTICAST_TTL

DEFAULT_TODO_QUEUE_TIMEOUT

DEFAULT_ASYNC_INTERVAL_TO_CHECK

DEFAULT_RESPONSE_TIMEOUT

DEFAULT_ACK_INTERVAL

DEFAULT_ASYNC_ONE_WAY_HEARTBEAT_INTERVAL

DEFAULT_UNICAST_MIN_WORK_THREADS

DEFAULT_UNICAST_MAX_WORK_THREADS

DEFAULT_MULTICAST_MIN_WORK_THREADS

DEFAULT_MULTICAST_MAX_WORK_THREADS

DEFAULT_MULTIPLE_OPERATION_CHUNK_SIZE

DEFAULT_THROTTLE_WHEN_INACTIVE

DEFAULT_MAX_THROTTLE_TP_WHEN_INACTIVE

DEFAULT_MIN_THROTTLE_TP_WHEN_ACTIVE

DEFAULT_TARGET_CONSUME_TIMEOUT

DEFAULT_CONSISTENCY_LEVEL

nodeName

Constructor Detail

SyncReplPolicy

SyncReplPolicy

Method Detail

writeExternal

readExternal

isHoldTxnLockUntilSyncReplication

setHoldTxnLockUntilSyncReplication

setAsyncOneWayHeartBeatInterval

getAsyncOneWayHeartBeatInterval

getAsyncIntervalToCheck

getMulticastIpGroup

getMulticastPort

getMulticastTTL

setMulticastTTL

setNodeName

getNodeName

getMulticastMaxThreadPoolSize

setMulticastMaxThreadPoolSize

getMulticastMinThreadPoolSize

setMulticastMinThreadPoolSize

getResponseTimeout

getTodoQueueTimeout

setTodoQueueTimeout

setAdaptiveMulticast

isAdaptiveMulticast

getUnicastMaxThreadPoolSize

setUnicastMaxThreadPoolSize

getUnicastMinThreadPoolSize

setUnicastMinThreadPoolSize

getAckIntervalTime

setMulticastIpGroup

setMulticastPort

setMultipleOperationChunkSize

getMultipleOperationChunkSize

isThrottleWhenInactive

setThrottleWhenInactive

getMaxThrottleTPWhenInactive

setMaxThrottleTPWhenInactive

getMinThrottleTPWhenActive

setMinThrottleTPWhenActive

getTargetConsumeTimeout

setTargetConsumeTimeout

getConsistencyLevel

setConsistencyLevel

getDump

toString