rocketmq_client_rust/producer/
message_queue_selector.rs

1/*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements.  See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License.  You may obtain a copy of the License at
8 *
9 *     http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17use std::sync::Arc;
18
19use rocketmq_common::common::message::message_queue::MessageQueue;
20use rocketmq_common::common::message::message_single::Message;
21use rocketmq_common::common::message::MessageTrait;
22
23pub type MessageQueueSelectorFn = Arc<
24    dyn Fn(&[MessageQueue], &dyn MessageTrait, &dyn std::any::Any) -> Option<MessageQueue>
25        + Send
26        + Sync,
27>;
28
29/// A trait for selecting a message queue.
30///
31/// This trait defines a method for selecting a message queue from a list of available queues
32/// based on the provided message and an additional argument.
33pub trait MessageQueueSelector: Send + Sync {
34    /// Selects a message queue from the provided list.
35    ///
36    /// # Arguments
37    /// * `mqs` - A reference to a vector of `MessageQueue` from which to select.
38    /// * `msg` - A reference to the `Message` for which the queue is being selected.
39    /// * `arg` - An additional argument that can be used in the selection process.
40    ///
41    /// # Returns
42    /// The selected `MessageQueue`.
43    fn select(&self, mqs: &[MessageQueue], msg: &Message, arg: &dyn std::any::Any) -> MessageQueue;
44}
rocketmq_client_rust/producer/message_queue_selector.rs

rocketmq_client_rust/producer/
message_queue_selector.rs
