Hazelcast C++ Client
Public Types | Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
hazelcast::client::config::EvictionConfig< K, V > Class Template Reference

Configuration for eviction. More...

#include <EvictionConfig.h>

+ Inheritance diagram for hazelcast::client::config::EvictionConfig< K, V >:

Public Types

enum  MaxSizePolicy { ENTRY_COUNT }
 Maximum Size Policy. More...
 

Public Member Functions

 EvictionConfig (int size, MaxSizePolicy maxSizePolicy, const boost::shared_ptr< internal::eviction::EvictionPolicyComparator< K, V > > &comparator)
 
int32_t getSize () const
 
EvictionConfigsetSize (int32_t size)
 
MaxSizePolicy getMaximumSizePolicy () const
 
EvictionConfigsetMaximumSizePolicy (const MaxSizePolicy &maxSizePolicy)
 
EvictionPolicy getEvictionPolicy () const
 
EvictionConfig< K, V > & setEvictionPolicy (EvictionPolicy policy)
 
const boost::shared_ptr< internal::eviction::EvictionPolicyComparator< K, V > > getComparator () const
 Gets the class name of the configured EvictionPolicyComparator implementation. More...
 
EvictionConfigsetComparator (const boost::shared_ptr< internal::eviction::EvictionPolicyComparator< K, V > > &comparator)
 
internal::eviction::EvictionStrategyType::Type getEvictionStrategyType () const
 Gets the type of eviction strategy. More...
 
internal::eviction::EvictionPolicyType getEvictionPolicyType () const
 Gets the type of eviction policy. More...
 

Static Public Attributes

static const int32_t DEFAULT_MAX_ENTRY_COUNT = INT32_MAX
 Default maximum entry count.
 
static const MaxSizePolicy DEFAULT_MAX_SIZE_POLICY = ENTRY_COUNT
 Default Max-Size Policy.
 
static const EvictionPolicy DEFAULT_EVICTION_POLICY = LRU
 Default Eviction Policy.
 

Protected Attributes

int32_t size
 
MaxSizePolicy maxSizePolicy
 
EvictionPolicy evictionPolicy
 
boost::shared_ptr< internal::eviction::EvictionPolicyComparator< K, V > > comparator
 

Detailed Description

template<typename K, typename V>
class hazelcast::client::config::EvictionConfig< K, V >

Configuration for eviction.

You can set a limit for number of entries or total memory cost of entries.

Member Enumeration Documentation

◆ MaxSizePolicy

template<typename K , typename V >
enum hazelcast::client::config::EvictionConfig::MaxSizePolicy

Maximum Size Policy.

Enumerator
ENTRY_COUNT 

Policy based on maximum number of entries stored per data structure (map, cache etc)

Member Function Documentation

◆ getComparator()

template<typename K , typename V >
const boost::shared_ptr<internal::eviction::EvictionPolicyComparator<K, V> > hazelcast::client::config::EvictionConfig< K, V >::getComparator ( ) const
inlinevirtual

Gets the class name of the configured EvictionPolicyComparator implementation.

Returns
class name of the configured EvictionPolicyComparator implementation Gets instance of the configured EvictionPolicyComparator implementation.
instance of the configured EvictionPolicyComparator implementation.

Reimplemented from hazelcast::client::internal::eviction::EvictionConfiguration< K, V >.

◆ getEvictionPolicyType()

template<typename K , typename V >
internal::eviction::EvictionPolicyType hazelcast::client::config::EvictionConfig< K, V >::getEvictionPolicyType ( ) const
inlinevirtual

Gets the type of eviction policy.

Returns
the type of eviction policy

Implements hazelcast::client::internal::eviction::EvictionConfiguration< K, V >.

◆ getEvictionStrategyType()

template<typename K , typename V >
internal::eviction::EvictionStrategyType::Type hazelcast::client::config::EvictionConfig< K, V >::getEvictionStrategyType ( ) const
inlinevirtual

Gets the type of eviction strategy.

Returns
the type of eviction strategy

Implements hazelcast::client::internal::eviction::EvictionConfiguration< K, V >.


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