You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@rocketmq.apache.org by GitBox <gi...@apache.org> on 2022/03/14 11:48:58 UTC
[GitHub] [rocketmq] RongtongJin commented on a change in pull request #3987: [RIP-37] Add new APIs for producer
RongtongJin commented on a change in pull request #3987:
URL: https://github.com/apache/rocketmq/pull/3987#discussion_r825856791
##########
File path: apis/src/main/java/org/apache/rocketmq/apis/message/MessageView.java
##########
@@ -0,0 +1,116 @@
+/*
+ * 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.
+ */
+
+package org.apache.rocketmq.apis.message;
+
+import java.util.Collection;
+import java.util.Map;
+import java.util.Optional;
+import org.apache.rocketmq.apis.MessageQueue;
+
+public interface MessageView {
+ /**
+ * Get the unique id of message.
+ *
+ * @return unique id.
+ */
+ MessageId getMessageId();
+
+ /**
+ * Get the topic of message.
+ *
+ * @return topic of message.
+ */
+ String getTopic();
+
+ /**
+ * Get the {@link MessageQueue} of message.
+ *
+ * @return message queue.
+ */
+ MessageQueue getMessageQueue();
+
+ /**
+ * Get the position of message in {@link MessageQueue}.
+ */
+ long getOffset();
+
+ /**
+ * Get the <strong>deep copy</strong> of message body, which makes the modification of return value does not
+ * affect the message itself.
+ *
+ * @return the <strong>deep copy</strong> of message body.
+ */
+ byte[] getBody();
+
+ /**
+ * Get the <strong>deep copy</strong> of message properties, which makes the modification of return value does
+ * not affect the message itself.
+ *
+ * @return the <strong>deep copy</strong> of message properties.
+ */
+ Map<String, String> getProperties();
+
+ /**
+ * Get the tag of message, which is optional.
+ *
+ * @return the tag of message, which is optional.
+ */
+ Optional<String> getTag();
+
+ /**
+ * Get the key collection of message.
+ *
+ * @return <strong>the key collection</strong> of message.
+ */
+ Collection<String> getKeys();
+
+ /**
+ * Get the born host of message.
+ *
+ * @return born host of message.
+ */
+ String getBornHost();
+
+ /**
+ * Get the born timestamp of message.
+ *
+ * @return born timestamp of message.
+ */
+ long getBornTimestamp();
+
+ /**
+ * Get the message group, which is optional and only make sense only when topic type is fifo.
+ *
+ * @return message group, which is optional.
+ */
+ Optional<String> getMessageGroup();
+
+ /**
+ * Get the expected delivery timestamp, which make sense only when topic type id delay.
Review comment:
'when topic type is delay', not 'when topic type id delay'
##########
File path: apis/src/main/java/org/apache/rocketmq/apis/message/MessageIdVersion.java
##########
@@ -0,0 +1,29 @@
+/*
+ * 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.
+ */
+
+package org.apache.rocketmq.apis.message;
+
+public enum MessageIdVersion {
Review comment:
Why are there multiple versions of messageId？
##########
File path: apis/src/main/java/org/apache/rocketmq/apis/message/Message.java
##########
@@ -0,0 +1,77 @@
+/*
+ * 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.
+ */
+
+package org.apache.rocketmq.apis.message;
+
+import java.util.Collection;
+import java.util.Map;
+import java.util.Optional;
+import org.apache.rocketmq.apis.producer.Producer;
+
+/**
+ * Abstract message only used for {@link Producer}.
+ */
+public interface Message {
+ /**
+ * Get the topic of message, which is the first classifier for message.
+ *
+ * @return topic of message.
+ */
+ String getTopic();
+
+ /**
+ * Get the <strong>deep copy</strong> of message body.
+ *
+ * @return the <strong>deep copy</strong> of message body.
+ */
+ byte[] getBody();
+
+ /**
+ * Get the <strong>deep copy</strong> of message properties.
+ *
+ * @return the <strong>deep copy</strong> of message properties.
+ */
+ Map<String, String> getProperties();
+
+ /**
+ * Get the tag of message, which is the second classifier besides topic.
+ *
+ * @return the tag of message.
+ */
+ Optional<String> getTag();
+
+ /**
+ * Get the key collection of message.
+ *
+ * @return <strong>the key collection</strong> of message.
+ */
+ Collection<String> getKeys();
+
+ /**
+ * Get the message group, which make sense only when topic type is fifo.
+ *
+ * @return message group, which is optional.
+ */
+ Optional<String> getMessageGroup();
+
+ /**
+ * Get the expected delivery timestamp, which make sense only when topic type id delay.
Review comment:
'when topic type is delay', not 'when topic type id delay'
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@rocketmq.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org