IGridMapPessimisticTx TKey, TValue  MembersIBM WebSphere™ eXtreme Scale Client for .NET API Specification
IBM WebSphere™ eXtreme Scale Client for .NET Release 8.6.0.0 API Specification

The IGridMapPessimisticTx TKey, TValue  type exposes the following members.
Methods

  NameDescription
Public methodAdd
Adds the key-value pair to the data grid.

The key must not exist before you run this method.

A DuplicateKeyException exception results when the duplicate key is discovered. Duplicate keys might be discovered with a flush or commit operation. In this scenario, the exception is an inner exception.

Public methodAddAll
Adds multiple key-value pairs to the data grid.

The keys must not exist before executing this method.

A DuplicateKeyException exception results when the duplicate key is discovered. This discovery might happen during a flush or commit operation. In this scenario, the exception is an inner exception.

Public methodContainsKey
Looks in the map for an entry that is associated with the specified the key. If an entry is found, true is returned. If an entry is not found, false is returned. Data grids do not support null key values, so a null key cannot be specified.

This API does not hold any locks. Use the Lock(TKey, LockMode) to test for a key and retain a lock.

Public methodContainsKeyAll
Looks in the map for the entries that are associated with the specified keys in the keyList. If an entry is located, true is returned. If an entry is not located, false is returned. Data grids do not support null key values, so a null key cannot be specified in a keyList.

This API does not hold any locks. Use the LockAll(IList TKey , LockMode) to test for a key and retain a lock.

Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Public methodGet
Retrieves the value that is associated with the specified key. If the value is not found, a null is returned.

If the map supports null values, use the Lock(TKey, LockMode) or the ContainsKey(TKey) to test for a key that may have a null value.

Public methodGetAll
Public methodGetAndLock
Locks the specified key and retrieves the associated value. If the value is not found, a null is returned.

If the map supports null values, use the Lock(TKey, LockMode) or the ContainsKey(TKey) to test for a key that might have a null value.

Public methodGetAndLockAll
Public methodInvalidate
Removes the entry that is associated with the specified key from the data grid, without affecting the Loader (back-end persistent store).

If the key cannot be found in the map, the operation is ignored.

Public methodInvalidateAll
Removes the entries that are associated with the specified keyList from the data grid, without affecting the Loader (back-end persistent store).

If a key cannot be found in the map, the operation is ignored.

Public methodLock
Locks the specified key and tests to see if the key was previously present in the data grid or Loader.
Public methodLockAll
Locks the specified keys and tests to see if each was previously present in the data grid or Loader.
Public methodPut
Puts the specified key and value into the data grid, replacing or adding a new entry to each data grid tier as needed.

Note: This method has the same specification as the ObjectMap.upsert method in the eXtreme Scale Java client.

Public methodPutAll
Puts multiple key-value pairs to the data grid, replacing or adding new entries to each data grid tier as needed.

Note: This method has the same specification as the ObjectMap.upsertAll method in the eXtreme Scale Java client.

Public methodRemove
Removes the entry that is associated with the specified key from the data grid and Loader (back-end persistent store).

If the key cannot be found in the map, the operation is ignored.

Public methodRemoveAll
Removes the entries that are associated with the specified keyList from the data grid and Loader (back-end persistent store).

If a key cannot be found in the map, the operation is ignored.

Public methodReplace
Replaces the existing entry that is associated with the specified key with the specified value from the data grid and Loader (back-end persistent store).

If the key cannot be found in the data grid a CacheKeyNotFoundException exception results during the commit operation.

Public methodReplaceAll
Replaces multiple key-value pairs into the data grid and Loader (back-end persistent store).

If a key cannot be found in the map a CacheKeyNotFoundException exception results.

Public methodResetToDefaults
Resets the configurable settings for the map back to configured values.
Public methodTouch
Updates the last access time for the data grid entry that matches the key without locking the entry or fetching the value.

If the key cannot be found in the map a CacheKeyNotFoundException exception results during the commit operation.

Public methodTouchAll
Updates the last access time for the data grid entries that are specified in the keyList list without locking the entries or fetching the values.

If a key cannot be found in the map a CacheKeyNotFoundException exception results during the commit operation.

Back to Top
Properties

  NameDescription
Public propertyGrid
Retrieves the IGrid instance associated with this map.
(Inherited from IGridMap TKey, TValue .)
Public propertyItem
An indexer that retreives or puts the key and value into the map with the Get(TKey) and Put(TKey, TValue) methods.
Public propertyLockTimeout
Gets or sets the maximum time to wait when acquiring a lock on an item in the grid map.
Public propertyName
Retrieves the map name.
(Inherited from IGridMap TKey, TValue .)
Public propertyPartitionManager
Retrieves the IPartitionManager associated with this map.
(Inherited from IGridMap TKey, TValue .)
Public propertyTimeToLive
Establishes the interval of time that any given cache entry can live for, which is referred to as "time to live" or TTL. Setting a new TTL value affects cache entries that are accessed after this method call occurs. It does not affect any cache entry that was created or accessed prior to this method call. By calling this method on this IGridMapPessimisticTx, any previous value set by the IGridMapPessimisticTx.TimeToLive property is overridden for this map instnace. If this method is never called on the map, the default setting is used. The default setting is to retain the time-to-live value for any existing map entry and to use the default value from map configuration setting if a new map entry is being created. If TTL is never set on the map configuration, the cache entry can live "forever".

This property can be used only when the TtlEvictorType property is set to LastAccessTime or LastUpdateTime on the map configuration. If this method is called on the IGridMapPessimisticTx and the TtlEvictorType is something other than LastAccessTime or LastUpdateTime, an ArgumentException exception results.

To disable the TTL timeout, use a value of TimeSpan.Zero.

To revert the TTL value to the configured default, use a value of TimeSpan.MinValue.

Public propertyTransaction
The Transaction instance used to configure and demarcate a transaction.
(Inherited from ITransactionable.)
Public propertyTtlEvictorType
Retrieves the time to live type for the evictor on the map.
Back to Top
See Also