rocketmq-client-nodejs
Version:
RocketMQ Node.js Client
51 lines (50 loc) • 2.87 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 { AckMessageRequest, ChangeInvisibleDurationRequest, ReceiveMessageRequest } from '../../proto/apache/rocketmq/v2/service_pb';
import { MessageView } from '../message';
import { MessageQueue } from '../route';
import { BaseClient, BaseClientOptions } from '../client';
import { FilterExpression } from './FilterExpression';
export interface ConsumerOptions extends BaseClientOptions {
consumerGroup: string;
}
export declare abstract class Consumer extends BaseClient {
protected readonly consumerGroup: string;
constructor(options: ConsumerOptions);
protected wrapReceiveMessageRequest(batchSize: number, mq: MessageQueue, filterExpression: FilterExpression, invisibleDuration: number, longPollingTimeout: number): ReceiveMessageRequest;
protected receiveMessage(request: ReceiveMessageRequest, mq: MessageQueue, awaitDuration: number): Promise<MessageView[]>;
protected ackMessage(messageView: MessageView): Promise<import("../../proto/apache/rocketmq/v2/service_pb").AckMessageResultEntry.AsObject[]>;
protected invisibleDuration(messageView: MessageView, invisibleDuration: number): Promise<string>;
/**
* Expose public methods for ProcessQueue to access RPC operations
*/
ackMessageViaRpc(endpoints: any, request: AckMessageRequest, timeout: number): Promise<import("../../proto/apache/rocketmq/v2/service_pb").AckMessageResponse>;
changeInvisibleDurationViaRpc(endpoints: any, request: ChangeInvisibleDurationRequest, timeout: number): Promise<import("../../proto/apache/rocketmq/v2/service_pb").ChangeInvisibleDurationResponse>;
forwardMessageToDeadLetterQueueViaRpc(endpoints: any, request: any, timeout: number): Promise<import("../../proto/apache/rocketmq/v2/service_pb").ForwardMessageToDeadLetterQueueResponse>;
/**
* Get the consumer group name.
*
* @return Consumer group name
*/
getConsumerGroup(): string;
/**
* Check if this is a lite consumer.
*
* @return true if this is a LITE_PUSH_CONSUMER
*/
protected isLiteConsumer(): boolean;
}