This is an automated email from the ASF dual-hosted git repository.
aaronai pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/rocketmq-clients.git
The following commit(s) were added to refs/heads/master by this push:
new fdd9f171 Add more comments (#435)
fdd9f171 is described below
commit fdd9f171f7568d762e7bb52ea92e494af95498a2
Author: Aaron Ai <[email protected]>
AuthorDate: Fri Mar 31 11:34:08 2023 +0800
Add more comments (#435)
---
.github/workflows/cpp_build.yml | 4 ++--
cpp/examples/ExampleProducer.cpp | 1 +
cpp/examples/ExampleProducerWithAsync.cpp | 1 +
cpp/examples/ExampleProducerWithFifoMessage.cpp | 1 +
cpp/examples/ExampleProducerWithTimedMessage.cpp | 1 +
cpp/examples/ExampleProducerWithTransactionalMessage.cpp | 1 +
cpp/examples/ExamplePushConsumer.cpp | 1 +
cpp/examples/ExampleSimpleConsumer.cpp | 1 +
.../rocketmq/client/java/example/AsyncSimpleConsumerExample.java | 1 +
.../org/apache/rocketmq/client/java/example/PushConsumerExample.java | 1 +
.../apache/rocketmq/client/java/example/SimpleConsumerExample.java | 1 +
11 files changed, 12 insertions(+), 2 deletions(-)
diff --git a/.github/workflows/cpp_build.yml b/.github/workflows/cpp_build.yml
index f303f8e5..6115c09e 100644
--- a/.github/workflows/cpp_build.yml
+++ b/.github/workflows/cpp_build.yml
@@ -13,7 +13,7 @@ jobs:
- name: Compile On Linux
working-directory: ./cpp
if: runner.os == 'Linux'
- run: bazel build --config=remote
--remote_header=x-buildbuddy-api-key=${{ secrets.BUILD_BUDDY_API_KEY }} //...
+ run: bazel build //...
- name: Compile On Windows
working-directory: ./cpp
if: runner.os == 'Windows'
@@ -25,7 +25,7 @@ jobs:
- name: Run Unit Tests On Linux
working-directory: ./cpp
if: runner.os == 'Linux'
- run: bazel test --config=remote
--remote_header=x-buildbuddy-api-key=${{ secrets.BUILD_BUDDY_API_KEY }} //...
+ run: bazel test //...
- name: Run Unit Tests On Windows
working-directory: ./cpp
if: runner.os == 'Windows'
diff --git a/cpp/examples/ExampleProducer.cpp b/cpp/examples/ExampleProducer.cpp
index 38b7a796..452b4ce1 100644
--- a/cpp/examples/ExampleProducer.cpp
+++ b/cpp/examples/ExampleProducer.cpp
@@ -72,6 +72,7 @@ int main(int argc, char* argv[]) {
credentials_provider =
std::make_shared<StaticCredentialsProvider>(FLAGS_access_key,
FLAGS_access_secret);
}
+ // In most case, you don't need to create too many producers, singletion
pattern is recommended.
auto producer = Producer::newBuilder()
.withConfiguration(Configuration::newBuilder()
.withEndpoints(FLAGS_access_point)
diff --git a/cpp/examples/ExampleProducerWithAsync.cpp
b/cpp/examples/ExampleProducerWithAsync.cpp
index ac4610ce..102af2f4 100644
--- a/cpp/examples/ExampleProducerWithAsync.cpp
+++ b/cpp/examples/ExampleProducerWithAsync.cpp
@@ -111,6 +111,7 @@ int main(int argc, char* argv[]) {
credentials_provider =
std::make_shared<StaticCredentialsProvider>(FLAGS_access_key,
FLAGS_access_secret);
}
+ // In most case, you don't need to create too many producers, singletion
pattern is recommended.
auto producer = Producer::newBuilder()
.withConfiguration(Configuration::newBuilder()
.withEndpoints(FLAGS_access_point)
diff --git a/cpp/examples/ExampleProducerWithFifoMessage.cpp
b/cpp/examples/ExampleProducerWithFifoMessage.cpp
index 134f9dfb..caede189 100644
--- a/cpp/examples/ExampleProducerWithFifoMessage.cpp
+++ b/cpp/examples/ExampleProducerWithFifoMessage.cpp
@@ -69,6 +69,7 @@ int main(int argc, char* argv[]) {
credentials_provider =
std::make_shared<StaticCredentialsProvider>(FLAGS_access_key,
FLAGS_access_secret);
}
+ // In most case, you don't need to create too many producers, singletion
pattern is recommended.
auto producer = Producer::newBuilder()
.withConfiguration(Configuration::newBuilder()
.withEndpoints(FLAGS_access_point)
diff --git a/cpp/examples/ExampleProducerWithTimedMessage.cpp
b/cpp/examples/ExampleProducerWithTimedMessage.cpp
index 8eaf94b3..1379cd1b 100644
--- a/cpp/examples/ExampleProducerWithTimedMessage.cpp
+++ b/cpp/examples/ExampleProducerWithTimedMessage.cpp
@@ -70,6 +70,7 @@ int main(int argc, char* argv[]) {
credentials_provider =
std::make_shared<StaticCredentialsProvider>(FLAGS_access_key,
FLAGS_access_secret);
}
+ // In most case, you don't need to create too many producers, singletion
pattern is recommended.
auto producer = Producer::newBuilder()
.withConfiguration(Configuration::newBuilder()
.withEndpoints(FLAGS_access_point)
diff --git a/cpp/examples/ExampleProducerWithTransactionalMessage.cpp
b/cpp/examples/ExampleProducerWithTransactionalMessage.cpp
index e6c0aaf0..abff6e4f 100644
--- a/cpp/examples/ExampleProducerWithTransactionalMessage.cpp
+++ b/cpp/examples/ExampleProducerWithTransactionalMessage.cpp
@@ -74,6 +74,7 @@ int main(int argc, char* argv[]) {
credentials_provider =
std::make_shared<StaticCredentialsProvider>(FLAGS_access_key,
FLAGS_access_secret);
}
+ // In most case, you don't need to create too many producers, singletion
pattern is recommended.
auto producer = Producer::newBuilder()
.withConfiguration(Configuration::newBuilder()
.withEndpoints(FLAGS_access_point)
diff --git a/cpp/examples/ExamplePushConsumer.cpp
b/cpp/examples/ExamplePushConsumer.cpp
index 365a84dc..2a3d3fe2 100644
--- a/cpp/examples/ExamplePushConsumer.cpp
+++ b/cpp/examples/ExamplePushConsumer.cpp
@@ -51,6 +51,7 @@ int main(int argc, char* argv[]) {
credentials_provider =
std::make_shared<StaticCredentialsProvider>(FLAGS_access_key,
FLAGS_access_secret);
}
+ // In most case, you don't need to create too many consumers, singletion
pattern is recommended.
auto push_consumer = PushConsumer::newBuilder()
.withGroup(FLAGS_group)
.withConfiguration(Configuration::newBuilder()
diff --git a/cpp/examples/ExampleSimpleConsumer.cpp
b/cpp/examples/ExampleSimpleConsumer.cpp
index b1294cf6..69644282 100644
--- a/cpp/examples/ExampleSimpleConsumer.cpp
+++ b/cpp/examples/ExampleSimpleConsumer.cpp
@@ -45,6 +45,7 @@ int main(int argc, char* argv[]) {
credentials_provider =
std::make_shared<StaticCredentialsProvider>(FLAGS_access_key,
FLAGS_access_secret);
}
+ // In most case, you don't need to create too many consumers, singletion
pattern is recommended.
auto simple_consumer = SimpleConsumer::newBuilder()
.withGroup(FLAGS_group)
.withConfiguration(Configuration::newBuilder()
diff --git
a/java/client/src/main/java/org/apache/rocketmq/client/java/example/AsyncSimpleConsumerExample.java
b/java/client/src/main/java/org/apache/rocketmq/client/java/example/AsyncSimpleConsumerExample.java
index 51f3ccf8..d19a9bfd 100644
---
a/java/client/src/main/java/org/apache/rocketmq/client/java/example/AsyncSimpleConsumerExample.java
+++
b/java/client/src/main/java/org/apache/rocketmq/client/java/example/AsyncSimpleConsumerExample.java
@@ -64,6 +64,7 @@ public class AsyncSimpleConsumerExample {
String tag = "yourMessageTagA";
String topic = "yourTopic";
FilterExpression filterExpression = new FilterExpression(tag,
FilterExpressionType.TAG);
+ // In most case, you don't need to create too many consumers,
singleton pattern is recommended.
SimpleConsumer consumer = provider.newSimpleConsumerBuilder()
.setClientConfiguration(clientConfiguration)
// Set the consumer group name.
diff --git
a/java/client/src/main/java/org/apache/rocketmq/client/java/example/PushConsumerExample.java
b/java/client/src/main/java/org/apache/rocketmq/client/java/example/PushConsumerExample.java
index 04967a75..dab6eb6a 100644
---
a/java/client/src/main/java/org/apache/rocketmq/client/java/example/PushConsumerExample.java
+++
b/java/client/src/main/java/org/apache/rocketmq/client/java/example/PushConsumerExample.java
@@ -55,6 +55,7 @@ public class PushConsumerExample {
FilterExpression filterExpression = new FilterExpression(tag,
FilterExpressionType.TAG);
String consumerGroup = "yourConsumerGroup";
String topic = "yourTopic";
+ // In most case, you don't need to create too many consumers,
singleton pattern is recommended.
PushConsumer pushConsumer = provider.newPushConsumerBuilder()
.setClientConfiguration(clientConfiguration)
// Set the consumer group name.
diff --git
a/java/client/src/main/java/org/apache/rocketmq/client/java/example/SimpleConsumerExample.java
b/java/client/src/main/java/org/apache/rocketmq/client/java/example/SimpleConsumerExample.java
index d69253c0..7adeace6 100644
---
a/java/client/src/main/java/org/apache/rocketmq/client/java/example/SimpleConsumerExample.java
+++
b/java/client/src/main/java/org/apache/rocketmq/client/java/example/SimpleConsumerExample.java
@@ -59,6 +59,7 @@ public class SimpleConsumerExample {
String tag = "yourMessageTagA";
String topic = "yourTopic";
FilterExpression filterExpression = new FilterExpression(tag,
FilterExpressionType.TAG);
+ // In most case, you don't need to create too many consumers,
singleton pattern is recommended.
SimpleConsumer consumer = provider.newSimpleConsumerBuilder()
.setClientConfiguration(clientConfiguration)
// Set the consumer group name.
