A data projection of grid client. Contains various methods for cache operations and metrics retrieval.
Inherited by GridGain.Client.Impl.GridClientDataImpl.
Public Member Functions | |
| IGridClientData | CacheFlagsOn (ICollection< GridClientCacheFlag > cacheFlags) |
| Creates new client data object with enabled cache flags. | |
| IGridClientData | CacheFlagsOff (ICollection< GridClientCacheFlag > cacheFlags) |
| Creates new client data object with disabled cache flags. | |
| IGridClientData | PinNodes (IGridClientNode node, params IGridClientNode[] nodes) |
Gets client data which will only contact specified remote grid node. By default, remote node is determined based on IGridClientDataAffinity provided - this method allows to override default behavior and use only specified server for all cache operations. Use this method when there are other than key-affinity reasons why a certain node should be contacted. | |
| ICollection< IGridClientNode > | PinnedNodes () |
Gets pinned node or null if no node was pinned. | |
| bool | Put< TKey, TVal > (TKey key, TVal val) |
| Puts value to default cache. | |
| IGridClientFuture< Boolean > | PutAsync< TKey, TVal > (TKey key, TVal val) |
| Asynchronously puts value to default cache. | |
| Boolean | PutAll< TKey, TVal > (IDictionary< TKey, TVal > entries) |
| Puts entries to default cache. | |
| IGridClientFuture< Boolean > | PutAllAsync< TKey, TVal > (IDictionary< TKey, TVal > entries) |
| Asynchronously puts entries to default cache. | |
| TVal | GetItem< TKey, TVal > (TKey key) |
| Gets value from default cache. | |
| IGridClientFuture< TVal > | GetAsync< TKey, TVal > (TKey key) |
| Asynchronously gets value from default cache. | |
| IDictionary< TKey, TVal > | GetAll< TKey, TVal > (ICollection< TKey > keys) |
| Gets entries from default cache. | |
| IGridClientFuture< IDictionary < TKey, TVal > > | GetAllAsync< TKey, TVal > (ICollection< TKey > keys) |
| Asynchronously gets entries from default cache. | |
| bool | Remove< TKey > (TKey key) |
| Removes value from default cache. | |
| IGridClientFuture< Boolean > | RemoveAsync< TKey > (TKey key) |
| Asynchronously removes value from default cache. | |
| void | RemoveAll< TKey > (ICollection< TKey > keys) |
| Removes entries from default cache. | |
| IGridClientFuture | RemoveAllAsync< TKey > (ICollection< TKey > keys) |
| Asynchronously removes entries from default cache. | |
| bool | Replace< TKey, TVal > (TKey key, TVal val) |
| Replaces value in default cache. | |
| IGridClientFuture< Boolean > | ReplaceAsync< TKey, TVal > (TKey key, TVal val) |
| Asynchronously replaces value in default cache. | |
| Boolean | Append< TKey, TVal > (TKey key, TVal val) |
Append requested value to already cached one. This method supports work with strings, lists and maps. Note that this operation is affinity-aware and will immediately contact exactly the remote node on which this key is supposed to be cached (unless some nodes were pinned). | |
| IGridClientFuture< Boolean > | AppendAsync< TKey, TVal > (TKey key, TVal val) |
Append requested value to already cached one. This method supports work with strings, lists and maps. Note that this operation is affinity-aware and will immediately contact exactly the remote node on which this key is supposed to be cached (unless some nodes were pinned). | |
| Boolean | Prepend< TKey, TVal > (TKey key, TVal val) |
Prepend requested value to already cached one. This method supports work with strings, lists and maps. Note that this operation is affinity-aware and will immediately contact exactly the remote node on which this key is supposed to be cached (unless some nodes were pinned). | |
| IGridClientFuture< Boolean > | PrependAsync< TKey, TVal > (TKey key, TVal val) |
Prepend requested value to already cached one. This method supports work with strings, lists and maps. Note that this operation is affinity-aware and will immediately contact exactly the remote node on which this key is supposed to be cached (unless some nodes were pinned). | |
| bool | Cas (String key, String val1, String val2) |
Sets entry value to val1 if current value is val1. If val1 is val2 and val2 is equal to current value, entry is removed from cache. If val2 is val1, entry is created if it doesn't exist. If both val1 and val1 are val1, entry is removed. | |
| IGridClientFuture< Boolean > | CasAsync (String key, String val1, String val2) |
Asynchronously sets entry value to val1 if current value is val1. If val1 is val2 and val2 is equal to current value, entry is removed from cache. If val2 is val1, entry is created if it doesn't exist. If both val1 and null are null, entry is removed. | |
| Guid | Affinity< TKey > (TKey key) |
Gets affinity node ID for provided key. This method will return null if no affinity was configured for the given cache or there are no nodes in topology with cache enabled. | |
| IGridClientDataMetrics | Metrics () |
| Gets metrics for default cache. | |
| IGridClientFuture < IGridClientDataMetrics > | MetricsAsync () |
| Asynchronously gets metrics for default cache. | |
Properties | |
| String | CacheName [get] |
| Gets name of the remote cache. | |
| ISet< GridClientCacheFlag > | CacheFlags [get] |
| Gets cache flags of the remote cache. | |
| Guid GridGain.Client.IGridClientData.Affinity< TKey > | ( | TKey | key | ) |
| key | Key. |
| GridClientException | In case of error. |
Implemented in GridGain.Client.Impl.GridClientDataImpl.
| Boolean GridGain.Client.IGridClientData.Append< TKey, TVal > | ( | TKey | key, | |
| TVal | val | |||
| ) |
| key | Key to manipulate cache value for. | |
| val | Value to append to the cached one. |
| GridClientException | In case of error. |
Implemented in GridGain.Client.Impl.GridClientDataImpl.
| IGridClientFuture<Boolean> GridGain.Client.IGridClientData.AppendAsync< TKey, TVal > | ( | TKey | key, | |
| TVal | val | |||
| ) |
| key | Key to manipulate cache value for. | |
| val | Value to append to the cached one. |
Implemented in GridGain.Client.Impl.GridClientDataImpl.
| IGridClientData GridGain.Client.IGridClientData.CacheFlagsOff | ( | ICollection< GridClientCacheFlag > | cacheFlags | ) |
| cacheFlags | Cache flags to be disabled. |
| GridClientException | In case of error. |
Implemented in GridGain.Client.Impl.GridClientDataImpl.
| IGridClientData GridGain.Client.IGridClientData.CacheFlagsOn | ( | ICollection< GridClientCacheFlag > | cacheFlags | ) |
| cacheFlags | Cache flags to be disabled. |
| GridClientException | In case of error. |
Implemented in GridGain.Client.Impl.GridClientDataImpl.
| bool GridGain.Client.IGridClientData.Cas | ( | String | key, | |
| String | val1, | |||
| String | val2 | |||
| ) |
| key | Key. | |
| val1 | Value to set. | |
| val2 | Check value. |
| GridClientException | In case of error. |
Implemented in GridGain.Client.Impl.GridClientDataImpl.
| IGridClientFuture<Boolean> GridGain.Client.IGridClientData.CasAsync | ( | String | key, | |
| String | val1, | |||
| String | val2 | |||
| ) |
| key | Key. | |
| val1 | Value to set. | |
| val2 | Check value. |
Implemented in GridGain.Client.Impl.GridClientDataImpl.
| IDictionary<TKey, TVal> GridGain.Client.IGridClientData.GetAll< TKey, TVal > | ( | ICollection< TKey > | keys | ) |
| keys | Keys. |
| GridClientException | In case of error. |
Implemented in GridGain.Client.Impl.GridClientDataImpl.
| IGridClientFuture<IDictionary<TKey, TVal> > GridGain.Client.IGridClientData.GetAllAsync< TKey, TVal > | ( | ICollection< TKey > | keys | ) |
| keys | Keys. |
Implemented in GridGain.Client.Impl.GridClientDataImpl.
| IGridClientFuture<TVal> GridGain.Client.IGridClientData.GetAsync< TKey, TVal > | ( | TKey | key | ) |
| key | key. |
null if no value was cached.Implemented in GridGain.Client.Impl.GridClientDataImpl.
| TVal GridGain.Client.IGridClientData.GetItem< TKey, TVal > | ( | TKey | key | ) |
| key | Key. |
| GridClientException | In case of error. |
Implemented in GridGain.Client.Impl.GridClientDataImpl.
| IGridClientDataMetrics GridGain.Client.IGridClientData.Metrics | ( | ) |
| GridClientException | In case of error. |
Implemented in GridGain.Client.Impl.GridClientDataImpl.
| IGridClientFuture<IGridClientDataMetrics> GridGain.Client.IGridClientData.MetricsAsync | ( | ) |
Implemented in GridGain.Client.Impl.GridClientDataImpl.
| ICollection<IGridClientNode> GridGain.Client.IGridClientData.PinnedNodes | ( | ) |
Implemented in GridGain.Client.Impl.GridClientDataImpl.
| IGridClientData GridGain.Client.IGridClientData.PinNodes | ( | IGridClientNode | node, | |
| params IGridClientNode[] | nodes | |||
| ) |
| node | Node to be contacted. | |
| nodes | Optional additional nodes. |
| GridClientException | If resulting projection is empty. |
| Boolean GridGain.Client.IGridClientData.Prepend< TKey, TVal > | ( | TKey | key, | |
| TVal | val | |||
| ) |
| key | Key to manipulate cache value for. | |
| val | Value to prepend to the cached one. |
GridClientException In case of error.
Implemented in GridGain.Client.Impl.GridClientDataImpl.
| IGridClientFuture<Boolean> GridGain.Client.IGridClientData.PrependAsync< TKey, TVal > | ( | TKey | key, | |
| TVal | val | |||
| ) |
| key | Key to manipulate cache value for. | |
| val | Value to prepend to the cached one. |
Implemented in GridGain.Client.Impl.GridClientDataImpl.
| bool GridGain.Client.IGridClientData.Put< TKey, TVal > | ( | TKey | key, | |
| TVal | val | |||
| ) |
| key | Key. | |
| val | Value. |
| GridClientException | In case of error. |
Implemented in GridGain.Client.Impl.GridClientDataImpl.
| Boolean GridGain.Client.IGridClientData.PutAll< TKey, TVal > | ( | IDictionary< TKey, TVal > | entries | ) |
| entries | Entries. |
True if map contained more then one entry or if put succeeded in case of one entry,false otherwise
| GridClientException | In case of error. |
Implemented in GridGain.Client.Impl.GridClientDataImpl.
| IGridClientFuture<Boolean> GridGain.Client.IGridClientData.PutAllAsync< TKey, TVal > | ( | IDictionary< TKey, TVal > | entries | ) |
| entries | Entries. |
Implemented in GridGain.Client.Impl.GridClientDataImpl.
| IGridClientFuture<Boolean> GridGain.Client.IGridClientData.PutAsync< TKey, TVal > | ( | TKey | key, | |
| TVal | val | |||
| ) |
| key | key. | |
| val | Value. |
Implemented in GridGain.Client.Impl.GridClientDataImpl.
| bool GridGain.Client.IGridClientData.Remove< TKey > | ( | TKey | key | ) |
| key | Key. |
| GridClientException | In case of error. |
Implemented in GridGain.Client.Impl.GridClientDataImpl.
| void GridGain.Client.IGridClientData.RemoveAll< TKey > | ( | ICollection< TKey > | keys | ) |
| keys | Keys. |
| GridClientException | In case of error. |
Implemented in GridGain.Client.Impl.GridClientDataImpl.
| IGridClientFuture GridGain.Client.IGridClientData.RemoveAllAsync< TKey > | ( | ICollection< TKey > | keys | ) |
| keys | Keys. |
Implemented in GridGain.Client.Impl.GridClientDataImpl.
| IGridClientFuture<Boolean> GridGain.Client.IGridClientData.RemoveAsync< TKey > | ( | TKey | key | ) |
| key | key. |
Implemented in GridGain.Client.Impl.GridClientDataImpl.
| bool GridGain.Client.IGridClientData.Replace< TKey, TVal > | ( | TKey | key, | |
| TVal | val | |||
| ) |
| key | Key. | |
| val | Value. |
| GridClientException | In case of error. |
Implemented in GridGain.Client.Impl.GridClientDataImpl.
| IGridClientFuture<Boolean> GridGain.Client.IGridClientData.ReplaceAsync< TKey, TVal > | ( | TKey | key, | |
| TVal | val | |||
| ) |
| key | key. | |
| val | Value. |
Implemented in GridGain.Client.Impl.GridClientDataImpl.
ISet<GridClientCacheFlag> GridGain.Client.IGridClientData.CacheFlags [get] |
Implemented in GridGain.Client.Impl.GridClientDataImpl.
String GridGain.Client.IGridClientData.CacheName [get] |
Implemented in GridGain.Client.Impl.GridClientDataImpl.
1.7.1