org.apache.rocketmq.client.java.impl.ClientManager Maven / Gradle / Ivy
/*
* 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.
*/
package org.apache.rocketmq.client.java.impl;
import apache.rocketmq.v2.AckMessageRequest;
import apache.rocketmq.v2.AckMessageResponse;
import apache.rocketmq.v2.ChangeInvisibleDurationRequest;
import apache.rocketmq.v2.ChangeInvisibleDurationResponse;
import apache.rocketmq.v2.EndTransactionRequest;
import apache.rocketmq.v2.EndTransactionResponse;
import apache.rocketmq.v2.ForwardMessageToDeadLetterQueueRequest;
import apache.rocketmq.v2.ForwardMessageToDeadLetterQueueResponse;
import apache.rocketmq.v2.HeartbeatRequest;
import apache.rocketmq.v2.HeartbeatResponse;
import apache.rocketmq.v2.NotifyClientTerminationRequest;
import apache.rocketmq.v2.NotifyClientTerminationResponse;
import apache.rocketmq.v2.QueryAssignmentRequest;
import apache.rocketmq.v2.QueryAssignmentResponse;
import apache.rocketmq.v2.QueryRouteRequest;
import apache.rocketmq.v2.QueryRouteResponse;
import apache.rocketmq.v2.ReceiveMessageRequest;
import apache.rocketmq.v2.ReceiveMessageResponse;
import apache.rocketmq.v2.SendMessageRequest;
import apache.rocketmq.v2.SendMessageResponse;
import apache.rocketmq.v2.TelemetryCommand;
import org.apache.rocketmq.shaded.com.google.common.util.concurrent.AbstractIdleService;
import org.apache.rocketmq.shaded.com.google.common.util.concurrent.ListenableFuture;
import org.apache.rocketmq.shaded.io.grpc.Metadata;
import org.apache.rocketmq.shaded.io.grpc.stub.StreamObserver;
import java.time.Duration;
import java.util.Iterator;
import java.util.concurrent.ScheduledExecutorService;
import org.apache.rocketmq.client.apis.ClientException;
import org.apache.rocketmq.client.java.route.Endpoints;
import org.apache.rocketmq.client.java.rpc.RpcInvocation;
/**
* Client manager supplies a series of unified APIs to execute remote procedure calls for each {@link Client}.
*
* To manage lifecycle for client manager, {@link Client} must be registered before using client manager,
* once {@link Client} is shut down, it must be unregistered by the client manager. The client manager holds the
* connections and underlying threads, which are shared by all registered clients.
*/
public abstract class ClientManager extends AbstractIdleService {
/**
* Provide for the client to share the scheduler.
*
* @return shared scheduler.
*/
public abstract ScheduledExecutorService getScheduler();
/**
* Query topic route asynchronously, the method ensures no throwable.
*
* @param endpoints requested endpoints.
* @param metadata gRPC request header metadata.
* @param request query route request.
* @param duration request max duration.
* @return invocation of response future.
*/
public abstract ListenableFuture> queryRoute(Endpoints endpoints,
Metadata metadata, QueryRouteRequest request, Duration duration);
/**
* Heart beat asynchronously, the method ensures no throwable.
*
* @param endpoints requested endpoints.
* @param metadata gRPC request header metadata.
* @param request heartbeat request.
* @param duration request max duration.
* @return invocation of response future.
*/
public abstract ListenableFuture> heartbeat(Endpoints endpoints,
Metadata metadata, HeartbeatRequest request, Duration duration);
/**
* Send message asynchronously, the method ensures no throwable.
*
* @param endpoints requested endpoints.
* @param metadata gRPC request header metadata.
* @param request send message request.
* @param duration request max duration.
* @return invocation of response future.
*/
public abstract ListenableFuture> sendMessage(Endpoints endpoints,
Metadata metadata, SendMessageRequest request, Duration duration);
/**
* Query assignment asynchronously, the method ensures no throwable.
*
* @param endpoints requested endpoints.
* @param metadata gRPC request header metadata.
* @param request query assignment request.
* @param duration request max duration.
* @return invocation of response future.
*/
public abstract ListenableFuture> queryAssignment(Endpoints endpoints,
Metadata metadata, QueryAssignmentRequest request, Duration duration);
/**
* Receiving messages asynchronously from the server, the method ensures no throwable.
*
* @param endpoints requested endpoints.
* @param metadata gRPC request header metadata.
* @return invocation of response future.
*/
public abstract ListenableFuture>> receiveMessage(
Endpoints endpoints, Metadata metadata, ReceiveMessageRequest request, Duration duration);
/**
* Ack message asynchronously after the success of consumption, the method ensures no throwable.
*
* @param endpoints requested endpoints.
* @param metadata gRPC request header metadata.
* @param request ack message request.
* @param duration request max duration.
* @return invocation of response future.
*/
public abstract ListenableFuture> ackMessage(Endpoints endpoints,
Metadata metadata, AckMessageRequest request, Duration duration);
/**
* Nack message asynchronously after the failure of consumption, the method ensures no throwable.
*
* @param endpoints requested endpoints.
* @param metadata gRPC request header metadata.
* @param request nack message request.
* @param duration request max duration.
* @return invocation of response future.
*/
public abstract ListenableFuture> changeInvisibleDuration(
Endpoints endpoints, Metadata metadata, ChangeInvisibleDurationRequest request, Duration duration);
/**
* Send a message to the dead letter queue asynchronously, the method ensures no throwable.
*
* @param endpoints requested endpoints.
* @param metadata gRPC request header metadata.
* @param request request of sending a message to DLQ.
* @param duration request max duration.
* @return invocation of response future.
*/
public abstract ListenableFuture>
forwardMessageToDeadLetterQueue(Endpoints endpoints, Metadata metadata,
ForwardMessageToDeadLetterQueueRequest request, Duration duration);
/**
* Submit transaction resolution asynchronously, the method ensures no throwable.
*
* @param endpoints requested endpoints.
* @param metadata gRPC request header metadata.
* @param request end transaction request.
* @param duration request max duration.
* @return invocation of response future.
*/
public abstract ListenableFuture> endTransaction(Endpoints endpoints,
Metadata metadata, EndTransactionRequest request, Duration duration);
/**
* Asynchronously notify the server that client is terminated, the method ensures no throwable.
*
* @param endpoints request endpoints.
* @param metadata gRPC request header metadata.
* @param request notify client termination request.
* @param duration request max duration.
* @return response future of notification of client termination.
*/
@SuppressWarnings("UnusedReturnValue")
public abstract ListenableFuture> notifyClientTermination(
Endpoints endpoints, Metadata metadata, NotifyClientTerminationRequest request, Duration duration);
/**
* Establish telemetry session stream to server.
*
* @param endpoints request endpoints.
* @param metadata gRPC request header metadata.
* @param duration stream max duration.
* @param responseObserver response observer.
* @return request observer.
* @throws ClientException if failed to establish telemetry session stream.
*/
public abstract StreamObserver telemetry(Endpoints endpoints, Metadata metadata,
Duration duration, StreamObserver responseObserver) throws ClientException;
}