rocketmq_protocol/protocol/
headers.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
15//! Re-exported request/response headers organized by category
16//!
17//! This module provides simplified access to commonly used headers through re-exports.
18//! Original module paths remain functional for backward compatibility.
19//!
20//! # Usage Examples
21//!
22//! ## Import by category
23//! ```rust
24//! use rocketmq_protocol::protocol::headers::message::SendMessageRequestHeader;
25//! use rocketmq_protocol::protocol::headers::namesrv::RegisterBrokerRequestHeader;
26//! use rocketmq_protocol::protocol::headers::namesrv::UnRegisterBrokerRequestHeader;
27//! ```
28//!
29//! ## Import most common types directly
30//! ```rust
31//! use rocketmq_protocol::protocol::headers::PullMessageRequestHeader;
32//! use rocketmq_protocol::protocol::headers::SendMessageRequestHeader;
33//! ```
34
35/// Send and receive message headers
36pub mod message {
37    pub use super::super::header::message_operation_header::send_message_request_header::SendMessageRequestHeader;
38    pub use super::super::header::message_operation_header::send_message_request_header_v2::SendMessageRequestHeaderV2;
39    pub use super::super::header::message_operation_header::send_message_response_header::SendMessageResponseHeader;
40}
41
42/// Pull and query message headers
43pub mod polling {
44    pub use super::super::header::peek_message_request_header::PeekMessageRequestHeader;
45    pub use super::super::header::polling_info_request_header::PollingInfoRequestHeader;
46    pub use super::super::header::polling_info_response_header::PollingInfoResponseHeader;
47    pub use super::super::header::pop_message_request_header::PopMessageRequestHeader;
48    pub use super::super::header::pop_message_response_header::PopMessageResponseHeader;
49    pub use super::super::header::pull_message_request_header::PullMessageRequestHeader;
50    pub use super::super::header::pull_message_response_header::PullMessageResponseHeader;
51}
52
53/// Acknowledgment headers
54pub mod ack {
55    pub use super::super::header::ack_message_request_header::AckMessageRequestHeader;
56    pub use super::super::header::change_invisible_time_request_header::ChangeInvisibleTimeRequestHeader;
57    pub use super::super::header::change_invisible_time_response_header::ChangeInvisibleTimeResponseHeader;
58}
59
60/// Query message headers
61pub mod query {
62    pub use super::super::header::query_consume_time_span_request_header::QueryConsumeTimeSpanRequestHeader;
63    pub use super::super::header::query_consumer_offset_request_header::QueryConsumerOffsetRequestHeader;
64    pub use super::super::header::query_consumer_offset_response_header::QueryConsumerOffsetResponseHeader;
65    pub use super::super::header::query_message_request_header::QueryMessageRequestHeader;
66    pub use super::super::header::query_message_response_header::QueryMessageResponseHeader;
67    pub use super::super::header::query_subscription_by_consumer_request_header::QuerySubscriptionByConsumerRequestHeader;
68    pub use super::super::header::query_topic_consume_by_who_request_header::QueryTopicConsumeByWhoRequestHeader;
69    pub use super::super::header::query_topics_by_consumer_request_header::QueryTopicsByConsumerRequestHeader;
70}
71
72/// View and search message headers
73pub mod view {
74    pub use super::super::header::search_offset_request_header::SearchOffsetRequestHeader;
75    pub use super::super::header::search_offset_response_header::SearchOffsetResponseHeader;
76    pub use super::super::header::view_message_request_header::ViewMessageRequestHeader;
77    pub use super::super::header::view_message_response_header::ViewMessageResponseHeader;
78}
79
80pub mod client {
81    pub use super::super::header::client_request_header::GetRouteInfoRequestHeader;
82    pub use super::super::header::get_consumer_connection_list_request_header::GetConsumerConnectionListRequestHeader;
83    pub use super::super::header::get_consumer_listby_group_request_header::GetConsumerListByGroupRequestHeader;
84    pub use super::super::header::get_consumer_listby_group_response_header::GetConsumerListByGroupResponseHeader;
85    pub use super::super::header::get_consumer_running_info_request_header::GetConsumerRunningInfoRequestHeader;
86    pub use super::super::header::get_producer_connection_list_request_header::GetProducerConnectionListRequestHeader;
87    pub use super::super::header::heartbeat_request_header::HeartbeatRequestHeader;
88    pub use super::super::header::notify_consumer_ids_changed_request_header::NotifyConsumerIdsChangedRequestHeader;
89    pub use super::super::header::notify_unsubscribe_lite_request_header::NotifyUnsubscribeLiteRequestHeader;
90    pub use super::super::header::unregister_client_request_header::UnregisterClientRequestHeader;
91}
92
93pub mod namesrv {
94    pub use super::super::header::namesrv::broker_request::BrokerHeartbeatRequestHeader;
95    pub use super::super::header::namesrv::broker_request::GetBrokerMemberGroupRequestHeader;
96    pub use super::super::header::namesrv::broker_request::UnRegisterBrokerRequestHeader;
97    pub use super::super::header::namesrv::brokerid_change_request_header::NotifyMinBrokerIdChangeRequestHeader;
98    pub use super::super::header::namesrv::kv_config_header::DeleteKVConfigRequestHeader;
99    pub use super::super::header::namesrv::kv_config_header::GetKVConfigRequestHeader;
100    pub use super::super::header::namesrv::kv_config_header::GetKVConfigResponseHeader;
101    pub use super::super::header::namesrv::kv_config_header::GetKVListByNamespaceRequestHeader;
102    pub use super::super::header::namesrv::kv_config_header::PutKVConfigRequestHeader;
103    pub use super::super::header::namesrv::perm_broker_header::AddWritePermOfBrokerRequestHeader;
104    pub use super::super::header::namesrv::perm_broker_header::AddWritePermOfBrokerResponseHeader;
105    pub use super::super::header::namesrv::perm_broker_header::WipeWritePermOfBrokerRequestHeader;
106    pub use super::super::header::namesrv::perm_broker_header::WipeWritePermOfBrokerResponseHeader;
107    pub use super::super::header::namesrv::query_data_version_header::QueryDataVersionRequestHeader;
108    pub use super::super::header::namesrv::query_data_version_header::QueryDataVersionResponseHeader;
109    pub use super::super::header::namesrv::register_broker_header::RegisterBrokerRequestHeader;
110    pub use super::super::header::namesrv::register_broker_header::RegisterBrokerResponseHeader;
111    pub use super::super::header::namesrv::topic_operation_header::DeleteTopicFromNamesrvRequestHeader;
112    pub use super::super::header::namesrv::topic_operation_header::GetTopicsByClusterRequestHeader;
113    pub use super::super::header::namesrv::topic_operation_header::RegisterTopicRequestHeader;
114    pub use super::super::header::namesrv::topic_operation_header::TopicRequestHeader;
115}
116
117pub mod broker {
118    pub use super::super::header::broker::broker_heartbeat_request_header::BrokerHeartbeatRequestHeader;
119}
120
121pub mod controller {
122    pub use super::super::header::controller::alter_sync_state_set_request_header::AlterSyncStateSetRequestHeader;
123    pub use super::super::header::controller::alter_sync_state_set_response_header::AlterSyncStateSetResponseHeader;
124    pub use super::super::header::controller::apply_broker_id_request_header::ApplyBrokerIdRequestHeader;
125    pub use super::super::header::controller::apply_broker_id_response_header::ApplyBrokerIdResponseHeader;
126    pub use super::super::header::controller::clean_broker_data_request_header::CleanBrokerDataRequestHeader;
127    pub use super::super::header::controller::clean_broker_data_request_header::CleanControllerBrokerDataRequestHeader;
128    pub use super::super::header::controller::elect_master_request_header::ElectMasterRequestHeader;
129    pub use super::super::header::controller::get_next_broker_id_request_header::GetNextBrokerIdRequestHeader;
130    pub use super::super::header::controller::get_next_broker_id_response_header::GetNextBrokerIdResponseHeader;
131    pub use super::super::header::controller::get_replica_info_request_header::GetReplicaInfoRequestHeader;
132    pub use super::super::header::controller::get_replica_info_response_header::GetReplicaInfoResponseHeader;
133    pub use super::super::header::controller::register_broker_to_controller_request_header::RegisterBrokerToControllerRequestHeader;
134    pub use super::super::header::controller::register_broker_to_controller_response_header::RegisterBrokerToControllerResponseHeader;
135}
136
137pub mod admin {
138    pub use super::super::header::add_broker_request_header::AddBrokerRequestHeader;
139    pub use super::super::header::create_topic_list_request_header::CreateTopicListRequestHeader;
140    pub use super::super::header::create_topic_request_header::CreateTopicRequestHeader;
141    pub use super::super::header::delete_subscription_group_request_header::DeleteSubscriptionGroupRequestHeader;
142    pub use super::super::header::delete_topic_request_header::DeleteTopicRequestHeader;
143    pub use super::super::header::export_rocksdb_config_to_json_request_header::ExportRocksDBConfigToJsonRequestHeader;
144    pub use super::super::header::export_rocksdb_config_to_json_request_header::ExportRocksdbConfigToJsonRequestHeader;
145    pub use super::super::header::get_all_producer_info_request_header::GetAllProducerInfoRequestHeader;
146    pub use super::super::header::get_all_subscription_group_request_header::GetAllSubscriptionGroupRequestHeader;
147    pub use super::super::header::get_all_subscription_group_request_header::GetAllSubscriptionGroupResponseHeader;
148    pub use super::super::header::get_all_topic_config_request_header::GetAllTopicConfigRequestHeader;
149    pub use super::super::header::get_all_topic_config_response_header::GetAllTopicConfigResponseHeader;
150    pub use super::super::header::get_consume_stats_in_broker_header::GetConsumeStatsInBrokerHeader;
151    pub use super::super::header::get_consume_stats_request_header::GetConsumeStatsRequestHeader;
152    pub use super::super::header::get_consumer_status_request_header::GetConsumerStatusRequestHeader;
153    pub use super::super::header::get_topic_config_request_header::GetTopicConfigRequestHeader;
154    pub use super::super::header::get_topic_stats_info_request_header::GetTopicStatsInfoRequestHeader;
155    pub use super::super::header::get_topic_stats_request_header::GetTopicStatsRequestHeader;
156    pub use super::super::header::remove_broker_request_header::RemoveBrokerRequestHeader;
157    pub use super::super::header::update_global_white_addrs_config_request_header::UpdateGlobalWhiteAddrsConfigRequestHeader;
158}
159
160pub mod transaction {
161    pub use super::super::header::check_transaction_state_request_header::CheckTransactionStateRequestHeader;
162    pub use super::super::header::check_transaction_state_response_header::CheckTransactionStateResponseHeader;
163    pub use super::super::header::end_transaction_request_header::EndTransactionRequestHeader;
164}
165
166pub mod offset {
167    pub use super::super::header::query_consumer_offset_request_header::QueryConsumerOffsetRequestHeader;
168    pub use super::super::header::query_consumer_offset_response_header::QueryConsumerOffsetResponseHeader;
169    pub use super::super::header::query_correction_offset_header::QueryCorrectionOffsetHeader;
170    pub use super::super::header::reset_offset_request_header::ResetOffsetRequestHeader;
171    pub use super::super::header::search_offset_request_header::SearchOffsetRequestHeader;
172    pub use super::super::header::search_offset_response_header::SearchOffsetResponseHeader;
173    pub use super::super::header::update_consumer_offset_conditional_header::UpdateConsumerOffsetConditionalHeader;
174    pub use super::super::header::update_consumer_offset_header::UpdateConsumerOffsetRequestHeader;
175    pub use super::super::header::update_consumer_offset_header::UpdateConsumerOffsetResponseHeader;
176}
177
178pub mod lock {
179    pub use super::super::header::lock_batch_mq_request_header::LockBatchMqRequestHeader;
180    pub use super::super::header::unlock_batch_mq_request_header::UnlockBatchMqRequestHeader;
181}
182
183pub mod min_offset {
184    pub use super::super::header::get_min_offset_request_header::GetMinOffsetRequestHeader;
185    pub use super::super::header::get_min_offset_response_header::GetMinOffsetResponseHeader;
186}
187
188pub mod max_offset {
189    pub use super::super::header::get_max_offset_request_header::GetMaxOffsetRequestHeader;
190    pub use super::super::header::get_max_offset_response_header::GetMaxOffsetResponseHeader;
191}
192
193pub mod acl {
194    pub use super::super::header::create_user_request_header::CreateUserRequestHeader;
195    pub use super::super::header::delete_acl_request_header::DeleteAclRequestHeader;
196    pub use super::super::header::delete_user_request_header::DeleteUserRequestHeader;
197    pub use super::super::header::get_user_request_headers::GetUserRequestHeader;
198    pub use super::super::header::list_acl_request_header::ListAclRequestHeader;
199    pub use super::super::header::list_acl_request_header::ListAclsRequestHeader;
200    pub use super::super::header::list_users_request_header::ListUsersRequestHeader;
201    pub use super::super::header::update_user_request_header::UpdateUserRequestHeader;
202}
203
204pub mod lite {
205    pub use super::super::header::lite_subscription_ctl_request_header::LiteSubscriptionCtlRequestHeader;
206    pub use super::super::header::notify_unsubscribe_lite_request_header::NotifyUnsubscribeLiteRequestHeader;
207}
208
209pub mod special {
210    pub use super::super::header::consume_message_directly_result_request_header::ConsumeMessageDirectlyResultRequestHeader;
211    pub use super::super::header::consumer_send_msg_back_request_header::ConsumerSendMsgBackRequestHeader;
212    pub use super::super::header::reply_message_request_header::ReplyMessageRequestHeader;
213}
214
215pub mod notification {
216    pub use super::super::header::notification_request_header::NotificationRequestHeader;
217    pub use super::super::header::notification_response_header::NotificationResponseHeader;
218    pub use super::super::header::notify_broker_role_change_request_header::NotifyBrokerRoleChangedRequestHeader;
219}
220
221pub mod ha {
222    pub use super::super::header::exchange_ha_info_request_header::ExchangeHAInfoRequestHeader;
223    pub use super::super::header::exchange_ha_info_response_header::ExchangeHaInfoResponseHeader;
224    pub use super::super::header::reset_master_flush_offset_header::ResetMasterFlushOffsetHeader;
225}
226
227pub mod util {
228    pub use super::super::header::elect_master_response_header::ElectMasterResponseHeader;
229    pub use super::super::header::empty_header::EmptyHeader;
230    pub use super::super::header::get_earliest_msg_storetime_response_header::GetEarliestMsgStoretimeResponseHeader;
231    pub use super::super::header::get_meta_data_response_header::GetMetaDataResponseHeader;
232}
233
234// These are available as: rocketmq_protocol::protocol::headers::<TypeName>
235// Message operations (most frequently used)
236pub use super::header::ack_message_request_header::AckMessageRequestHeader;
237pub use super::header::message_operation_header::send_message_request_header::SendMessageRequestHeader;
238pub use super::header::pop_message_request_header::PopMessageRequestHeader;
239pub use super::header::pull_message_request_header::PullMessageRequestHeader;
240
241// Client operations
242pub use super::header::client_request_header::GetRouteInfoRequestHeader;
243pub use super::header::heartbeat_request_header::HeartbeatRequestHeader;
244
245// NameServer operations
246pub use super::header::namesrv::broker_request::UnRegisterBrokerRequestHeader;
247pub use super::header::namesrv::register_broker_header::RegisterBrokerRequestHeader;
248
249// Common response headers
250pub use super::header::get_max_offset_response_header::GetMaxOffsetResponseHeader;
251pub use super::header::get_min_offset_response_header::GetMinOffsetResponseHeader;
252pub use super::header::pull_message_response_header::PullMessageResponseHeader;
253
254// Administrative operations
255pub use super::header::add_broker_request_header::AddBrokerRequestHeader;
256pub use super::header::create_topic_list_request_header::CreateTopicListRequestHeader;
257pub use super::header::create_topic_request_header::CreateTopicRequestHeader;
258pub use super::header::delete_topic_request_header::DeleteTopicRequestHeader;
259pub use super::header::get_all_producer_info_request_header::GetAllProducerInfoRequestHeader;
260pub use super::header::get_all_subscription_group_request_header::GetAllSubscriptionGroupRequestHeader;
261pub use super::header::get_all_subscription_group_request_header::GetAllSubscriptionGroupResponseHeader;
262pub use super::header::get_all_topic_config_request_header::GetAllTopicConfigRequestHeader;
263pub use super::header::get_topic_config_request_header::GetTopicConfigRequestHeader;
264pub use super::header::remove_broker_request_header::RemoveBrokerRequestHeader;
265
266// Offset operations
267pub use super::header::query_consumer_offset_request_header::QueryConsumerOffsetRequestHeader;
268pub use super::header::update_consumer_offset_conditional_header::UpdateConsumerOffsetConditionalHeader;
269pub use super::header::update_consumer_offset_header::UpdateConsumerOffsetRequestHeader;
270
271// Utility
272pub use super::header::empty_header::EmptyHeader;
rocketmq_protocol/protocol/headers.rs

rocketmq_protocol/protocol/
headers.rs
