entry_listener.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 <functional>
#include <utility>
 
#include "hazelcast/util/noop.h"
#include "hazelcast/client/entry_event.h"
#include "hazelcast/util/type_traits.h"
 
namespace hazelcast {
namespace client {
class imap;
class map_event;
class replicated_map;
namespace impl {
template<typename>
class EntryEventHandler;
}

class entry_listener final
{
public:
    template<typename Handler,
             typename = util::enable_if_rvalue_ref_trait<Handler&&>>
    entry_listener& on_added(Handler&& h) &
    {
        added_ = std::forward<Handler>(h);
        add_flag(entry_event::type::ADDED);
        return *this;
    }

    template<typename Handler,
             typename = util::enable_if_rvalue_ref_trait<Handler&&>>
    entry_listener&& on_added(Handler&& h) &&
    {
        on_added(std::forward<Handler>(h));
        return std::move(*this);
    }

    template<typename Handler,
             typename = util::enable_if_rvalue_ref_trait<Handler&&>>
    entry_listener& on_removed(Handler&& h) &
    {
        removed_ = std::forward<Handler>(h);
        add_flag(entry_event::type::REMOVED);
        return *this;
    }

    template<typename Handler,
             typename = util::enable_if_rvalue_ref_trait<Handler&&>>
    entry_listener&& on_removed(Handler&& h) &&
    {
        on_removed(std::forward<Handler>(h));
        return std::move(*this);
    }

    template<typename Handler,
             typename = util::enable_if_rvalue_ref_trait<Handler&&>>
    entry_listener& on_updated(Handler&& h) &
    {
        updated_ = std::forward<Handler>(h);
        add_flag(entry_event::type::UPDATED);
        return *this;
    }

    template<typename Handler,
             typename = util::enable_if_rvalue_ref_trait<Handler&&>>
    entry_listener&& on_updated(Handler&& h) &&
    {
        on_updated(std::forward<Handler>(h));
        return std::move(*this);
    }

    template<typename Handler,
             typename = util::enable_if_rvalue_ref_trait<Handler&&>>
    entry_listener& on_evicted(Handler&& h) &
    {
        evicted_ = std::forward<Handler>(h);
        add_flag(entry_event::type::EVICTED);
        return *this;
    }

    template<typename Handler,
             typename = util::enable_if_rvalue_ref_trait<Handler&&>>
    entry_listener&& on_evicted(Handler&& h) &&
    {
        on_evicted(std::forward<Handler>(h));
        return std::move(*this);
    }

    template<typename Handler,
             typename = util::enable_if_rvalue_ref_trait<Handler&&>>
    entry_listener& on_expired(Handler&& h) &
    {
        expired_ = std::forward<Handler>(h);
        add_flag(entry_event::type::EXPIRED);
        return *this;
    }

    template<typename Handler,
             typename = util::enable_if_rvalue_ref_trait<Handler&&>>
    entry_listener&& on_expired(Handler&& h) &&
    {
        on_expired(std::forward<Handler>(h));
        return std::move(*this);
    }

    template<typename Handler,
             typename = util::enable_if_rvalue_ref_trait<Handler&&>>
    entry_listener& on_merged(Handler&& h) &
    {
        merged_ = std::forward<Handler>(h);
        add_flag(entry_event::type::MERGED);
        return *this;
    }

    template<typename Handler,
             typename = util::enable_if_rvalue_ref_trait<Handler&&>>
    entry_listener&& on_merged(Handler&& h) &&
    {
        on_merged(std::forward<Handler>(h));
        return std::move(*this);
    }

    template<typename Handler,
             typename = util::enable_if_rvalue_ref_trait<Handler&&>>
    entry_listener& on_map_evicted(Handler&& h) &
    {
        map_evicted_ = std::forward<Handler>(h);
        add_flag(entry_event::type::EVICT_ALL);
        return *this;
    }

    template<typename Handler,
             typename = util::enable_if_rvalue_ref_trait<Handler&&>>
    entry_listener&& on_map_evicted(Handler&& h) &&
    {
        on_map_evicted(std::forward<Handler>(h));
        return std::move(*this);
    }

    template<typename Handler,
             typename = util::enable_if_rvalue_ref_trait<Handler&&>>
    entry_listener& on_map_cleared(Handler&& h) &
    {
        map_cleared_ = std::forward<Handler>(h);
        add_flag(entry_event::type::CLEAR_ALL);
        return *this;
    }

    template<typename Handler,
             typename = util::enable_if_rvalue_ref_trait<Handler&&>>
    entry_listener&& on_map_cleared(Handler&& h) &&
    {
        on_map_cleared(std::forward<Handler>(h));
        return std::move(*this);
    }
 
private:
    using EntryHandlerType = std::function<void(entry_event&&)>;
    EntryHandlerType added_ = util::noop<entry_event&&>,
                     removed_ = util::noop<entry_event&&>,
                     updated_ = util::noop<entry_event&&>,
                     evicted_ = util::noop<entry_event&&>,
                     expired_ = util::noop<entry_event&&>,
                     merged_ = util::noop<entry_event&&>;
 
    using MapHandlerType = std::function<void(map_event&&)>;
    MapHandlerType map_evicted_ = util::noop<map_event&&>,
                   map_cleared_ = util::noop<map_event&&>;
 
    int32_t flags_ = 0;
 
    void add_flag(entry_event::type t) { flags_ |= static_cast<int32_t>(t); }
 
    template<typename>
    friend class impl::EntryEventHandler;
    friend class replicated_map;
    friend class imap;
};
} // namespace client
} // namespace hazelcast