cpp/source/rocketmq/include/ConsumeMessageService.h

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 <cstdint>
#include <memory>
#include <system_error>

#include "ProcessQueue.h"
#include "rocketmq/MessageListener.h"

ROCKETMQ_NAMESPACE_BEGIN

class ConsumeTask;

class ConsumeMessageService {
public:
  virtual ~ConsumeMessageService() = default;

  /**
   * Start the dispatcher thread, which will dispatch messages in process queue to thread pool in form of runnable
   * functor.
   */
  virtual void start() = 0;

  /**
   * Stop the dispatcher thread and then reset the thread pool.
   */
  virtual void shutdown() = 0;

  virtual void dispatch(std::shared_ptr<ProcessQueue> process_queue, std::vector<MessageConstSharedPtr> messages) = 0;

  virtual void submit(std::shared_ptr<ConsumeTask> task) = 0;

  virtual MessageListener& listener() = 0;

  virtual bool preHandle(const Message& message) = 0;

  virtual bool postHandle(const Message& message, ConsumeResult result) = 0;

  virtual void ack(const Message& message, std::function<void(const std::error_code& ec)> cb) = 0;

  virtual void nack(const Message& message, std::function<void(const std::error_code& ec)> cb) = 0;

  virtual void forward(const Message& message, std::function<void(const std::error_code& ec)> cb) = 0;

  virtual void schedule(std::shared_ptr<ConsumeTask> task, std::chrono::milliseconds delay) = 0;

  virtual std::size_t maxDeliveryAttempt() = 0;

  virtual std::weak_ptr<PushConsumerImpl> consumer() = 0;
};

using ConsumeMessageServiceWeakPtr = std::weak_ptr<ConsumeMessageService>;
using ConsumeMessageServiceSharedPtr = std::shared_ptr<ConsumeMessageService>;

ROCKETMQ_NAMESPACE_END