com.alibaba.nacos.client.naming.remote.gprc

类 NamingGrpcClientProxy

java.lang.Object

com.alibaba.nacos.common.notify.listener.Subscriber<ServerListChangedEvent>

com.alibaba.nacos.client.naming.remote.AbstractNamingClientProxy

com.alibaba.nacos.client.naming.remote.gprc.NamingGrpcClientProxy

所有已实现的接口:

NamingClientProxy, Closeable

public class NamingGrpcClientProxy
extends AbstractNamingClientProxy

Naming grpc client proxy.

作者:

xiweng.yy

构造器概要

构造器

构造器和说明
NamingGrpcClientProxy(String namespaceId, SecurityProxy securityProxy, ServerListFactory serverListFactory, NacosClientProperties properties, ServiceInfoHolder serviceInfoHolder)

方法概要

限定符和类型	方法和说明
void	batchDeregisterService(String serviceName, String groupName, List<Instance> instances) Batch deRegister instance to service with specified instance properties.
void	batchRegisterService(String serviceName, String groupName, List<Instance> instances) Batch register instance to service with specified instance properties.
void	createService(Service service, AbstractSelector selector) Create service.
boolean	deleteService(String serviceName, String groupName) Delete service.
void	deregisterService(String serviceName, String groupName, Instance instance) Deregister instance from a service.
void	doBatchRegisterService(String serviceName, String groupName, List<Instance> instances) Execute batch register operation.
void	doDeregisterService(String serviceName, String groupName, Instance instance) Execute deregister operation.
void	doDeregisterServiceForPersistent(String serviceName, String groupName, Instance instance) Execute deregister operation for persistent instance.
void	doRegisterService(String serviceName, String groupName, Instance instance) Execute register operation.
void	doRegisterServiceForPersistent(String serviceName, String groupName, Instance instance) Execute register operation for persistent instance.
ServiceInfo	doSubscribe(String serviceName, String groupName, String clusters) Execute subscribe operation.
void	doUnsubscribe(String serviceName, String groupName, String clusters) Execute unsubscribe operation.
ListView<String>	getServiceList(int pageNo, int pageSize, String groupName, AbstractSelector selector) Get service list.
boolean	isAbilitySupportedByServer(AbilityKey abilityKey) Determine whether nacos-server supports the capability.
boolean	isEnable()
boolean	isSubscribed(String serviceName, String groupName, String clusters) Judge whether service has been subscribed.
void	onEvent(ServerListChangedEvent event)
ServiceInfo	queryInstancesOfService(String serviceName, String groupName, String clusters, boolean healthyOnly) Query instance list.
Service	queryService(String serviceName, String groupName) Query Service.
void	registerService(String serviceName, String groupName, Instance instance) Register an instance to service with specified instance properties.
boolean	serverHealthy() Check Server healthy.
void	shutdown()
ServiceInfo	subscribe(String serviceName, String groupName, String clusters) Subscribe service.
Class<? extends Event>	subscribeType()
void	unsubscribe(String serviceName, String groupName, String clusters) Unsubscribe service.
void	updateInstance(String serviceName, String groupName, Instance instance) Update instance to service.
void	updateService(Service service, AbstractSelector selector) Update service.

从类继承的方法 com.alibaba.nacos.client.naming.remote.AbstractNamingClientProxy

getAppHeaders, getSecurityHeaders

从类继承的方法 com.alibaba.nacos.common.notify.listener.Subscriber

executor, ignoreExpireEvent, scopeMatches

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

NamingGrpcClientProxy

public NamingGrpcClientProxy(String namespaceId,
                             SecurityProxy securityProxy,
                             ServerListFactory serverListFactory,
                             NacosClientProperties properties,
                             ServiceInfoHolder serviceInfoHolder)
                      throws NacosException

抛出:

NacosException

方法详细资料

onEvent

public void onEvent(ServerListChangedEvent event)

指定者:

onEvent 在类中 Subscriber<ServerListChangedEvent>

subscribeType

public Class<? extends Event> subscribeType()

指定者:

subscribeType 在类中 Subscriber<ServerListChangedEvent>

registerService

public void registerService(String serviceName,
                            String groupName,
                            Instance instance)
                     throws NacosException

从接口复制的说明: NamingClientProxy

Register an instance to service with specified instance properties.

参数:

serviceName - name of service

groupName - group of service

instance - instance to register

抛出:

NacosException - nacos exception

batchRegisterService

public void batchRegisterService(String serviceName,
                                 String groupName,
                                 List<Instance> instances)
                          throws NacosException

从接口复制的说明: NamingClientProxy

Batch register instance to service with specified instance properties.

参数:

serviceName - service name

groupName - group name

instances - instance

抛出:

NacosException - nacos exception

batchDeregisterService

public void batchDeregisterService(String serviceName,
                                   String groupName,
                                   List<Instance> instances)
                            throws NacosException

从接口复制的说明: NamingClientProxy

Batch deRegister instance to service with specified instance properties.

参数:

serviceName - service name

groupName - group name

instances - deRegister instance

抛出:

NacosException - nacos exception

doBatchRegisterService

public void doBatchRegisterService(String serviceName,
                                   String groupName,
                                   List<Instance> instances)
                            throws NacosException

Execute batch register operation.

参数:

serviceName - service name

groupName - group name

instances - instances

抛出:

NacosException - NacosException

doRegisterService

public void doRegisterService(String serviceName,
                              String groupName,
                              Instance instance)
                       throws NacosException

Execute register operation.

参数:

serviceName - name of service

groupName - group of service

instance - instance to register

抛出:

NacosException - nacos exception

doRegisterServiceForPersistent

public void doRegisterServiceForPersistent(String serviceName,
                                           String groupName,
                                           Instance instance)
                                    throws NacosException

Execute register operation for persistent instance.

参数:

serviceName - name of service

groupName - group of service

instance - instance to register

抛出:

NacosException - nacos exception

deregisterService

public void deregisterService(String serviceName,
                              String groupName,
                              Instance instance)
                       throws NacosException

从接口复制的说明: NamingClientProxy

Deregister instance from a service.

参数:

serviceName - name of service

groupName - group name

instance - instance

抛出:

NacosException - nacos exception

doDeregisterService

public void doDeregisterService(String serviceName,
                                String groupName,
                                Instance instance)
                         throws NacosException

Execute deregister operation.

参数:

serviceName - service name

groupName - group name

instance - instance

抛出:

NacosException - nacos exception

doDeregisterServiceForPersistent

public void doDeregisterServiceForPersistent(String serviceName,
                                             String groupName,
                                             Instance instance)
                                      throws NacosException

Execute deregister operation for persistent instance.

参数:

serviceName - service name

groupName - group name

instance - instance

抛出:

NacosException - nacos exception

updateInstance

public void updateInstance(String serviceName,
                           String groupName,
                           Instance instance)
                    throws NacosException

从接口复制的说明: NamingClientProxy

Update instance to service.

参数:

serviceName - service name

groupName - group name

instance - instance

抛出:

NacosException - nacos exception

queryInstancesOfService

public ServiceInfo queryInstancesOfService(String serviceName,
                                           String groupName,
                                           String clusters,
                                           boolean healthyOnly)
                                    throws NacosException

从接口复制的说明: NamingClientProxy

Query instance list.

参数:

serviceName - service name

groupName - group name

clusters - clusters

healthyOnly - healthy only

返回:

service info

抛出:

NacosException - nacos exception

queryService

public Service queryService(String serviceName,
                            String groupName)
                     throws NacosException

从接口复制的说明: NamingClientProxy

Query Service.

参数:

serviceName - service name

groupName - group name

返回:

service

抛出:

NacosException - nacos exception

createService

public void createService(Service service,
                          AbstractSelector selector)
                   throws NacosException

从接口复制的说明: NamingClientProxy

Create service.

参数:

service - service

selector - selector

抛出:

NacosException - nacos exception

deleteService

public boolean deleteService(String serviceName,
                             String groupName)
                      throws NacosException

从接口复制的说明: NamingClientProxy

Delete service.

参数:

serviceName - service name

groupName - group name

返回:

true if delete ok

抛出:

NacosException - nacos exception

updateService

public void updateService(Service service,
                          AbstractSelector selector)
                   throws NacosException

从接口复制的说明: NamingClientProxy

Update service.

参数:

service - service

selector - selector

抛出:

NacosException - nacos exception

getServiceList

public ListView<String> getServiceList(int pageNo,
                                       int pageSize,
                                       String groupName,
                                       AbstractSelector selector)
                                throws NacosException

从接口复制的说明: NamingClientProxy

Get service list.

参数:

pageNo - page number

pageSize - size per page

groupName - group name of service

selector - selector

返回:

list of service

抛出:

NacosException - nacos exception

subscribe

public ServiceInfo subscribe(String serviceName,
                             String groupName,
                             String clusters)
                      throws NacosException

从接口复制的说明: NamingClientProxy

Subscribe service.

参数:

serviceName - service name

groupName - group name

clusters - clusters, current only support subscribe all clusters, maybe deprecated

返回:

current service info of subscribe service

抛出:

NacosException - nacos exception

doSubscribe

public ServiceInfo doSubscribe(String serviceName,
                               String groupName,
                               String clusters)
                        throws NacosException

Execute subscribe operation.

参数:

serviceName - service name

groupName - group name

clusters - clusters, current only support subscribe all clusters, maybe deprecated

返回:

current service info of subscribe service

抛出:

NacosException - nacos exception

unsubscribe

public void unsubscribe(String serviceName,
                        String groupName,
                        String clusters)
                 throws NacosException

从接口复制的说明: NamingClientProxy

Unsubscribe service.

参数:

serviceName - service name

groupName - group name

clusters - clusters, current only support subscribe all clusters, maybe deprecated

抛出:

NacosException - nacos exception

isSubscribed

public boolean isSubscribed(String serviceName,
                            String groupName,
                            String clusters)
                     throws NacosException

从接口复制的说明: NamingClientProxy

Judge whether service has been subscribed.

参数:

serviceName - service name

groupName - group name

clusters - clusters, current only support subscribe all clusters, maybe deprecated

返回:

true if subscribed, otherwise false

抛出:

NacosException - nacos exception

doUnsubscribe

public void doUnsubscribe(String serviceName,
                          String groupName,
                          String clusters)
                   throws NacosException

Execute unsubscribe operation.

参数:

serviceName - service name

groupName - group name

clusters - clusters, current only support subscribe all clusters, maybe deprecated

抛出:

NacosException - nacos exception

serverHealthy

public boolean serverHealthy()

从接口复制的说明: NamingClientProxy

Check Server healthy.

返回:

true if server is healthy

isAbilitySupportedByServer

public boolean isAbilitySupportedByServer(AbilityKey abilityKey)

Determine whether nacos-server supports the capability.

参数:

abilityKey - ability key

返回:

true if supported, otherwise false

shutdown

public void shutdown()
              throws NacosException

抛出:

NacosException

isEnable

public boolean isEnable()