程序包 com.alibaba.nacos.client.naming.remote

接口 NamingClientProxy

所有超级接口:

com.alibaba.nacos.common.lifecycle.Closeable

所有已知实现类:

AbstractNamingClientProxy, NamingClientProxyDelegate, NamingGrpcClientProxy, NamingHttpClientProxy

public interface NamingClientProxy
extends com.alibaba.nacos.common.lifecycle.Closeable

Naming Client Proxy.

作者:

xiweng.yy

方法概要

修饰符和类型	方法	说明
void	batchRegisterService(java.lang.String serviceName, java.lang.String groupName, java.util.List<com.alibaba.nacos.api.naming.pojo.Instance> instances)	Batch register instance to service with specified instance properties.
void	createService(com.alibaba.nacos.api.naming.pojo.Service service, com.alibaba.nacos.api.selector.AbstractSelector selector)	Create service.
boolean	deleteService(java.lang.String serviceName, java.lang.String groupName)	Delete service.
void	deregisterService(java.lang.String serviceName, java.lang.String groupName, com.alibaba.nacos.api.naming.pojo.Instance instance)	Deregister instance from a service.
com.alibaba.nacos.api.naming.pojo.ListView<java.lang.String>	getServiceList(int pageNo, int pageSize, java.lang.String groupName, com.alibaba.nacos.api.selector.AbstractSelector selector)	Get service list.
boolean	isSubscribed(java.lang.String serviceName, java.lang.String groupName, java.lang.String clusters)	Judge whether service has been subscribed.
com.alibaba.nacos.api.naming.pojo.ServiceInfo	queryInstancesOfService(java.lang.String serviceName, java.lang.String groupName, java.lang.String clusters, int udpPort, boolean healthyOnly)	Query instance list.
com.alibaba.nacos.api.naming.pojo.Service	queryService(java.lang.String serviceName, java.lang.String groupName)	Query Service.
void	registerService(java.lang.String serviceName, java.lang.String groupName, com.alibaba.nacos.api.naming.pojo.Instance instance)	Register a instance to service with specified instance properties.
boolean	serverHealthy()	Check Server healthy.
com.alibaba.nacos.api.naming.pojo.ServiceInfo	subscribe(java.lang.String serviceName, java.lang.String groupName, java.lang.String clusters)	Subscribe service.
void	unsubscribe(java.lang.String serviceName, java.lang.String groupName, java.lang.String clusters)	Unsubscribe service.
void	updateBeatInfo(java.util.Set<com.alibaba.nacos.api.naming.pojo.Instance> modifiedInstances)	Update beat info.
void	updateInstance(java.lang.String serviceName, java.lang.String groupName, com.alibaba.nacos.api.naming.pojo.Instance instance)	Update instance to service.
void	updateService(com.alibaba.nacos.api.naming.pojo.Service service, com.alibaba.nacos.api.selector.AbstractSelector selector)	Update service.

从接口继承的方法 com.alibaba.nacos.common.lifecycle.Closeable

shutdown

方法详细资料

registerService

void registerService(java.lang.String serviceName,
                     java.lang.String groupName,
                     com.alibaba.nacos.api.naming.pojo.Instance instance)
              throws com.alibaba.nacos.api.exception.NacosException

Register a instance to service with specified instance properties.

参数:

serviceName - name of service

groupName - group of service

instance - instance to register

抛出:

com.alibaba.nacos.api.exception.NacosException - nacos exception

batchRegisterService

void batchRegisterService(java.lang.String serviceName,
                          java.lang.String groupName,
                          java.util.List<com.alibaba.nacos.api.naming.pojo.Instance> instances)
                   throws com.alibaba.nacos.api.exception.NacosException

Batch register instance to service with specified instance properties.

参数:

serviceName - service name

groupName - group name

instances - instance

抛出:

com.alibaba.nacos.api.exception.NacosException - nacos exception

从以下版本开始:

2.1.1

deregisterService

void deregisterService(java.lang.String serviceName,
                       java.lang.String groupName,
                       com.alibaba.nacos.api.naming.pojo.Instance instance)
                throws com.alibaba.nacos.api.exception.NacosException

Deregister instance from a service.

参数:

serviceName - name of service

groupName - group name

instance - instance

抛出:

com.alibaba.nacos.api.exception.NacosException - nacos exception

updateInstance

void updateInstance(java.lang.String serviceName,
                    java.lang.String groupName,
                    com.alibaba.nacos.api.naming.pojo.Instance instance)
             throws com.alibaba.nacos.api.exception.NacosException

Update instance to service.

参数:

serviceName - service name

groupName - group name

instance - instance

抛出:

com.alibaba.nacos.api.exception.NacosException - nacos exception

queryInstancesOfService

com.alibaba.nacos.api.naming.pojo.ServiceInfo queryInstancesOfService(java.lang.String serviceName,
                                                                      java.lang.String groupName,
                                                                      java.lang.String clusters,
                                                                      int udpPort,
                                                                      boolean healthyOnly)
                                                               throws com.alibaba.nacos.api.exception.NacosException

Query instance list.

参数:

serviceName - service name

groupName - group name

clusters - clusters

udpPort - udp port

healthyOnly - healthy only

返回:

service info

抛出:

com.alibaba.nacos.api.exception.NacosException - nacos exception

queryService

com.alibaba.nacos.api.naming.pojo.Service queryService(java.lang.String serviceName,
                                                       java.lang.String groupName)
                                                throws com.alibaba.nacos.api.exception.NacosException

Query Service.

参数:

serviceName - service name

groupName - group name

返回:

service

抛出:

com.alibaba.nacos.api.exception.NacosException - nacos exception

createService

void createService(com.alibaba.nacos.api.naming.pojo.Service service,
                   com.alibaba.nacos.api.selector.AbstractSelector selector)
            throws com.alibaba.nacos.api.exception.NacosException

Create service.

参数:

service - service

selector - selector

抛出:

com.alibaba.nacos.api.exception.NacosException - nacos exception

deleteService

boolean deleteService(java.lang.String serviceName,
                      java.lang.String groupName)
               throws com.alibaba.nacos.api.exception.NacosException

Delete service.

参数:

serviceName - service name

groupName - group name

返回:

true if delete ok

抛出:

com.alibaba.nacos.api.exception.NacosException - nacos exception

updateService

void updateService(com.alibaba.nacos.api.naming.pojo.Service service,
                   com.alibaba.nacos.api.selector.AbstractSelector selector)
            throws com.alibaba.nacos.api.exception.NacosException

Update service.

参数:

service - service

selector - selector

抛出:

com.alibaba.nacos.api.exception.NacosException - nacos exception

getServiceList

com.alibaba.nacos.api.naming.pojo.ListView<java.lang.String> getServiceList(int pageNo,
                                                                            int pageSize,
                                                                            java.lang.String groupName,
                                                                            com.alibaba.nacos.api.selector.AbstractSelector selector)
                                                                     throws com.alibaba.nacos.api.exception.NacosException

Get service list.

参数:

pageNo - page number

pageSize - size per page

groupName - group name of service

selector - selector

返回:

list of service

抛出:

com.alibaba.nacos.api.exception.NacosException - nacos exception

subscribe

com.alibaba.nacos.api.naming.pojo.ServiceInfo subscribe(java.lang.String serviceName,
                                                        java.lang.String groupName,
                                                        java.lang.String clusters)
                                                 throws com.alibaba.nacos.api.exception.NacosException

Subscribe service.

参数:

serviceName - service name

groupName - group name

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

返回:

current service info of subscribe service

抛出:

com.alibaba.nacos.api.exception.NacosException - nacos exception

unsubscribe

void unsubscribe(java.lang.String serviceName,
                 java.lang.String groupName,
                 java.lang.String clusters)
          throws com.alibaba.nacos.api.exception.NacosException

Unsubscribe service.

参数:

serviceName - service name

groupName - group name

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

抛出:

com.alibaba.nacos.api.exception.NacosException - nacos exception

isSubscribed

boolean isSubscribed(java.lang.String serviceName,
                     java.lang.String groupName,
                     java.lang.String clusters)
              throws com.alibaba.nacos.api.exception.NacosException

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

抛出:

com.alibaba.nacos.api.exception.NacosException - nacos exception

updateBeatInfo

void updateBeatInfo(java.util.Set<com.alibaba.nacos.api.naming.pojo.Instance> modifiedInstances)

Update beat info.

参数:

modifiedInstances - modified instances

serverHealthy

boolean serverHealthy()

Check Server healthy.

返回:

true if server is healthy