com.alipay.sofa.runtime.api.client

Interface ServiceClient

All Known Implementing Classes:

ServiceClientImpl

public interface ServiceClient

This class is used to create a SOFA service. There are to ways to get an instance of this class in a Spring bean:

1. Get the instance of ClientFactory, then invoke ClientFactory.getClient(Class) to get the instance of this class.
2. Annotate a field of type ServiceClient with annotation SofaClientFactory.

Author:

xuanbei 18/2/28

Method Summary

Modifier and Type	Method and Description
void	removeService(Class<?> interfaceClass, int millisecondsToDelay) Equivalent to removeService(Class, String, int) except that the uniqueId parameter is default to an empty string.
void	removeService(Class<?> interfaceClass, String uniqueId, int millisecondsToDelay) Remove a service component from SOFA runtime.
void	service(ServiceParam serviceParam) Creating a SOFA service, sample usage:

Method Detail

service

void service(ServiceParam serviceParam)

Creating a SOFA service, sample usage:

 ServiceParam serviceParam = new ServiceParam();
 SampleService sampleService = new SampleServiceImpl();
 serviceParam.setInstance(sampleService);
 serviceClient.service(serviceParam);
 

Parameters:

serviceParam - The service parameter used to create a SOFA service.

removeService

void removeService(Class<?> interfaceClass,
                   int millisecondsToDelay)

Equivalent to removeService(Class, String, int) except that the uniqueId parameter is default to an empty string.

Parameters:

interfaceClass - the interface type to be removed

millisecondsToDelay - after the specified time, then service would be removed

removeService

void removeService(Class<?> interfaceClass,
                   String uniqueId,
                   int millisecondsToDelay)

Remove a service component from SOFA runtime.

Parameters:

interfaceClass - the interface type of the service component

uniqueId - the uniqueId of the service component

millisecondsToDelay - milliseconds to delay while remove a service component, only non-negative value is accepted. it is useful when remove a RPC service component since remove registry info from config server is a async-procedure