SDK version information for ApsaraMQ for RocketMQ - ApsaraMQ for RocketMQ

This topic describes the software development kit (SDK) versions supported by ApsaraMQ for RocketMQ.

SDK versions

The following table describes the SDKs and features that ApsaraMQ for RocketMQ supports.

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

Comparison 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	The 5.x gRPC SDK is recommended. It provides comprehensive multi-language support. All new features and optimizations will be supported on the 5.x gRPC SDK. If the 5.x gRPC SDK does not meet your needs, consider using the 5.x Remoting SDK.		If your service already uses these client versions, you can continue to use them. 5.x series instances are compatible with these SDK versions.		These client versions are not recommended. They do not support new features and optimizations. They can access only 4.x series instances.
Sending normal, ordered, transactional, and scheduled messages	✅	✅	✅	✅	✅	✅
Lightweight topic-based model	Supported	Not supported	Not supported	Not supported	Not supported	Not supported
Concurrent consumption	✅	✅	✅	✅	✅	✅
Ordered consumption of messages	✅	✅	✅	✅	✅	✅
Concurrency optimization for ordered consumption	✅	❌	❌	❌	❌	❌
Broadcasting consumption	❌	✅	✅	✅	❌	❌
Stream consumption (for connecting to services such as Flink)	❌	✅	✅	❌	❌	❌
Message trace	✅	✅	Supported in versions 4.5.2 and later	✅	✅	❌
Producer and consumer client metrics	✅	❌	❌	❌	❌	❌
Graceful shutdown	✅	Supported only for 5.x series instances	❌	❌	❌	❌

SDK limits

Different consumers in the same consumer group must use clients with the same protocol.
When you perform a canary 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.
- Smooth upgrades are supported for consumer groups that deliver messages concurrently. However, a small number of messages may be duplicated during the upgrade.
When sending messages to the same ordered topic, all producer clients must use the same protocol: either the Remoting protocol or the gRPC protocol.
For a consumer group that delivers messages in order, a consumer offset rollback may occur if you perform the following steps:
1. The ordered consumer group initially runs on a Remoting protocol SDK.
2. You upgrade the SDK to a gRPC protocol SDK.
3. You revert the SDK to the Remoting protocol SDK.
The RocketMQ ONS TCP 2.x SDK is supported only in some regions. For more information, see Limits.

RocketMQ 5.x gRPC SDKs

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

RocketMQ 5.x Remoting SDK

Protocol	Language	References
Remoting protocol	Java SDK	Version Guide Prerequisites Sample code

RocketMQ 4.x/3.x SDKs

Protocol	Language	References
Remoting protocol	Java SDK	Version Guide Prerequisites Sample code
Remoting protocol	C++ SDK	Version Guide Prerequisites Sample code

RocketMQ ONS TCP 1.x SDKs

Protocol	Language	References
Remoting protocol	Java SDK	Version Guide Prerequisites Sample code
	C++ SDK	Version Guide Prerequisites Sample code
	.NET SDK	Version Guide Prerequisites Sample code