rocketmq-client-nodejs
Version:
RocketMQ Node.js Client
62 lines (61 loc) • 3.25 kB
TypeScript
/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { ClientType, TransactionResolution, TransactionSource } from '../../proto/apache/rocketmq/v2/definition_pb';
import { HeartbeatRequest, NotifyClientTerminationRequest, RecoverOrphanedTransactionCommand } from '../../proto/apache/rocketmq/v2/service_pb';
import { Endpoints } from '../route';
import { BaseClient, BaseClientOptions, Settings } from '../client';
import { MessageOptions, Message } from '../message';
import { PublishingSettings } from './PublishingSettings';
import { TransactionChecker } from './TransactionChecker';
import { SendReceipt } from './SendReceipt';
import { Transaction } from './Transaction';
import { RecallReceipt } from './RecallReceipt';
export interface ProducerOptions extends BaseClientOptions {
topic?: string | string[];
maxAttempts?: number;
checker?: TransactionChecker;
}
export declare class Producer extends BaseClient {
#private;
constructor(options: ProducerOptions);
startup(): Promise<void>;
shutdown(): Promise<void>;
get publishingSettings(): PublishingSettings;
beginTransaction(): Transaction;
endTransaction(endpoints: Endpoints, message: Message, messageId: string, transactionId: string, resolution: TransactionResolution, source?: TransactionSource): Promise<void>;
onRecoverOrphanedTransactionCommand(endpoints: Endpoints, command: RecoverOrphanedTransactionCommand): Promise<void>;
protected getSettings(): Settings;
/**
* Get the client type.
*
* @return The client type identifier for producer
*/
protected getClientType(): ClientType;
protected wrapHeartbeatRequest(): HeartbeatRequest;
protected wrapNotifyClientTerminationRequest(): NotifyClientTerminationRequest;
send(message: MessageOptions, transaction?: Transaction): Promise<SendReceipt>;
/**
* Recalls a scheduled/delayed message based on the topic and recall handle.
* This operation requires server support and can only be performed before the message is delivered.
*
* @param topic - The topic associated with the scheduled message to be canceled.
* @param recallHandle - A unique handle to identify the message to recall (obtained from SendReceipt).
* @return Promise resolving to RecallReceipt containing the recalled message ID.
* @throws Error if producer is not running or recall handle is invalid.
*/
recallMessage(topic: string, recallHandle: string): Promise<RecallReceipt>;
}