eviction_config.h

/*
 * Copyright (c) 2008-2025, Hazelcast, Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#pragma once
 
#include <string>
#include <iosfwd>
 
#include "hazelcast/client/config/eviction_policy.h"
#include "eviction_strategy_type.h"
#include "eviction_strategy_type.h"
 
#if defined(WIN32) || defined(_WIN32) || defined(WIN64) || defined(_WIN64)
#pragma warning(push)
#pragma warning(disable : 4251) // for dll export
#endif
 
namespace hazelcast {
namespace client {
namespace config {
class HAZELCAST_API eviction_config
{
public:
    ~eviction_config() = default;

    enum max_size_policy
    {
        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*/
    };

    static constexpr int32_t DEFAULT_MAX_ENTRY_COUNT = INT32_MAX;

    static constexpr max_size_policy DEFAULT_MAX_SIZE_POLICY =
      max_size_policy::ENTRY_COUNT;

    static constexpr eviction_policy DEFAULT_EVICTION_POLICY =
      eviction_policy::LRU;
 
    eviction_config();
 
    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;
 
    friend std::ostream HAZELCAST_API& operator<<(
      std::ostream& out,
      const eviction_config& config);
 
protected:
    int32_t size_;
    max_size_policy max_size_policy_;
    eviction_policy eviction_policy_;
};
 
} // namespace config
} // namespace client
} // namespace hazelcast
 
#if defined(WIN32) || defined(_WIN32) || defined(WIN64) || defined(_WIN64)
#pragma warning(pop)
#endif