ICPMap<TKey, TValue> Interface

CPMap is a key-value store within CP. It supports atomic operations on an entry.

CPMap is only available in enterprise cluster.

This data structure is not partitioned across members in the cluster. It lives in one of the members.

public interface ICPMap<TKey, TValue> : ICPDistributedObject, IDistributedObject, IAsyncDisposable

TKey	Type of key in the map.
TValue	Type of value in the map.

Name	Description
CompareAndSetAsync(TKey, TValue, TValue)	Atomically compares serialized forms of existing value with `expectedValue`, and sets the `newValue` if existing and expected values are equal.
DeleteAsync(TKey)	Deletes the entry if `key` exists without returning value of the entry. This method should be preferred over RemoveAsync(TKey) to reduce network footprint if the value map to `key` is not required.
GetAsync(TKey)	Gets value of the entry map to `key` if any, otherwise null.
PutAsync(TKey, TValue)	Sets `key` to `value`. See SetAsync(TKey, TValue) for more optimal usage if existing value is not required.
RemoveAsync(TKey)	Removes the entry if `key` exists. Then, returns the value of the entry.
SetAsync(TKey, TValue)	Sets `key` to `value`. This method should be preferred over PutAsync(TKey, TValue) to reduce network footprint if the existing value map to `key` is not required.