Hazelcast C++ Client
Public Member Functions | Static Public Attributes | List of all members
hazelcast::client::internal::nearcache::NearCache< K, V > Class Template Referenceabstract

NearCache is the contract point to store keys and values in underlying com.hazelcast.cache.impl.nearcache.NearCacheRecordStore. More...

#include <NearCache.h>

+ Inheritance diagram for hazelcast::client::internal::nearcache::NearCache< K, V >:

Public Member Functions

void initialize ()
 
virtual const std::string & getName () const
 Gets the name of the this com.hazelcast.cache.impl.nearcache.NearCache instance. More...
 
virtual boost::shared_ptr< V > get (const boost::shared_ptr< K > &key)
 Gets the value associated with the given key. More...
 
virtual void put (const boost::shared_ptr< K > &key, const boost::shared_ptr< V > &value)
 Puts (associates) a value with the given key. More...
 
virtual void put (const boost::shared_ptr< K > &key, const boost::shared_ptr< serialization::pimpl::Data > &value)
 Puts (associates) a value with the given key. More...
 
virtual bool remove (const boost::shared_ptr< K > &key)
 Removes the value associated with the given key. More...
 
virtual bool isInvalidatedOnChange () const
 
virtual const config::InMemoryFormat getInMemoryFormat () const
 Gets the com.hazelcast.config.InMemoryFormat of the storage for internal records. More...
 
virtual monitor::NearCacheStatsgetNearCacheStats ()=0
 Get the com.hazelcast.monitor.NearCacheStats instance to monitor this store. More...
 
virtual int size () const
 Gets the count of stored records. More...
 

Static Public Attributes

static boost::shared_ptr< V > NULL_OBJECT = boost::shared_ptr<V>(new V())
 NULL Object.
 
static const int DEFAULT_EXPIRATION_TASK_INITIAL_DELAY_IN_SECONDS = 5
 Default expiration task initial delay time as seconds.
 
static const int DEFAULT_EXPIRATION_TASK_DELAY_IN_SECONDS = 5
 Default expiration task delay time as seconds.
 

Detailed Description

template<typename K, typename V>
class hazelcast::client::internal::nearcache::NearCache< K, V >

NearCache is the contract point to store keys and values in underlying com.hazelcast.cache.impl.nearcache.NearCacheRecordStore.

Parameters
<K>the type of the key
<V>the type of the value

This is a no-op interface class. See InvalidationAwareNearCache for the actual implementation

Member Function Documentation

template<typename K , typename V >
virtual boost::shared_ptr<V> hazelcast::client::internal::nearcache::NearCache< K, V >::get ( const boost::shared_ptr< K > &  key)
inlinevirtual

Gets the value associated with the given key.

Parameters
keythe key of the requested value
Returns
the value associated with the given key
template<typename K , typename V >
virtual const config::InMemoryFormat hazelcast::client::internal::nearcache::NearCache< K, V >::getInMemoryFormat ( ) const
inlinevirtual

Gets the com.hazelcast.config.InMemoryFormat of the storage for internal records.

Returns
the com.hazelcast.config.InMemoryFormat of the storage for internal records
template<typename K , typename V >
virtual const std::string& hazelcast::client::internal::nearcache::NearCache< K, V >::getName ( ) const
inlinevirtual

Gets the name of the this com.hazelcast.cache.impl.nearcache.NearCache instance.

Returns
the name of the this com.hazelcast.cache.impl.nearcache.NearCache instance
template<typename K , typename V >
virtual monitor::NearCacheStats& hazelcast::client::internal::nearcache::NearCache< K, V >::getNearCacheStats ( )
pure virtual

Get the com.hazelcast.monitor.NearCacheStats instance to monitor this store.

Returns
the com.hazelcast.monitor.NearCacheStats instance to monitor this store
template<typename K , typename V >
virtual bool hazelcast::client::internal::nearcache::NearCache< K, V >::isInvalidatedOnChange ( ) const
inlinevirtual
Returns
template<typename K , typename V >
virtual void hazelcast::client::internal::nearcache::NearCache< K, V >::put ( const boost::shared_ptr< K > &  key,
const boost::shared_ptr< V > &  value 
)
inlinevirtual

Puts (associates) a value with the given key.

Parameters
keythe key of the value will be stored
valuethe value will be stored
template<typename K , typename V >
virtual void hazelcast::client::internal::nearcache::NearCache< K, V >::put ( const boost::shared_ptr< K > &  key,
const boost::shared_ptr< serialization::pimpl::Data > &  value 
)
inlinevirtual

Puts (associates) a value with the given key.

Parameters
keythe key of the value will be stored
valuethe value as Data which will be stored
template<typename K , typename V >
virtual bool hazelcast::client::internal::nearcache::NearCache< K, V >::remove ( const boost::shared_ptr< K > &  key)
inlinevirtual

Removes the value associated with the given key.

Parameters
keythe key of the value will be removed
template<typename K , typename V >
virtual int hazelcast::client::internal::nearcache::NearCache< K, V >::size ( ) const
inlinevirtual

Gets the count of stored records.

Returns
the count of stored records

The documentation for this class was generated from the following file: