IGridMapPessimisticAutoTx 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 IGridMapPessimisticAutoTx 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 executing this method.

A DuplicateKeyException is thrown when the duplicate key is discovered.

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

The keys must not exist before executing this method.

A DuplicateKeyException is thrown when the duplicate key is discovered, which may be during a flush or commit operation, in which the exception will be 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 nullkey cannot be specified.
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.
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 ContainsKey(TKey) to test for a key that may have a null value.

Public methodGetAll
Retrieves the values associated with the list of keys that are specified in the keyList. If the value is not found, a null is returned.

If the map supports null values, use the ContainsKeyAll(IList TKey ) to test for multiple keys that may have a null value.

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, it will be 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, it will be ignored.

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 a 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, it will be 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, it will be 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 is thrown during commit.

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 is thrown.

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 is thrown.

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

If a key cannot be found in the map a CacheKeyNotFoundException is thrown.

Public methodTryAdd
A variant of Add(TKey, TValue) that does not throw exceptions.
Public methodTryAddAll
Adds the key-value pairs to the data grid.
Public methodTryInvalidate
Removes the entry associated with the specified key from the cache, leaving the data behind unchanged.
Public methodTryInvalidateAll
Removes the entries associated with the keys that are specified in the keyList from the cache, leaving the data behind unchanged.
Public methodTryPut
Adds the key-value pair to the grid. If an entry for the key exists in the data grid, the value is updated with the specified value. If an entry for a key does not exist in the data grid, the key-value pair is added to the data grid.
Public methodTryPutAll
Adds each key-value pair to the data grid. If an entry for a key exists in the data grid, its value is updated with the specified value. If an entry for a key does not exist in the data grid, the key-value pair is added to the data grid.
Public methodTryRemove
Removes the entry that is associated with the specified key from the data grid. If the key has no matching entry in the map, no action is taken.
Public methodTryRemoveAll
Removes the list of entries associated with the keys that are specified in the keyList. If a key in the keyList has no matching entry in the map, no action is taken for that key.
Public methodTryReplace
Replaces the value of a key-value pair in the data grid. If an entry for the key exists in the data grid, its value is replaced with the specified value.
Public methodTryReplaceAll
Replaces each key-value pair that is specified in the dictionary object in the data grid. If an entry for the key exists in the data grid, its value is replaced with the corresponding value specified.
Public methodTryTouch
Updates the last access time for the data grid entry that matches the key.
Public methodTryTouchAll
Updates the last access time for the data grid entries that match each key in the keyList.
Back to Top
Properties

  NameDescription
Public propertyGrid
Retrieves the IGrid instance associated with this map.
(Inherited from IGridMap TKey, TValue .)
Public propertyItem
Gets or sets the value in the map using the specified key.
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 only be used 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 is thrown.

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 propertyTtlEvictorType
Gets the TtlType of the map's TTL evictor.
Back to Top
See Also