org.gridgain.grid.cache

Interface GridCacheMBean

@GridMBeanDescription(value="MBean that provides access to cache descriptor.")
public interface GridCacheMBean

This interface defines JMX view on GridCache.

Method Summary

Methods

Modifier and Type	Method and Description
int	getDhtEvictQueueCurrentSize() Gets current size of evict queue used to batch up evictions.
int	getDrBackupQueueSize() Gets size of data center replication backup queue.
int	getDrBatchWaitingAcknowledgeCount() Gets count of data center replication batches awaiting acknowledge from sender hub.
int	getDrBatchWaitingSendCount() Gets count of data center replication batches awaiting to be send.
int	getDrQueuedKeysCount() Gets count of keys enqueued for data center replication.
int	getDrSenderHubsCount() Gets count of available data center replication sender hubs.
int	getKeySize() Gets number of keys in the cache, possibly with null values.
long	getOffHeapAllocatedSize() Gets memory size allocated in off-heap.
long	getOffHeapEntriesCount() Gets number of entries stored in off-heap memory.
long	getOverflowSize() Gets number of entries that was swapped to disk.
int	getSize() Returns number of non-null values in the cache.
int	getTxCommitQueueSize() Gets committed transaction queue size.
int	getTxCommittedVersionsSize() Gets number of cached committed transaction IDs.
int	getTxDhtCommitQueueSize() Gets committed DHT transaction queue size.
int	getTxDhtCommittedVersionsSize() Gets number of cached committed DHT transaction IDs.
int	getTxDhtPrepareQueueSize() Gets prepared DHT transaction queue size.
int	getTxDhtRolledbackVersionsSize() Gets number of cached rolled back DHT transaction IDs.
int	getTxDhtStartVersionCountsSize() Gets DHT start version counts map size.
int	getTxDhtThreadMapSize() Gets transaction DHT per-thread map size.
int	getTxDhtXidMapSize() Gets transaction DHT per-Xid map size.
int	getTxPrepareQueueSize() Gets prepared transaction queue size.
int	getTxRolledbackVersionsSize() Gets number of cached rolled back transaction IDs.
int	getTxStartVersionCountsSize() Gets start version counts map size.
int	getTxThreadMapSize() Gets transaction per-thread map size.
int	getTxXidMapSize() Gets transaction per-Xid map size.
int	getWriteBehindBufferSize() Gets count of entries that were processed by the write-behind store and have not been flushed to the underlying store yet.
int	getWriteBehindCriticalOverflowCount() Gets count of write buffer overflow events in progress at the moment.
int	getWriteBehindErrorRetryCount() Gets count of cache entries that are in a store-retry state.
long	getWriteBehindFlushFrequency() Gets the cache flush frequency.
int	getWriteBehindFlushSize() Gets the maximum size of the write-behind buffer.
int	getWriteBehindFlushThreadCount() Gets the number of flush threads that will perform store update operations.
int	getWriteBehindStoreBatchSize() Gets the maximum count of similar (put or remove) operations that can be grouped to a single batch.
int	getWriteBehindTotalCriticalOverflowCount() Gets count of write buffer overflow events since initialization.
boolean	isEmpty() Returns true if this cache is empty.
boolean	isWriteBehindEnabled() Returns True if write-behind is enabled.
String	metricsFormatted() Gets metrics (statistics) for this cache.
String	name() Gets name of this cache.

Method Detail

name

@GridMBeanDescription(value="Cache name.")
String name()

Gets name of this cache.

Returns:

Cache name.

metricsFormatted

@GridMBeanDescription(value="Formatted cache metrics.")
String metricsFormatted()

Gets metrics (statistics) for this cache.

Returns:

Cache metrics.

getOverflowSize

@GridMBeanDescription(value="Number of entries that was swapped to disk.")
long getOverflowSize()

Gets number of entries that was swapped to disk.

Returns:

Number of entries that was swapped to disk.

getOffHeapEntriesCount

@GridMBeanDescription(value="Number of entries stored in off-heap memory.")
long getOffHeapEntriesCount()

Gets number of entries stored in off-heap memory.

Returns:

Number of entries stored in off-heap memory.

getOffHeapAllocatedSize

@GridMBeanDescription(value="Memory size allocated in off-heap.")
long getOffHeapAllocatedSize()

Gets memory size allocated in off-heap.

Returns:

Memory size allocated in off-heap.

getSize

@GridMBeanDescription(value="Number of non-null values in the cache.")
int getSize()

Returns number of non-null values in the cache.

Returns:

Number of non-null values in the cache.

getKeySize

@GridMBeanDescription(value="Number of keys in the cache (possibly with null values).")
int getKeySize()

Gets number of keys in the cache, possibly with null values.

Returns:

Number of keys in the cache.

isEmpty

@GridMBeanDescription(value="True if cache is empty.")
boolean isEmpty()

Returns true if this cache is empty.

Returns:

true if this cache is empty.

getDhtEvictQueueCurrentSize

@GridMBeanDescription(value="Current size of evict queue.")
int getDhtEvictQueueCurrentSize()

Gets current size of evict queue used to batch up evictions.

Returns:

Current size of evict queue.

getTxThreadMapSize

@GridMBeanDescription(value="Transaction per-thread map size.")
int getTxThreadMapSize()

Gets transaction per-thread map size.

Returns:

Thread map size.

getTxXidMapSize

@GridMBeanDescription(value="Transaction per-Xid map size.")
int getTxXidMapSize()

Gets transaction per-Xid map size.

Returns:

Transaction per-Xid map size.

getTxCommitQueueSize

@GridMBeanDescription(value="Transaction committed queue size.")
int getTxCommitQueueSize()

Gets committed transaction queue size.

Returns:

Committed transaction queue size.

getTxPrepareQueueSize

@GridMBeanDescription(value="Transaction prepared queue size.")
int getTxPrepareQueueSize()

Gets prepared transaction queue size.

Returns:

Prepared transaction queue size.

getTxStartVersionCountsSize

@GridMBeanDescription(value="Transaction start version counts map size.")
int getTxStartVersionCountsSize()

Gets start version counts map size.

Returns:

Start version counts map size.

getTxCommittedVersionsSize

@GridMBeanDescription(value="Transaction committed ID map size.")
int getTxCommittedVersionsSize()

Gets number of cached committed transaction IDs.

Returns:

Number of cached committed transaction IDs.

getTxRolledbackVersionsSize

@GridMBeanDescription(value="Transaction rolled back ID map size.")
int getTxRolledbackVersionsSize()

Gets number of cached rolled back transaction IDs.

Returns:

Number of cached rolled back transaction IDs.

getTxDhtThreadMapSize

@GridMBeanDescription(value="Transaction DHT per-thread map size.")
int getTxDhtThreadMapSize()

Gets transaction DHT per-thread map size.

Returns:

DHT thread map size.

getTxDhtXidMapSize

@GridMBeanDescription(value="Transaction DHT per-Xid map size.")
int getTxDhtXidMapSize()

Gets transaction DHT per-Xid map size.

Returns:

Transaction DHT per-Xid map size.

getTxDhtCommitQueueSize

@GridMBeanDescription(value="Transaction DHT committed queue size.")
int getTxDhtCommitQueueSize()

Gets committed DHT transaction queue size.

Returns:

Committed DHT transaction queue size.

getTxDhtPrepareQueueSize

@GridMBeanDescription(value="Transaction DHT prepared queue size.")
int getTxDhtPrepareQueueSize()

Gets prepared DHT transaction queue size.

Returns:

Prepared DHT transaction queue size.

getTxDhtStartVersionCountsSize

@GridMBeanDescription(value="Transaction DHT start version counts map size.")
int getTxDhtStartVersionCountsSize()

Gets DHT start version counts map size.

Returns:

DHT start version counts map size.

getTxDhtCommittedVersionsSize

@GridMBeanDescription(value="Transaction DHT committed ID map size.")
int getTxDhtCommittedVersionsSize()

Gets number of cached committed DHT transaction IDs.

Returns:

Number of cached committed DHT transaction IDs.

getTxDhtRolledbackVersionsSize

@GridMBeanDescription(value="Transaction DHT rolled back ID map size.")
int getTxDhtRolledbackVersionsSize()

Gets number of cached rolled back DHT transaction IDs.

Returns:

Number of cached rolled back DHT transaction IDs.

isWriteBehindEnabled

@GridMBeanDescription(value="True if write-behind is enabled for this cache.")
boolean isWriteBehindEnabled()

Returns True if write-behind is enabled.

Returns:

True if write-behind is enabled.

getWriteBehindFlushSize

@GridMBeanDescription(value="Size of internal buffer that triggers flush procedure.")
int getWriteBehindFlushSize()

Gets the maximum size of the write-behind buffer. When the count of unique keys in write buffer exceeds this value, the buffer is scheduled for write to the underlying store.

If this value is 0, then flush is performed only on time-elapsing basis. However, when this value is 0, the cache critical size is set to GridCacheConfiguration.DFLT_WRITE_BEHIND_CRITICAL_SIZE

Returns:

Buffer size that triggers flush procedure.

getWriteBehindFlushThreadCount

@GridMBeanDescription(value="Count of flush threads.")
int getWriteBehindFlushThreadCount()

Gets the number of flush threads that will perform store update operations.

Returns:

Count of worker threads.

getWriteBehindFlushFrequency

@GridMBeanDescription(value="Flush frequency interval in milliseconds.")
long getWriteBehindFlushFrequency()

Gets the cache flush frequency. All pending operations on the underlying store will be performed within time interval not less then this value.

If this value is 0, then flush is performed only when buffer size exceeds flush size.

Returns:

Flush frequency in milliseconds.

getWriteBehindStoreBatchSize

@GridMBeanDescription(value="Maximum size of batch for similar operations.")
int getWriteBehindStoreBatchSize()

Gets the maximum count of similar (put or remove) operations that can be grouped to a single batch.

Returns:

Maximum size of batch.

getWriteBehindTotalCriticalOverflowCount

@GridMBeanDescription(value="Count of cache overflow events since write-behind cache has started.")
int getWriteBehindTotalCriticalOverflowCount()

Gets count of write buffer overflow events since initialization. Each overflow event causes the ongoing flush operation to be performed synchronously.

Returns:

Count of cache overflow events since start.

getWriteBehindCriticalOverflowCount

@GridMBeanDescription(value="Count of cache overflow events since write-behind cache has started.")
int getWriteBehindCriticalOverflowCount()

Gets count of write buffer overflow events in progress at the moment. Each overflow event causes the ongoing flush operation to be performed synchronously.

Returns:

Count of cache overflow events since start.

getWriteBehindErrorRetryCount

@GridMBeanDescription(value="Count of cache cache entries that are currently in retry state.")
int getWriteBehindErrorRetryCount()

Gets count of cache entries that are in a store-retry state. An entry is assigned a store-retry state when underlying store failed due some reason and cache has enough space to retain this entry till the next try.

Returns:

Count of entries in store-retry state.

getWriteBehindBufferSize

@GridMBeanDescription(value="Count of cache entries that are waiting to be flushed.")
int getWriteBehindBufferSize()

Gets count of entries that were processed by the write-behind store and have not been flushed to the underlying store yet.

Returns:

Total count of entries in cache store internal buffer.

getDrQueuedKeysCount

@GridMBeanDescription(value="Count of keys enqueued for data center replication.")
int getDrQueuedKeysCount()

Gets count of keys enqueued for data center replication.

Returns:

Count of keys enqueued for data center replication.

getDrBackupQueueSize

@GridMBeanDescription(value="Size of data center replication backup queue.")
int getDrBackupQueueSize()

Gets size of data center replication backup queue.

Returns:

Size of data center replication backup queue.

getDrBatchWaitingSendCount

@GridMBeanDescription(value="Count of data center replication batches awaiting to be send.")
int getDrBatchWaitingSendCount()

Gets count of data center replication batches awaiting to be send.

Returns:

Count of data center replication batches awaiting to be send.

getDrBatchWaitingAcknowledgeCount

@GridMBeanDescription(value="Count of data center replication batches awaiting acknowledge from sender hub.")
int getDrBatchWaitingAcknowledgeCount()

Gets count of data center replication batches awaiting acknowledge from sender hub.

Returns:

Count of data center replication batches awaiting acknowledge from sender hub.

getDrSenderHubsCount

@GridMBeanDescription(value="Count of available data center replication sender hubs.")
int getDrSenderHubsCount()

Gets count of available data center replication sender hubs.

Returns:

Count of available data center replication sender hubs.