SDK version information for ApsaraMQ for RocketMQ - ApsaraMQ for RocketMQ

This topic describes the SDK versions that ApsaraMQ for RocketMQ supports.

SDK versions

The following table describes the features that different ApsaraMQ for RocketMQ SDK versions support.

In the following table, ✅ indicates that the feature is supported, and ❌ indicates that the feature is not supported.

Item	RocketMQ 5.x gRPC SDK	RocketMQ 5.x Remoting SDK	RocketMQ 4.x/3.x SDK	RocketMQ ONS TCP 1.x SDK	RocketMQ ONS TCP 2.x SDK	RocketMQ ONS HTTP SDK
Protocol	gRPC protocol v2	Remoting protocol	Remoting protocol	Remoting protocol	gRPC protocol v1	HTTP protocol
Accessible instances	5.x series instances	5.x series instances 4.x series instances	5.x series instances 4.x series instances	5.x series instances 4.x series instances	4.x series instances	4.x series instances
Recommendations	Use the 5.x gRPC SDK. It provides comprehensive support for multiple languages. The 5.x gRPC SDK will support all new features and optimizations. If some features of the 5.x gRPC SDK do not meet your requirements, you can use the 5.x Remoting SDK.		If your business already uses clients of these versions, you can continue to use them. 5.x series instances are compatible with these SDK versions.		Do not use clients of these versions. These SDK versions do not support new features and optimizations. You can access only 4.x series instances.
Send normal, ordered, transactional, and scheduled messages	✅	✅	✅	✅	✅	✅
Lightweight topic-based model	✅	❌	❌	❌	❌	❌
Concurrent consumption	✅	✅	✅	✅	✅	✅
Ordered consumption of messages	✅	✅	✅	✅	✅	✅
Concurrency optimization for ordered consumption of messages	✅	❌	❌	❌	❌	❌
Broadcasting consumption	❌	✅	✅	✅	❌	❌
Stream consumption (connecting to Flink, etc.)	❌	✅	✅	❌	❌	❌
Message trace	✅	✅	Supported in versions 4.5.2 and later	✅	✅	❌
Producer and consumer client metrics data	✅	❌	❌	❌	❌	❌
Graceful shutdown	✅	Supported only for 5.x series instances	❌	❌	❌	❌
Batch sending	❌	✅	✅	❌	❌	❌

Limits

Different consumers in the same consumer group must use clients that support the same protocol.
When you perform a grayscale upgrade from a Remoting protocol SDK to a gRPC protocol SDK for the same consumer group, note the following:
- Upgrades are not supported for consumer groups that deliver messages in order.
- Consumer groups that deliver messages concurrently support smooth upgrades. A small number of messages may be duplicated during the upgrade.
To send messages to the same ordered topic, all producer clients must use the same protocol. The protocol must be either the Remoting protocol or the gRPC protocol.
For a consumer group that delivers messages in order, the consumer offset for ordered consumption of messages may be rolled back if the following steps are performed:
1. The consumer group for ordered messages first uses a Remoting protocol SDK.
2. The SDK is then upgraded to a gRPC protocol SDK.
3. The SDK is rolled back to the Remoting protocol SDK.
The RocketMQ ONS TCP 2.x SDK is available only in some regions. For more information, see Limits.

RocketMQ 5.x gRPC SDK

Protocol	Language	References
gRPC protocol v2	Java SDK	Version Guide Prepare the environment Sample code
	C# SDK	Version Guide Prepare the environment Sample code
	Go SDK	Version Guide Prepare the environment Sample code
	Python SDK	Version Guide Prepare the environment Sample code
	C++ SDK	Version Guide Prepare the environment Sample code

RocketMQ 5.x Remoting SDK

Protocol	Language	References
Remoting protocol	Java SDK	Version Guide Prepare the environment Sample code

RocketMQ 4.x/3.x SDK

Protocol	Language	References
Remoting protocol	Java SDK	Version Guide Prepare the environment Sample code
Remoting protocol	C++ SDK	Version Guide Prepare the environment Sample code

RocketMQ ONS TCP 1.x SDK

Protocol	Language	References
Remoting protocol	Java SDK	Version Guide Prepare the environment Sample code
	C++ SDK	Version Guide Prepare the environment Sample code
	.NET SDK	Version Guide Prepare the environment Sample code