Hazelcast C++ Client
Public Member Functions | List of all members
hazelcast::client::internal::eviction::EvictionPolicyEvaluator< MAPKEY, MAPVALUE, A, E > Class Template Reference

Interface for evaluation implementations of com.hazelcast.config.EvictionPolicy. More...

#include <EvictionPolicyEvaluator.h>

Public Member Functions

virtual const boost::shared_ptr< EvictionPolicyComparator< MAPKEY, MAPVALUE > > getEvictionPolicyComparator () const
 Gets the underlying EvictionPolicyComparator. More...
 
virtual std::auto_ptr< std::vector< boost::shared_ptr< eviction::EvictionCandidate< MAPKEY, MAPVALUE, A, E > > > > evaluate (util::Iterable< EvictionCandidate< MAPKEY, MAPVALUE, A, E > > &evictionCandidates) const
 The evaluate method implements the actual policy rules and is called on every eviction to select one or more candidates to be evicted from the given input set of candidates. More...
 

Detailed Description

template<typename MAPKEY, typename MAPVALUE, typename A, typename E>
class hazelcast::client::internal::eviction::EvictionPolicyEvaluator< MAPKEY, MAPVALUE, A, E >

Interface for evaluation implementations of com.hazelcast.config.EvictionPolicy.

Parameters
<A>Type of the accessor (id) of the com.hazelcast.internal.eviction.EvictionCandidate
<E>Type of the com.hazelcast.internal.eviction.Evictable value of com.hazelcast.internal.eviction.EvictionCandidate

Member Function Documentation

template<typename MAPKEY, typename MAPVALUE, typename A, typename E>
virtual std::auto_ptr<std::vector<boost::shared_ptr<eviction::EvictionCandidate<MAPKEY, MAPVALUE, A, E> > > > hazelcast::client::internal::eviction::EvictionPolicyEvaluator< MAPKEY, MAPVALUE, A, E >::evaluate ( util::Iterable< EvictionCandidate< MAPKEY, MAPVALUE, A, E > > &  evictionCandidates) const
inlinevirtual

The evaluate method implements the actual policy rules and is called on every eviction to select one or more candidates to be evicted from the given input set of candidates.

The selection algorithm should execute in a constant time to deliver a predictable timing results of the eviction system.

Parameters
evictionCandidatesMultiple EvictionCandidate to be evicted
Returns
multiple EvictionCandidates that are available to be evicted
template<typename MAPKEY, typename MAPVALUE, typename A, typename E>
virtual const boost::shared_ptr<EvictionPolicyComparator<MAPKEY, MAPVALUE> > hazelcast::client::internal::eviction::EvictionPolicyEvaluator< MAPKEY, MAPVALUE, A, E >::getEvictionPolicyComparator ( ) const
inlinevirtual

Gets the underlying EvictionPolicyComparator.

Returns
the underlying EvictionPolicyComparator

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