Public Member Functions

GridClientDataProjectionImpl Class Reference

#include <gridclientdataprojection.hpp>

Inheritance diagram for GridClientDataProjectionImpl:
GridClientProjectionImpl GridClientData

List of all members.

Public Member Functions

 GridClientDataProjectionImpl (TGridClientSharedDataPtr sharedData, GridClientProjectionListener &prjLsnr, const std::string &cacheName, TGridClientNodePredicatePtr filter, TGridThreadPoolPtr &threadPool, const std::set< GridClientCacheFlag > &flags)
virtual ~GridClientDataProjectionImpl ()
virtual std::string cacheName () const
virtual TGridClientDataPtr pinNodes (const TGridClientNodeList &nodes)
virtual bool put (const GridClientVariant &key, const GridClientVariant &val)
virtual TGridBoolFuturePtr putAsync (const GridClientVariant &key, const GridClientVariant &val)
virtual bool putAll (const TGridClientVariantMap &entries)
virtual TGridBoolFuturePtr putAllAsync (const TGridClientVariantMap &entries)
virtual GridClientVariant get (const GridClientVariant &key)
virtual TGridClientFutureVariant getAsync (const GridClientVariant &key)
virtual TGridClientVariantMap getAll (const TGridClientVariantSet &keys)
virtual TGridClientFutureVariantMap getAllAsync (const TGridClientVariantSet &keys)
virtual bool remove (const GridClientVariant &key)
virtual TGridBoolFuturePtr removeAsync (const GridClientVariant &key)
virtual bool removeAll (const TGridClientVariantSet &keys)
virtual TGridBoolFuturePtr removeAllAsync (const TGridClientVariantSet &keys)
virtual bool replace (const GridClientVariant &key, const GridClientVariant &val)
virtual TGridBoolFuturePtr replaceAsync (const GridClientVariant &key, const GridClientVariant &val)
virtual bool cas (const GridClientVariant &key, const GridClientVariant &val1, const GridClientVariant &val2)
virtual TGridBoolFuturePtr casAsync (const GridClientVariant &key, const GridClientVariant &val1, const GridClientVariant &val2)
virtual GridClientUuid affinity (const GridClientVariant &key)
virtual GridClientDataMetrics metrics ()
virtual
TGridClientFutureDataMetrics 
metricsAsync ()
virtual std::set
< GridClientCacheFlag > 
flags ()
virtual TGridClientDataPtr flagsOn (const std::set< GridClientCacheFlag > &flags)
virtual TGridClientDataPtr flagsOff (const std::set< GridClientCacheFlag > &flags)
void invalidate ()

Detailed Description

GridClientData implementation.


Constructor & Destructor Documentation

GridClientDataProjectionImpl::GridClientDataProjectionImpl ( TGridClientSharedDataPtr  sharedData,
GridClientProjectionListener &  prjLsnr,
const std::string &  cacheName,
TGridClientNodePredicatePtr  filter,
TGridThreadPoolPtr &  threadPool,
const std::set< GridClientCacheFlag > &  flags 
)

Public constructor.

Parameters:
sharedData Client shared data.
prjLsnr Projection listener.
cacheName Cache name.
filter Projection filter.
threadPool Client thread pool.
flags Cache flags.
virtual GridClientDataProjectionImpl::~GridClientDataProjectionImpl (  )  [inline, virtual]

Destructor.


Member Function Documentation

GridClientUuid GridClientDataProjectionImpl::affinity ( const GridClientVariant &  key  )  [virtual]

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.

Parameters:
key Key.
Returns:
Node ID.
Exceptions:
GridClientException In case of error.

Implements GridClientData.

string GridClientDataProjectionImpl::cacheName (  )  const [virtual]
Returns:
The name of the cache this projection represents.

Implements GridClientData.

bool GridClientDataProjectionImpl::cas ( const GridClientVariant &  key,
const GridClientVariant &  val1,
const GridClientVariant &  val2 
) [virtual]

Sets entry value to val1 if current value is val2.

If val1 is null and val2 is equal to current value, entry is removed from cache.

If val2 is null, entry is created if it doesn't exist.

If both val1 and val2 are null, entry is removed.

Parameters:
key Key.
val1 Value to set.
val2 Check value.
Returns:
Whether value of entry was changed.
Exceptions:
GridClientException In case of error.
GridClientClosedException If client was closed manually.
GridServerUnreachableException If none of the servers can be reached.

Implements GridClientData.

TGridBoolFuturePtr GridClientDataProjectionImpl::casAsync ( const GridClientVariant &  key,
const GridClientVariant &  val1,
const GridClientVariant &  val2 
) [virtual]

Asynchronously sets entry value to val1 if current value is val2.

If val1 is null and val2 is equal to current value, entry is removed from cache.

If val2 is null, entry is created if it doesn't exist.

If both val1 and val2 are null, entry is removed.

Parameters:
key Key.
val1 Value to set.
val2 Check value.
Returns:
Future.

Implements GridClientData.

std::set< GridClientCacheFlag > GridClientDataProjectionImpl::flags (  )  [virtual]

Gets cache flags enabled on this data projection.

Returns:
Flags for this data projection (empty set if no flags have been set).

Implements GridClientData.

TGridClientDataPtr GridClientDataProjectionImpl::flagsOff ( const std::set< GridClientCacheFlag > &  flags  )  [virtual]

Creates new client data object with disabled cache flags.

Parameters:
flags Cache flags to be disabled.
Returns:
New client data object.
Exceptions:
GridClientException In case of error.

Implements GridClientData.

TGridClientDataPtr GridClientDataProjectionImpl::flagsOn ( const std::set< GridClientCacheFlag > &  flags  )  [virtual]

Creates new client data object with enabled cache flags.

Parameters:
flags Optional cache flags to be enabled.
Returns:
New client data object.
Exceptions:
GridClientException In case of error.

Implements GridClientData.

GridClientVariant GridClientDataProjectionImpl::get ( const GridClientVariant &  key  )  [virtual]

Gets value from default cache.

Parameters:
key Key.
Returns:
Value.
Exceptions:
GridClientException In case of error.
GridClientClosedException If client was closed manually.
GridServerUnreachableException If none of the servers can be reached.

Implements GridClientData.

TGridClientVariantMap GridClientDataProjectionImpl::getAll ( const TGridClientVariantSet &  keys  )  [virtual]

Gets entries from default cache.

Parameters:
keys Keys.
Exceptions:
GridClientException In case of error.
GridClientClosedException If client was closed manually.
GridServerUnreachableException If none of the servers can be reached.
Returns:
Entries.

Implements GridClientData.

TGridClientFutureVariantMap GridClientDataProjectionImpl::getAllAsync ( const TGridClientVariantSet &  keys  )  [virtual]

Asynchronously gets entries from default cache.

Parameters:
keys Keys.
Returns:
Future.

Implements GridClientData.

TGridClientFutureVariant GridClientDataProjectionImpl::getAsync ( const GridClientVariant &  key  )  [virtual]

Asynchronously gets value from default cache.

Parameters:
key key.
fut Future.

Implements GridClientData.

void GridClientDataProjectionImpl::invalidate (  ) 

Invalidates this data instance. This is done by the client to indicate that is has been stopped. After this call, all interface methods will throw GridClientClosedException.

GridClientDataMetrics GridClientDataProjectionImpl::metrics (  )  [virtual]

Gets metrics for default cache.

Returns:
Cache metrics.
Exceptions:
GridClientException In case of error.
GridClientClosedException If client was closed manually.
GridServerUnreachableException If none of the servers can be reached.

Implements GridClientData.

TGridClientFutureDataMetrics GridClientDataProjectionImpl::metricsAsync (  )  [virtual]

Asynchronously gets metrics for default cache.

Returns:
Cache metrics.

Implements GridClientData.

TGridClientDataPtr GridClientDataProjectionImpl::pinNodes ( const TGridClientNodeList &  nodes  )  [virtual]

Gets client data which will only contact specified remote grid node. By default, remote node is determined based on GridClientDataAffinity 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.

Parameters:
nodes Optional additional nodes.
Returns:
Client data which will only contact server with given node ID.
Exceptions:
GridClientException If resulting projection is empty.

Implements GridClientData.

bool GridClientDataProjectionImpl::put ( const GridClientVariant &  key,
const GridClientVariant &  val 
) [virtual]

Puts value to default cache.

Parameters:
key The cache key.
val The key value.
Returns:
Whether value was actually put to cache.
Exceptions:
GridClientException In case of error.
GridClientClosedException If client was closed manually.
GridServerUnreachableException If none of the servers can be reached.

Implements GridClientData.

bool GridClientDataProjectionImpl::putAll ( const TGridClientVariantMap &  entries  )  [virtual]

Puts entries to the cache.

Parameters:
entries Entries.
Exceptions:
GridClientException In case of error.
GridClientClosedException If client was closed manually.
GridServerUnreachableException If none of the servers can be reached.

Implements GridClientData.

TGridBoolFuturePtr GridClientDataProjectionImpl::putAllAsync ( const TGridClientVariantMap &  entries  )  [virtual]

Asynchronously puts entries to default cache.

Parameters:
entries Entries.
Returns:
Future.

Implements GridClientData.

TGridBoolFuturePtr GridClientDataProjectionImpl::putAsync ( const GridClientVariant &  key,
const GridClientVariant &  val 
) [virtual]

Asynchronously puts value to default cache.

Parameters:
key The cache key.
val The key value.
Returns:
Operation future.

Implements GridClientData.

bool GridClientDataProjectionImpl::remove ( const GridClientVariant &  key  )  [virtual]

Removes value from default cache.

Parameters:
key Key.
Returns:
Whether value was actually removed.
Exceptions:
GridClientException In case of error.
GridClientClosedException If client was closed manually.
GridServerUnreachableException If none of the servers can be reached.

Implements GridClientData.

bool GridClientDataProjectionImpl::removeAll ( const TGridClientVariantSet &  keys  )  [virtual]

Removes entries from default cache.

Parameters:
keys Keys.
Exceptions:
GridClientException In case of error.
GridClientClosedException If client was closed manually.
GridServerUnreachableException If none of the servers can be reached.

Implements GridClientData.

TGridBoolFuturePtr GridClientDataProjectionImpl::removeAllAsync ( const TGridClientVariantSet &  keys  )  [virtual]

Asynchronously removes entries from default cache.

Parameters:
keys Keys.
Returns:
Future.

Implements GridClientData.

TGridBoolFuturePtr GridClientDataProjectionImpl::removeAsync ( const GridClientVariant &  key  )  [virtual]

Asynchronously removes value from default cache.

Parameters:
key key.
Returns:
Future.

Implements GridClientData.

bool GridClientDataProjectionImpl::replace ( const GridClientVariant &  key,
const GridClientVariant &  val 
) [virtual]

Replaces value in default cache.

Parameters:
key Key.
val Value.
Returns:
Whether value was actually replaced.
Exceptions:
GridClientException In case of error.
GridClientClosedException If client was closed manually.
GridServerUnreachableException If none of the servers can be reached.

Implements GridClientData.

TGridBoolFuturePtr GridClientDataProjectionImpl::replaceAsync ( const GridClientVariant &  key,
const GridClientVariant &  val 
) [virtual]

Asynchronously replaces value in default cache.

Parameters:
key key.
val Value.
Returns:
Future.

Implements GridClientData.


The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends