apache / rocketmq-apis

RocketMQ APIs - Protobuf definition for Apache RocketMQ

Overview

RocketMQ APIs use Protocol Buffers version 3 (proto3) as their Interface Definition Language (IDL) to define the API interface and the structure of the payload messages. Reading these definitions can understand RocketMQ 5.0 models and API behaviors easily.

Currently, Apache RocketMQ only supports these APIs over gRPC, a high-performance binary RPC protocol over HTTP/2. The implementation consists of two parts:

• rocketmq: The main repo of Apache RocketMQ contains a proxy module that implements this specification in the server-side.
• rocketmq-clients: A mono repo consists of polyglot clients that implement this specification in the client-side.

rocketmq-apis's Issues

Why Producer not support send messages for batch

Is your feature request related to a problem? Please describe.
4.x client support send batch，but 5.x not support，and the producer implement support batch

Describe the solution you'd like
Add function List send(List messages) throws ClientException;

Add pollingTime for ReceiveMessageRequest

Add pollingTime for ReceiveMessageRequest to support long polling sematic.

Should we remove RecoverOrphanedTransactionCommand#message_queue ?

Should we remove it just like VerifyMessageCommand#message_queue ? #52

Make service interface orthogonal and independent

The service interface should be orthogonal and independent of other services.

So I am proposing to add Endpoints filed to QueryRouteRequest and QueryAssignmentRequest, and add auto_renew to ReceiveMessageRequest. In this way, the service interface will not depend on access_point and client_type in Settings.

Add comments for pull-related RPC

Add Code: ILLEGAL_OFFSET

Support Timing Messages with Arbitrary Time Delay.

When there are clock issues on the client and server side, it can cause timer message deliver not correct.

Check message type based on flag from server's publishing setting.

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Add new ClientType: PULL_CONSUMER

Add MessageQueue in SendMessageRequest

Although we have introduced pull consumer in #67, we still need to add the MessageQueue parameter to the SendMessageRequest in order for users to send messages to the specified partition

Support `optional` in v2

As we can see, optional has been supported in protobuf 3.15, just as it in proto2, apply it in v2 may be a good idea.

Add attempt_id in ReceiveMessageRequest

Is your feature request related to a problem? Please describe.
In apache/rocketmq#6690, we introduce the concept of reentrant pop consumption, so we should add attempt_id to ReceiveMessageRequest

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Add code OFFSET_NOT_FOUND

If the offset does not exist, the getOffset function should return OFFSET_NOT_FOUND

Add more code to cover rocketmq behavior

Is your feature request related to a problem? Please describe.
Current code cannot cover all rocketmq behavior such as FLUSH_DISK_TIMEOUT and FLUSH_SLAVE_TIMEOUT. And the similar codes should be grouped according to usage.

Describe the solution you'd like
Add more code and group them by usage.

Describe alternatives you've considered

Additional context
rocketmq ResponseCode
https://github.com/apache/rocketmq/blob/8745d4c538d5c96e65a56f6278029c5765e7d922/common/src/main/java/org/apache/rocketmq/common/protocol/ResponseCode.java#L22

Update document for pull-related RPC

remove status in ThreadStackTrace and VerifyMessageResult

status is already defined in TelemetryCommand