Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add api definition of recalling message #87

Merged
merged 2 commits into from
Nov 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions StatusCode.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
| CONSUMER_GROUP_NOT_FOUND | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ |
| PAYLOAD_TOO_LARGE* | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 |
| MESSAGE_BODY_TOO_LARGE | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |
| MESSAGE_BODY_EMPTY | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |
| PRECONDITION_FAILED* | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 |
| TOO_MANY_REQUESTS* | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| REQUEST_HEADER_FIELDS_TOO_LARGE* | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 | 🔄 |
Expand Down
19 changes: 19 additions & 0 deletions apache/rocketmq/v2/service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@ message SendResultEntry {
string message_id = 2;
string transaction_id = 3;
int64 offset = 4;
// Unique handle to identify message to recall, support delay message for now.
string recall_handle = 5;
}

message SendMessageResponse {
Expand Down Expand Up @@ -293,6 +295,17 @@ message QueryOffsetResponse {
int64 offset = 2;
}

message RecallMessageRequest {
Resource topic = 1;
// Refer to SendResultEntry.
string recall_handle = 2;
}

message RecallMessageResponse {
Status status = 1;
string message_id = 2;
}

// For all the RPCs in MessagingService, the following error handling policies
// apply:
//
Expand Down Expand Up @@ -416,4 +429,10 @@ service MessagingService {
// ChangeInvisibleDuration to lengthen invisible duration.
rpc ChangeInvisibleDuration(ChangeInvisibleDurationRequest) returns (ChangeInvisibleDurationResponse) {
}

// Recall a message,
// for delay message, should recall before delivery time, like the rollback operation of transaction message,
// for normal message, not supported for now.
rpc RecallMessage(RecallMessageRequest) returns (RecallMessageResponse) {
}
}
Loading