hazelcast::client::config::eviction_config Class Reference

Configuration for eviction. More...

#include <eviction_config.h>

Public Types
enum	max_size_policy { ENTRY_COUNT }
	Maximum Size Policy. More...

Public Member Functions
int32_t	get_size () const
eviction_config &	set_size (int32_t size)
max_size_policy	get_maximum_size_policy () const
eviction_config &	set_maximum_size_policy (const max_size_policy &max_size_policy)
eviction_policy	get_eviction_policy () const
eviction_config &	set_eviction_policy (eviction_policy policy)
eviction_strategy_type	get_eviction_strategy_type () const

Static Public Attributes
static constexpr int32_t	DEFAULT_MAX_ENTRY_COUNT = INT32_MAX
	Default maximum entry count.
static constexpr max_size_policy	DEFAULT_MAX_SIZE_POLICY
	Default Max-Size Policy.
static constexpr eviction_policy	DEFAULT_EVICTION_POLICY
	Default Eviction Policy.

Protected Attributes
int32_t	size_
max_size_policy	max_size_policy_
eviction_policy	eviction_policy_

Friends
std::ostream HAZELCAST_API &	operator<< (std::ostream &out, const eviction_config &config)

Detailed Description

Configuration for eviction.

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

Definition at line 37 of file eviction_config.h.

Member Enumeration Documentation

max_size_policy

enum hazelcast::client::config::eviction_config::max_size_policy

Maximum Size Policy.

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

Definition at line 45 of file eviction_config.h.

    {
        ENTRY_COUNT
        /* TODO,
        *
         * Policy based on maximum used native memory in megabytes per data
        structure (map, cache etc)
         * on each Hazelcast instance
 
                USED_NATIVE_MEMORY_SIZE,
        *
         * Policy based on maximum used native memory percentage per data
        structure (map, cache etc)
         * on each Hazelcast instance
 
                USED_NATIVE_MEMORY_PERCENTAGE,
        *
         * Policy based on minimum free native memory in megabytes per Hazelcast
        instance
 
                FREE_NATIVE_MEMORY_SIZE,
        *
         * Policy based on minimum free native memory percentage per Hazelcast
        instance
 
                FREE_NATIVE_MEMORY_PERCENTAGE*/
    };

Constructor & Destructor Documentation

eviction_config()

hazelcast::client::config::eviction_config::eviction_config

(

)

Definition at line 822 of file config.cpp.

  : size_(DEFAULT_MAX_ENTRY_COUNT)
  , max_size_policy_(DEFAULT_MAX_SIZE_POLICY)
  , eviction_policy_(DEFAULT_EVICTION_POLICY)
{}

Member Function Documentation

get_eviction_policy()

eviction_policy hazelcast::client::config::eviction_config::get_eviction_policy

(

)

const

Definition at line 857 of file config.cpp.

{
    return eviction_policy_;
}

get_eviction_strategy_type()

eviction_strategy_type hazelcast::client::config::eviction_config::get_eviction_strategy_type

(

)

const

Definition at line 870 of file config.cpp.

{
    // TODO: add support for other/custom eviction strategies
    return eviction_strategy_type::DEFAULT_EVICTION_STRATEGY;
}

get_maximum_size_policy()

eviction_config::max_size_policy hazelcast::client::config::eviction_config::get_maximum_size_policy

(

)

const

Definition at line 843 of file config.cpp.

{
    return max_size_policy_;
}

get_size()

int32_t hazelcast::client::config::eviction_config::get_size

(

)

const

Definition at line 829 of file config.cpp.

{
    return size_;
}

set_eviction_policy()

eviction_config & hazelcast::client::config::eviction_config::set_eviction_policy

(

eviction_policy

policy

)

Definition at line 863 of file config.cpp.

{
    this->eviction_policy_ = policy;
    return *this;
}

set_maximum_size_policy()

eviction_config & hazelcast::client::config::eviction_config::set_maximum_size_policy

(

const max_size_policy &

max_size_policy

)

Definition at line 849 of file config.cpp.

{
    this->max_size_policy_ = max_size_policy;
    return *this;
}

set_size()

eviction_config & hazelcast::client::config::eviction_config::set_size

(

int32_t

size

)

Definition at line 835 of file config.cpp.

{
    this->size_ = util::Preconditions::check_positive(
      size, "Size must be positive number!");
    return *this;
}

Friends And Related Symbol Documentation

operator<<

std::ostream HAZELCAST_API & operator<< ( std::ostream & out, const eviction_config & config )

friend

Definition at line 876 of file config.cpp.

{
    out << "EvictionConfig{"
        << "size=" << config.get_size()
        << ", maxSizePolicy=" << config.get_maximum_size_policy()
        << ", evictionPolicy=" << config.get_eviction_policy() << '}';
 
    return out;
}

Member Data Documentation

DEFAULT_EVICTION_POLICY

eviction_policy hazelcast::client::config::eviction_config::DEFAULT_EVICTION_POLICY

staticconstexpr

Initial value:

=
      eviction_policy::LRU

Default Eviction Policy.

Definition at line 91 of file eviction_config.h.

DEFAULT_MAX_ENTRY_COUNT

int32_t hazelcast::client::config::eviction_config::DEFAULT_MAX_ENTRY_COUNT = INT32_MAX

staticconstexpr

Default maximum entry count.

Definition at line 80 of file eviction_config.h.

DEFAULT_MAX_SIZE_POLICY

max_size_policy hazelcast::client::config::eviction_config::DEFAULT_MAX_SIZE_POLICY

staticconstexpr

Initial value:

=
      max_size_policy::ENTRY_COUNT

Default Max-Size Policy.

Definition at line 85 of file eviction_config.h.

eviction_policy_

eviction_policy hazelcast::client::config::eviction_config::eviction_policy_

protected

Definition at line 118 of file eviction_config.h.

max_size_policy_

max_size_policy hazelcast::client::config::eviction_config::max_size_policy_

protected

Definition at line 117 of file eviction_config.h.

size_

int32_t hazelcast::client::config::eviction_config::size_

protected

Definition at line 116 of file eviction_config.h.

---

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

• hazelcast/include/hazelcast/client/config/eviction_config.h
• hazelcast/src/hazelcast/client/config.cpp