GemFire 6.6.1

com.gemstone.gemfire.cache.util
Class GatewayQueueAttributes

java.lang.Object
  extended by com.gemstone.gemfire.cache.util.GatewayQueueAttributes

public class GatewayQueueAttributes
extends Object

Class GatewayQueueAttributes contains attributes related to the Gateway queue such as batch size and disk directories.

Since:
4.2

Field Summary
static int DEFAULT_ALERT_THRESHOLD
          The default alert threshold in milliseconds
static boolean DEFAULT_BATCH_CONFLATION
          The default batch conflation
static int DEFAULT_BATCH_SIZE
          The default batch size
static int DEFAULT_BATCH_TIME_INTERVAL
          The default batch time interval in milliseconds
static boolean DEFAULT_ENABLE_COMPACTION
          The default oplog compaction behaviour
static boolean DEFAULT_ENABLE_PERSISTENCE
          The default enable persistence
static boolean DEFAULT_ENABLE_ROLLING
          Deprecated. as of 6.5 use DEFAULT_ENABLE_COMPACTION instead.
static int DEFAULT_MAXIMUM_QUEUE_MEMORY
          The default maximum amount of memory (MB) to allow in the queue before overflowing entries to disk
static String DEFAULT_OVERFLOW_DIRECTORY
          The default overflow directory
 
Constructor Summary
GatewayQueueAttributes()
          Default constructor.
GatewayQueueAttributes(String overflowDirectory, int maximumQueueMemory, int batchSize, int batchTimeInterval, boolean batchConflation, boolean enablePersistence, boolean enableCompaction, int alertThreshold)
          Deprecated. use GatewayQueueAttributes(String, int, int, int, boolean, boolean, int) to specify a disk store name, rather than a directory name.
GatewayQueueAttributes(String diskStoreName, int maximumQueueMemory, int batchSize, int batchTimeInterval, boolean batchConflation, boolean enablePersistence, int alertThreshold)
          Constructor.
 
Method Summary
 int getAlertThreshold()
          Returns the alert threshold for entries in a Gateway's queue.
 boolean getBatchConflation()
          Answers whether to enable batch conflation for a Gateway's queue.
 int getBatchSize()
          Answers the batch size for a Gateway's queue.
 int getBatchTimeInterval()
          Answers the batch time interval for a Gateway's queue.
 String getDiskStoreName()
          Gets the disk store name for overflow
 boolean getEnablePersistence()
          Answers whether to enable persistence for a Gateway's queue.
 int getMaximumQueueMemory()
          Answers maximum amount of memory (in MB) for a Gateway's queue.
 String getOverflowDirectory()
          Deprecated. as of 6.5 use getDiskStoreName() instead.
 boolean hasOverflowDirectory()
          Deprecated. as of 6.5 use getDiskStoreName() instead.
 boolean isRollOplogs()
          Deprecated. as of 6.5 use getDiskStoreName() instead. On the disk store, use DiskStore.getAutoCompact()
 void setAlertThreshold(int threshold)
          Sets the alert threshold for entries in a Gateway's queue.
 void setBatchConflation(boolean batchConflation)
          Sets whether to enable batch conflation for a Gateway's queue.
 void setBatchSize(int batchSize)
          Sets the batch size for a Gateway's queue.
 void setBatchTimeInterval(int batchTimeInterval)
          Sets the batch time interval for a Gateway's queue.
 void setDiskStoreName(String diskStoreName)
          Sets the disk store name for overflow
 void setEnablePersistence(boolean enablePersistence)
          Sets whether to enable persistence for a Gateway's queue.
 void setMaximumQueueMemory(int maximumQueueMemory)
          Sets the maximum amount of memory (in MB) for a Gateway's queue.
 void setOverflowDirectory(String overflowDirectory)
          Deprecated. as of 6.5 use setDiskStoreName(String) instead.
 void setRollOplogs(boolean rollingEnabled)
          Deprecated. as of 6.5 use setDiskStoreName(String) instead. When creating the disk store, use DiskStoreFactory.setAutoCompact(boolean) to control compaction.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_OVERFLOW_DIRECTORY

public static final String DEFAULT_OVERFLOW_DIRECTORY
The default overflow directory

See Also:
Constant Field Values

DEFAULT_MAXIMUM_QUEUE_MEMORY

public static final int DEFAULT_MAXIMUM_QUEUE_MEMORY
The default maximum amount of memory (MB) to allow in the queue before overflowing entries to disk

See Also:
Constant Field Values

DEFAULT_BATCH_SIZE

public static final int DEFAULT_BATCH_SIZE
The default batch size

See Also:
Constant Field Values

DEFAULT_BATCH_TIME_INTERVAL

public static final int DEFAULT_BATCH_TIME_INTERVAL
The default batch time interval in milliseconds

See Also:
Constant Field Values

DEFAULT_BATCH_CONFLATION

public static final boolean DEFAULT_BATCH_CONFLATION
The default batch conflation

See Also:
Constant Field Values

DEFAULT_ENABLE_PERSISTENCE

public static final boolean DEFAULT_ENABLE_PERSISTENCE
The default enable persistence

See Also:
Constant Field Values

DEFAULT_ENABLE_COMPACTION

public static final boolean DEFAULT_ENABLE_COMPACTION
The default oplog compaction behaviour

Since:
6.5
See Also:
Constant Field Values

DEFAULT_ENABLE_ROLLING

public static final boolean DEFAULT_ENABLE_ROLLING
Deprecated. as of 6.5 use DEFAULT_ENABLE_COMPACTION instead.
The default oplog compaction behaviour

See Also:
Constant Field Values

DEFAULT_ALERT_THRESHOLD

public static final int DEFAULT_ALERT_THRESHOLD
The default alert threshold in milliseconds

See Also:
Constant Field Values
Constructor Detail

GatewayQueueAttributes

public GatewayQueueAttributes()
Default constructor.


GatewayQueueAttributes

public GatewayQueueAttributes(String overflowDirectory,
                              int maximumQueueMemory,
                              int batchSize,
                              int batchTimeInterval,
                              boolean batchConflation,
                              boolean enablePersistence,
                              boolean enableCompaction,
                              int alertThreshold)
Deprecated. use GatewayQueueAttributes(String, int, int, int, boolean, boolean, int) to specify a disk store name, rather than a directory name.

Constructor.

Parameters:
overflowDirectory - The name of the directory in which to store overflowed and/or persisted queue entries (if persistence is enabled)
maximumQueueMemory - The maximum heap memory to be used by the queue
batchSize - The batch size for messages sent between Gateways
batchTimeInterval - The maximum time interval in milliseconds to wait before sending an incomplete batch of messages between Gateways
batchConflation - Whether to enable conflation for batches of messages sent between Gateways
enablePersistence - Whether to enable persistence for this Gateway's queue
enableCompaction - Whether to oplog compaction for this Gateway's queue
alertThreshold - The alert threshold in milliseconds for entries in this Gateway's queue

GatewayQueueAttributes

public GatewayQueueAttributes(String diskStoreName,
                              int maximumQueueMemory,
                              int batchSize,
                              int batchTimeInterval,
                              boolean batchConflation,
                              boolean enablePersistence,
                              int alertThreshold)
Constructor.

Parameters:
diskStoreName - The name of the disk store in which to store overflowed and/or persisted queue entries (if persistence is enabled)
maximumQueueMemory - The maximum heap memory to be used by the queue
batchSize - The batch size for messages sent between Gateways
batchTimeInterval - The maximum time interval in milliseconds to wait before sending an incomplete batch of messages between Gateways
batchConflation - Whether to enable conflation for batches of messages sent between Gateways
enablePersistence - Whether to enable persistence for this Gateway's queue
alertThreshold - The alert threshold in milliseconds for entries in this Gateway's queue
Since:
6.5
Method Detail

setOverflowDirectory

public void setOverflowDirectory(String overflowDirectory)
Deprecated. as of 6.5 use setDiskStoreName(String) instead.

Sets the overflow directory for a Gateway queue's overflowed and/or persisted queue entries.

Parameters:
overflowDirectory - the overflow directory for a Gateway queue's overflowed and/or persisted queue entries

getOverflowDirectory

public String getOverflowDirectory()
Deprecated. as of 6.5 use getDiskStoreName() instead.

Answers the overflow directory for a Gateway queue's overflowed and/or persisted queue entries.

Returns:
the overflow directory for a Gateway queue's overflowed and/or persisted queue entries

setDiskStoreName

public void setDiskStoreName(String diskStoreName)
Sets the disk store name for overflow

Parameters:
diskStoreName -
Since:
6.5

getDiskStoreName

public String getDiskStoreName()
Gets the disk store name for overflow

Returns:
disk store name
Since:
6.5

setMaximumQueueMemory

public void setMaximumQueueMemory(int maximumQueueMemory)
Sets the maximum amount of memory (in MB) for a Gateway's queue.

Parameters:
maximumQueueMemory - The maximum amount of memory (in MB) for a Gateway's queue.

getMaximumQueueMemory

public int getMaximumQueueMemory()
Answers maximum amount of memory (in MB) for a Gateway's queue.

Returns:
maximum amount of memory (in MB) for a Gateway's queue

setBatchSize

public void setBatchSize(int batchSize)
Sets the batch size for a Gateway's queue.

Parameters:
batchSize - The size of batches sent from a Gateway to its corresponding Gateway.

getBatchSize

public int getBatchSize()
Answers the batch size for a Gateway's queue.

Returns:
the batch size for a Gateway's queue

setBatchTimeInterval

public void setBatchTimeInterval(int batchTimeInterval)
Sets the batch time interval for a Gateway's queue.

Parameters:
batchTimeInterval - The maximum time interval that can elapse before a partial batch is sent from a Gateway to its corresponding Gateway.

getBatchTimeInterval

public int getBatchTimeInterval()
Answers the batch time interval for a Gateway's queue.

Returns:
the batch time interval for a Gateway's queue

setBatchConflation

public void setBatchConflation(boolean batchConflation)
Sets whether to enable batch conflation for a Gateway's queue.

Parameters:
batchConflation - Whether or not to enable batch conflation for batches sent from a Gateway to its corresponding Gateway.

getBatchConflation

public boolean getBatchConflation()
Answers whether to enable batch conflation for a Gateway's queue.

Returns:
whether to enable batch conflation for batches sent from a Gateway to its corresponding Gateway.

setEnablePersistence

public void setEnablePersistence(boolean enablePersistence)
Sets whether to enable persistence for a Gateway's queue.

Parameters:
enablePersistence - Whether to enable persistence for a Gateway's queue

getEnablePersistence

public boolean getEnablePersistence()
Answers whether to enable persistence for a Gateway's queue.

Returns:
whether to enable persistence for a Gateway's queue

isRollOplogs

public boolean isRollOplogs()
Deprecated. as of 6.5 use getDiskStoreName() instead. On the disk store, use DiskStore.getAutoCompact()

Answers whether to enable oplog rolling for a Gateway's queue.

Returns:
whether to enable oplog rolling for a Gateway's queue

setRollOplogs

public void setRollOplogs(boolean rollingEnabled)
Deprecated. as of 6.5 use setDiskStoreName(String) instead. When creating the disk store, use DiskStoreFactory.setAutoCompact(boolean) to control compaction.

Sets whether to enable oplog rolling for a Gateway's queue.

Parameters:
rollingEnabled - Whether to enable oplog rolling for a Gateway's queue

setAlertThreshold

public void setAlertThreshold(int threshold)
Sets the alert threshold for entries in a Gateway's queue.

Parameters:
threshold - the alert threshold for entries in a Gateway's queue
Since:
6.0

getAlertThreshold

public int getAlertThreshold()
Returns the alert threshold for entries in a Gateway's queue.

Returns:
the alert threshold for entries in a Gateway's queue
Since:
6.0

hasOverflowDirectory

public boolean hasOverflowDirectory()
Deprecated. as of 6.5 use getDiskStoreName() instead.

Returns true if setOverflowDirectory(java.lang.String) has been called. Returns false if the overflow directory has never been explicitly set.


GemFire 6.6.1

Copyright © 1997-2011 VMware, Inc. All rights reserved.