near_cache_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 "hazelcast/client/config/in_memory_format.h"
#include "hazelcast/client/config/eviction_config.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 near_cache_config
{
public:
    static constexpr int32_t DEFAULT_TTL_SECONDS = 0;

    static constexpr int32_t DEFAULT_MAX_IDLE_SECONDS = 0;

    static constexpr in_memory_format DEFAULT_MEMORY_FORMAT =
      in_memory_format::BINARY;

    enum local_update_policy
    {
        INVALIDATE,

        CACHE
    };
 
    near_cache_config();
 
    near_cache_config(const std::string& cache_name);
 
    near_cache_config(const std::string& cache_name,
                      in_memory_format memory_format);
 
    near_cache_config(int32_t time_to_live_seconds,
                      int32_t max_idle_seconds,
                      bool invalidate_on_change,
                      in_memory_format in_memory_format,
                      const eviction_config& evict_config);
 
    virtual ~near_cache_config() = default;

    const std::string& get_name() const;

    near_cache_config& set_name(const std::string& name);

    int32_t get_time_to_live_seconds() const;

    near_cache_config& set_time_to_live_seconds(int32_t time_to_live_seconds);

    int32_t get_max_idle_seconds() const;

    near_cache_config& set_max_idle_seconds(int32_t max_idle_seconds);

    bool is_invalidate_on_change() const;

    near_cache_config& set_invalidate_on_change(bool invalidate_on_change);

    const in_memory_format& get_in_memory_format() const;

    virtual near_cache_config& set_in_memory_format(
      const in_memory_format& in_memory_format);

    bool is_cache_local_entries() const;

    near_cache_config& set_cache_local_entries(bool cache_local_entries);
 
    const local_update_policy& get_local_update_policy() const;
 
    near_cache_config& set_local_update_policy(
      const local_update_policy& local_update_policy);

    eviction_config& get_eviction_config();

    near_cache_config& set_eviction_config(
      const eviction_config& eviction_config);
 
    friend std::ostream HAZELCAST_API& operator<<(
      std::ostream& out,
      const near_cache_config& cache_config);
 
private:
    std::string name_;
 
    int32_t time_to_live_seconds_;
    int32_t max_idle_seconds_;
 
    in_memory_format in_memory_format_;
 
    local_update_policy local_update_policy_;
 
    bool invalidate_on_change_;
    bool cache_local_entries_;

    eviction_config eviction_config_;
};
 
} // namespace config
} // namespace client
} // namespace hazelcast
 
#if defined(WIN32) || defined(_WIN32) || defined(WIN64) || defined(_WIN64)
#pragma warning(pop)
#endif