org.redisson.api.RRemoteService Maven / Gradle / Ivy
Show all versions of redisson-all Show documentation
/**
* Copyright (c) 2013-2024 Nikita Koksharov
*
* Licensed 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.redisson.api;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.TimeUnit;
/**
* Allows to execute object methods remotely between Redisson instances (Server side and Client side instances in terms of remote invocation).
*
* 1. Server side instance (worker instance). Register object with RRemoteService instance.
*
*
* RRemoteService remoteService = redisson.getRemoteService();
*
* // register remote service before any remote invocation
* remoteService.register(SomeServiceInterface.class, someServiceImpl);
*
*
* 2. Client side instance. Invokes method remotely.
*
*
* RRemoteService remoteService = redisson.getRemoteService();
* SomeServiceInterface service = remoteService.get(SomeServiceInterface.class);
*
* String result = service.doSomeStuff(1L, "secondParam", new AnyParam());
*
*
* There are two timeouts during execution:
*
* Acknowledge (Ack) timeout.Client side instance waits for acknowledge message from Server side instance.
*
* If acknowledge has not been received by Client side instance then RemoteServiceAckTimeoutException will be thrown.
* And next invocation attempt can be made.
*
* If acknowledge has not been received Client side instance but Server side instance has received invocation message already.
* In this case invocation will be skipped, due to ack timeout checking by Server side instance.
*
* Execution timeout. Client side instance received acknowledge message. If it hasn't received any result or error
* from server side during execution timeout then RemoteServiceTimeoutException will be thrown.
*
* @author Nikita Koksharov
*
*/
public interface RRemoteService {
/**
* Returns free workers amount available for invocations
*
* @param remoteInterface - remote service interface
* @return workers amount
*/
int getFreeWorkers(Class remoteInterface);
/**
* Returns pending invocations amount for handling in free workers.
*
* @param remoteInterface - remote service interface
* @return invocations amount
*/
int getPendingInvocations(Class remoteInterface);
/**
* Returns pending invocations amount for handling in free workers.
*
* @param remoteInterface - remote service interface
* @return invocations amount
*/
RFuture getPendingInvocationsAsync(Class remoteInterface);
/**
* Register remote service with single worker
*
* @param type of remote service
* @param remoteInterface - remote service interface
* @param object - remote service object
*/
void register(Class remoteInterface, T object);
/**
* Register remote service with custom workers amount
*
* @param type of remote service
* @param remoteInterface - remote service interface
* @param object - remote service object
* @param workersAmount - workers amount
*/
void register(Class remoteInterface, T object, int workersAmount);
/**
* Register remote service with custom workers amount
* and executor for running them
*
* @param type of remote service
* @param remoteInterface - remote service interface
* @param object - remote service object
* @param workers - workers amount
* @param executor - executor service used to invoke methods
*/
void register(Class remoteInterface, T object, int workers, ExecutorService executor);
/**
* Deregister all workers for remote service
*
* @param type of remote service
* @param remoteInterface - remote service interface
*/
void deregister(Class remoteInterface);
/**
* Tries to execute one awaiting remote request.
* Waits up to timeout if necessary until remote request became available.
*
* @param remoteInterface - remote service interface
* @param object - remote service object
* @param timeout - maximum wait time until remote request became available
* @param timeUnit - time unit
* @param - type of remote service
* @return true if method was successfully executed and
* false if timeout reached before execution
* @throws InterruptedException - if the thread is interrupted
*/
boolean tryExecute(Class remoteInterface, T object, long timeout, TimeUnit timeUnit) throws InterruptedException;
/**
* Tries to execute one awaiting remote request.
* Waits up to timeout if necessary until remote request became available.
*
* @param remoteInterface - remote service interface
* @param object - remote service object
* @param timeout - maximum wait time until remote request became available
* @param timeUnit - time unit
* @param executorService - executor service used to invoke methods
* @param - type of remote service
* @return true if method was successfully executed and
* false if timeout reached before execution
* @throws InterruptedException - if the thread is interrupted
*/
boolean tryExecute(Class remoteInterface, T object, ExecutorService executorService, long timeout, TimeUnit timeUnit) throws InterruptedException;
/**
* Tries to execute one awaiting remote request.
*
* @param remoteInterface - remote service interface
* @param object - remote service object
* @param - type of remote service
* @return true if method was successfully executed and
* false if timeout reached before execution
*/
RFuture tryExecuteAsync(Class remoteInterface, T object);
/**
* Tries to execute one awaiting remote request.
* Waits up to timeout if necessary until remote request became available.
*
* @param remoteInterface - remote service interface
* @param object - remote service object
* @param timeout - maximum wait time until remote request became available
* @param timeUnit - time unit
* @param - type of remote service
* @return true if method was successfully executed and
* false if timeout reached before execution
*/
RFuture tryExecuteAsync(Class remoteInterface, T object, long timeout, TimeUnit timeUnit);
/**
* Tries to execute one awaiting remote request.
* Waits up to timeout if necessary until remote request became available.
*
* @param remoteInterface - remote service interface
* @param object - remote service object
* @param timeout - maximum wait time until remote request became available
* @param timeUnit - time unit
* @param executorService - executor service used to invoke methods
* @param - type of remote service
* @return true if method was successfully executed and
* false if timeout reached before execution
*/
RFuture tryExecuteAsync(Class remoteInterface, T object, ExecutorService executorService, long timeout, TimeUnit timeUnit);
/**
* Get remote service object for remote invocations.
*
* This method is a shortcut for
*
* get(remoteInterface, RemoteInvocationOptions.defaults())
*
*
* @see RemoteInvocationOptions#defaults()
* @see #get(Class, RemoteInvocationOptions)
*
* @param type of remote service
* @param remoteInterface - remote service interface
* @return remote service instance
*/
T get(Class remoteInterface);
/**
* Get remote service object for remote invocations
* with specified invocation timeout.
*
* This method is a shortcut for
*
* get(remoteInterface, RemoteInvocationOptions.defaults()
* .expectResultWithin(executionTimeout, executionTimeUnit))
*
*
* @see RemoteInvocationOptions#defaults()
* @see #get(Class, RemoteInvocationOptions)
*
* @param type of remote service
* @param remoteInterface - remote service interface
* @param executionTimeout - invocation timeout
* @param executionTimeUnit - time unit
* @return remote service instance
*/
T get(Class remoteInterface, long executionTimeout, TimeUnit executionTimeUnit);
/**
* Get remote service object for remote invocations
* with specified invocation and ack timeouts
*
* This method is a shortcut for
*
* get(remoteInterface, RemoteInvocationOptions.defaults()
* .expectAckWithin(ackTimeout, ackTimeUnit)
* .expectResultWithin(executionTimeout, executionTimeUnit))
*
*
* @see RemoteInvocationOptions
* @see #get(Class, RemoteInvocationOptions)
*
* @param type of remote service
* @param remoteInterface - remote service interface
* @param executionTimeout - invocation timeout
* @param executionTimeUnit - time unit
* @param ackTimeout - ack timeout
* @param ackTimeUnit - time unit
* @return remote service object
*/
T get(Class remoteInterface, long executionTimeout, TimeUnit executionTimeUnit, long ackTimeout, TimeUnit ackTimeUnit);
/**
* Get remote service object for remote invocations
* with the specified options
*
* Note that when using the noResult() option,
* it is expected that the invoked method returns void,
* or else IllegalArgumentException will be thrown.
*
* @see RemoteInvocationOptions
*
* @param type of remote service
* @param remoteInterface - remote service interface
* @param options - service options
* @return remote service object
*/
T get(Class remoteInterface, RemoteInvocationOptions options);
}