Skip to main content

rocketmq_protocol/protocol/header/
peek_message_request_header.rs

1// Copyright 2023 The RocketMQ Rust Authors
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use cheetah_string::CheetahString;
16use rocketmq_macros::RequestHeaderCodec;
17use serde::Deserialize;
18use serde::Serialize;
19
20use crate::protocol::header::message_operation_header::TopicRequestHeaderTrait;
21use crate::protocol::header::namesrv::topic_operation_header::TopicRequestHeader;
22
23#[derive(Clone, Debug, Serialize, Deserialize, RequestHeaderCodec)]
24#[header(
25    type_id = "rocketmq_protocol::protocol::header::peek_message_request_header::PeekMessageRequestHeader",
26    java_class = "org.apache.rocketmq.remoting.protocol.header.PeekMessageRequestHeader"
27)]
28#[serde(rename_all = "camelCase")]
29pub struct PeekMessageRequestHeader {
30    #[header(required)]
31    pub consumer_group: CheetahString,
32
33    #[header(required)]
34    pub topic: CheetahString,
35
36    /// If negative, peek from all queues
37    #[header(required)]
38    pub queue_id: i32,
39
40    #[header(required)]
41    pub max_msg_nums: i32,
42
43    #[serde(flatten)]
44    #[header(flatten, presence = "always")]
45    pub topic_request_header: Option<TopicRequestHeader>,
46}
47
48impl Default for PeekMessageRequestHeader {
49    fn default() -> Self {
50        PeekMessageRequestHeader {
51            consumer_group: CheetahString::new(),
52            topic: CheetahString::new(),
53            queue_id: 0,
54            max_msg_nums: 32,
55            topic_request_header: None,
56        }
57    }
58}
59
60impl TopicRequestHeaderTrait for PeekMessageRequestHeader {
61    fn set_lo(&mut self, lo: Option<bool>) {
62        if let Some(header) = self.topic_request_header.as_mut() {
63            header.lo = lo;
64        }
65    }
66
67    fn lo(&self) -> Option<bool> {
68        self.topic_request_header.as_ref().and_then(|h| h.lo)
69    }
70
71    fn set_topic(&mut self, topic: CheetahString) {
72        self.topic = topic;
73    }
74
75    fn topic(&self) -> &CheetahString {
76        &self.topic
77    }
78
79    fn broker_name(&self) -> Option<&CheetahString> {
80        self.topic_request_header
81            .as_ref()
82            .and_then(|h| h.rpc.as_ref())
83            .and_then(|h| h.broker_name.as_ref())
84    }
85
86    fn set_broker_name(&mut self, broker_name: CheetahString) {
87        if let Some(header) = self.topic_request_header.as_mut() {
88            if let Some(rpc_header) = header.rpc.as_mut() {
89                rpc_header.broker_name = Some(broker_name);
90            }
91        }
92    }
93
94    fn namespace(&self) -> Option<&str> {
95        self.topic_request_header
96            .as_ref()
97            .and_then(|h| h.rpc.as_ref())
98            .and_then(|r| r.namespace.as_deref())
99    }
100
101    fn set_namespace(&mut self, namespace: CheetahString) {
102        if let Some(header) = self.topic_request_header.as_mut() {
103            if let Some(rpc_header) = header.rpc.as_mut() {
104                rpc_header.namespace = Some(namespace);
105            }
106        }
107    }
108
109    fn namespaced(&self) -> Option<bool> {
110        self.topic_request_header
111            .as_ref()
112            .and_then(|h| h.rpc.as_ref())
113            .and_then(|r| r.namespaced)
114    }
115
116    fn set_namespaced(&mut self, namespaced: bool) {
117        if let Some(header) = self.topic_request_header.as_mut() {
118            if let Some(rpc_header) = header.rpc.as_mut() {
119                rpc_header.namespaced = Some(namespaced);
120            }
121        }
122    }
123
124    fn oneway(&self) -> Option<bool> {
125        self.topic_request_header
126            .as_ref()
127            .and_then(|h| h.rpc.as_ref())
128            .and_then(|r| r.oneway)
129    }
130
131    fn set_oneway(&mut self, oneway: bool) {
132        if let Some(header) = self.topic_request_header.as_mut() {
133            if let Some(rpc_header) = header.rpc.as_mut() {
134                rpc_header.oneway = Some(oneway);
135            }
136        }
137    }
138
139    fn queue_id(&self) -> i32 {
140        self.queue_id
141    }
142
143    fn set_queue_id(&mut self, queue_id: i32) {
144        self.queue_id = queue_id;
145    }
146}
147
148#[cfg(test)]
149mod tests {
150    use super::*;
151
152    #[test]
153    fn test_default_implementation() {
154        let header = PeekMessageRequestHeader::default();
155        assert_eq!(header.consumer_group, CheetahString::new());
156        assert_eq!(header.topic, CheetahString::new());
157        assert_eq!(header.queue_id, 0);
158        assert_eq!(header.max_msg_nums, 32);
159        assert!(header.topic_request_header.is_none());
160    }
161    #[test]
162    fn test_serialization_deserialization() {
163        let header = PeekMessageRequestHeader {
164            consumer_group: CheetahString::from("test_consumer_group"),
165            topic: CheetahString::from("test_topic"),
166            queue_id: 10,
167            max_msg_nums: 32,
168            ..Default::default()
169        };
170
171        // Serialize to JSON
172        let json = serde_json::to_string(&header).unwrap();
173
174        // Deserialize from JSON
175        let deserialized: PeekMessageRequestHeader = serde_json::from_str(&json).unwrap();
176
177        assert_eq!(deserialized.consumer_group, header.consumer_group);
178        assert_eq!(deserialized.topic, header.topic);
179        assert_eq!(deserialized.queue_id, header.queue_id);
180        assert_eq!(deserialized.max_msg_nums, header.max_msg_nums);
181    }
182}