IHMap<TKey, TValue> Interface

Namespace: Hazelcast.DistributedObjects
Assembly: Hazelcast.Net.dll

Represents a distributed map.

public interface IHMap<TKey, TValue> : IHMapBase<TKey, TValue>, IDistributedObject, IAsyncDisposable, IAsyncEnumerable<KeyValuePair<TKey, TValue>>, IKeyLockable<TKey>
Inherited Members
Type Parameters
TKey

The type of the keys.
TValue

The type of the values.
Remarks

Keys are identified by their own hash code and equality.

Methods return clones of the original keys and values. Modifying these clones does not change the actual keys and values in the map. One should put the modified entries back, to make changes visible to all nodes.

Methods

Name Description
AddIndexAsync(IndexOptions)

Adds an index to this dictionary for the specified entries so that queries can run faster.
AddIndexAsync(IndexType, params string[])

Convenient method to add an index to this dictionary with the given type and attributes. Attributes are indexed in ascending order.
AddInterceptorAsync(IMapInterceptor)

Adds an interceptor on the server side.
AggregateAsync<TResult>(IAggregator<TResult>)

Aggregates values.
AggregateAsync<TResult>(IAggregator<TResult>, IPredicate)

Aggregates values.
DeleteAsync(TKey)

Removes an entry.
EvictAllAsync()

Evicts all entries but the locked entries from the cache.
EvictAsync(TKey)

Evicts the specified key from the map.
ExecuteAsync<TResult>(IEntryProcessor<TResult>)

Processes all entries.
ExecuteAsync<TResult>(IEntryProcessor<TResult>, IPredicate)

Process entries.
ExecuteAsync<TResult>(IEntryProcessor<TResult>, IEnumerable<TKey>)

Processes entries.
ExecuteAsync<TResult>(IEntryProcessor<TResult>, TKey)

Processes an entry.
FlushAsync()

Flushes the MapStore on server, if any.
GetAllAsync(ICollection<TKey>)

Gets all entries for keys.
GetEntriesAsync(IPredicate)

Queries the map based on the specified predicate and returns a readonly dictionary of the matching entries.
GetEntryViewAsync(TKey)

Gets an entry with statistics for a key, or null if the map does not contain an entry with this key.
GetKeysAsync(IPredicate)

Queries the map based on the specified predicate and returns matching keys.
GetValuesAsync(IPredicate)

Queries the map based on the specified predicate and returns a readonly collection of the values of matching entries. Gets values for entries matching a predicate.
LoadAllAsync(bool)

Loads all keys into the store.
LoadAllAsync(ICollection<TKey>, bool)

Loads the given keys into the store.
ProjectAsync<TResult>(IProjection)

Projects values.
ProjectAsync<TResult>(IProjection, IPredicate)

Projects values.
PutAsync(TKey, TValue, TimeSpan, TimeSpan)

Sets (adds or updates) an entry, and returns the previous value, if any.
PutIfAbsentAsync(TKey, TValue)

Adds an entry if no entry with the key already exists. Returns the new value, or the existing value if the entry already exists.
PutIfAbsentAsync(TKey, TValue, TimeSpan)

Adds an entry with a time-to-live if no entry with the key already exists. Returns the new value, or the existing value if the entry already exists.
PutIfAbsentAsync(TKey, TValue, TimeSpan, TimeSpan)

Adds an entry with a time-to-live and a max-idle if no entry with the key already exists. Returns the new value, or the existing value if the entry already exists.
PutTransientAsync(TKey, TValue, TimeSpan)

Sets (adds or updates) an entry without calling the MapStore on the server side, if defined.
PutTransientAsync(TKey, TValue, TimeSpan, TimeSpan)

Sets (adds or updates) an entry without calling the MapStore on the server side, if defined.
RemoveAllAsync(IPredicate)

Removes all entries which match with the supplied predicate.
RemoveAsync(TKey, TValue)

Removes an entry.
RemoveInterceptorAsync(string)

Removes the interceptor that identified by id.
ReplaceAsync(TKey, TValue)

Updates an entry if it exists.
ReplaceAsync(TKey, TValue, TValue)

Updates an entry if it exists, and its value is equal to comparisonValue.
SetAsync(TKey, TValue)

Sets (adds or updates) an entry.
SetAsync(TKey, TValue, TimeSpan)

Sets (adds or updates) an entry.
SetAsync(TKey, TValue, TimeSpan, TimeSpan)

Sets (adds or updates) an entry.
SubscribeAsync(Action<MapEventHandlers<TKey, TValue>>, IPredicate, bool, object)

Subscribes to events.
SubscribeAsync(Action<MapEventHandlers<TKey, TValue>>, bool, object)

Subscribes to events.
SubscribeAsync(Action<MapEventHandlers<TKey, TValue>>, TKey, IPredicate, bool, object)

Subscribes to events.
SubscribeAsync(Action<MapEventHandlers<TKey, TValue>>, TKey, bool, object)

Subscribes to events.
TryPutAsync(TKey, TValue, TimeSpan)

Tries to set (add or update) an entry.
TryRemoveAsync(TKey, TimeSpan)

Tries to remove the entry with the given key from this map within the specified time to wait value.
UnsubscribeAsync(Guid)

Unsubscribe from events.
UpdateTimeToLive(TKey, TimeSpan)

Updates the time-to-live of an entry.