iqueue.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/item_listener.h"
#include "hazelcast/client/proxy/IQueueImpl.h"
#include "hazelcast/client/impl/ItemEventHandler.h"
#include "hazelcast/client/protocol/codec/codecs.h"
#include "hazelcast/client/spi/ClientContext.h"
 
namespace hazelcast {
namespace client {
class iqueue : public proxy::IQueueImpl
{
    friend class spi::ProxyManager;
 
public:
    static constexpr const char* SERVICE_NAME = "hz:impl:queueService";

    boost::future<boost::uuids::uuid> add_item_listener(
      item_listener&& listener,
      bool include_value)
    {
        std::unique_ptr<
          impl::item_event_handler<protocol::codec::queue_addlistener_handler>>
          itemEventHandler(new impl::item_event_handler<
                           protocol::codec::queue_addlistener_handler>(
            get_name(),
            get_context().get_logger(),
            get_context().get_client_cluster_service(),
            get_context().get_serialization_service(),
            std::move(listener),
            include_value));
 
        return proxy::IQueueImpl::add_item_listener(std::move(itemEventHandler),
                                                    include_value);
    }

    template<typename E>
    boost::future<bool> offer(const E& element)
    {
        return offer(element, std::chrono::milliseconds(0));
    }

    template<typename E>
    boost::future<void> put(const E& element)
    {
        return proxy::IQueueImpl::put(to_data(element));
    }

    template<typename E>
    boost::future<bool> offer(const E& element,
                              std::chrono::milliseconds timeout)
    {
        return proxy::IQueueImpl::offer(to_data(element), timeout);
    }

    template<typename E>
    boost::future<boost::optional<E>> take()
    {
        return to_object<E>(proxy::IQueueImpl::take_data());
    }

    template<typename E>
    boost::future<boost::optional<E>> poll(std::chrono::milliseconds timeout)
    {
        return to_object<E>(proxy::IQueueImpl::poll_data(timeout));
    }

    template<typename E>
    boost::future<bool> remove(const E& element)
    {
        return proxy::IQueueImpl::remove(to_data(element));
    }

    template<typename E>
    boost::future<bool> contains(const E& element)
    {
        return proxy::IQueueImpl::contains(to_data(element));
    }

    template<typename E>
    boost::future<size_t> drain_to(std::vector<E>& elements)
    {
        return to_object_drain(proxy::IQueueImpl::drain_to_data(), elements);
    }

    template<typename E>
    boost::future<size_t> drain_to(std::vector<E>& elements,
                                   size_t max_elements)
    {
        return to_object_drain(proxy::IQueueImpl::drain_to_data(max_elements),
                               elements);
    }

    template<typename E>
    boost::future<boost::optional<E>> poll()
    {
        return poll<E>(std::chrono::milliseconds(0));
    }

    template<typename E>
    boost::future<boost::optional<E>> peek()
    {
        return to_object<E>(proxy::IQueueImpl::peek_data());
    }

    template<typename E>
    boost::future<std::vector<E>> to_array()
    {
        return to_object_vector<E>(proxy::IQueueImpl::to_array_data());
    }

    template<typename E>
    boost::future<bool> contains_all(const std::vector<E>& elements)
    {
        return proxy::IQueueImpl::contains_all_data(
          to_data_collection(elements));
    }

    template<typename E>
    boost::future<bool> add_all(const std::vector<E>& elements)
    {
        return proxy::IQueueImpl::add_all_data(to_data_collection(elements));
    }

    template<typename E>
    boost::future<bool> remove_all(const std::vector<E>& elements)
    {
        return proxy::IQueueImpl::remove_all_data(to_data_collection(elements));
    }

    template<typename E>
    boost::future<bool> retain_all(const std::vector<E>& elements)
    {
        return proxy::IQueueImpl::retain_all_data(to_data_collection(elements));
    }
 
private:
    iqueue(const std::string& instance_name, spi::ClientContext* context)
      : proxy::IQueueImpl(instance_name, context)
    {}
};
} // namespace client
} // namespace hazelcast