NamingService (ans-sdk 1.0.1 API)

java.lang.Object
- com.alibaba.ans.core.NamingService

public class NamingService
extends Object

构造器概要

构造器
构造器和说明

NamingService()

构造器
构造器和说明
`NamingService()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static void`	`deRegDom(String serviceNames, String ip, int port, String cluster)` 注销IP
`static Set<String>`	`getDomsSubscribed()` 获取订阅的服务名
`static List<com.taobao.vipserver.client.core.Host>`	`getHosts(String dom)` 返回域名符合对应userId单元的所有有效（不包括健康但权重为0）Host列表。
`static List<com.taobao.vipserver.client.core.Host>`	`getHosts(String dom, String clusters)`
`static Set<String>`	`getPublishes()` 获取已发布的服务名
`static void`	`listen(String dom, com.taobao.vipserver.client.core.HostListener listener)` 监听一个域名Host变更，当Host变生变更时通知，并传入新的Host原生列表（未进行过滤操作，例如不会按权重将Host展开）
`static void`	`listen(String dom, String clusters, com.taobao.vipserver.client.core.HostListener listener)` 监听一个域名中所指定虚拟分组的Host变更，当Host变生变更时通知，并传入新的IP原生列表（未进行过滤操作，例如不会按权重将Host展开）
`static void`	`regDom(String serviceName, String ip, int port, float weight, String cluster)` 向ANS服务端注册服务，并且定时向服务端发送健康检查心跳。
`static void`	`regDom(String serviceName, String ip, int port, float weight, String cluster, List<com.taobao.vipserver.client.ipms.NodeReactor.Tag> tags)` 向ANS服务端注册服务，并且定时向服务端发送健康检查心跳。
`static void`	`setListenerExecutor(ExecutorService executor)`
`static com.taobao.vipserver.client.core.Host`	`srvHost(String dom)` 以轮询(RR)的方式返回域名的一个有效（不包括健康但权重为0）Host 返回结果受权重大小影响。
`static com.taobao.vipserver.client.core.Host`	`srvHost(String dom, String clusters)` 以轮询（RR）的方式返回域名对应clusters中的一个有效（不包括健康但权重为0）Host。
`static List<com.taobao.vipserver.client.core.Host>`	`srvHosts(String dom)` 返回域名所有有效（不包括健康但权重为0）Host列表。
`static List<com.taobao.vipserver.client.core.Host>`	`srvHosts(String dom, String clusters)` 返回域名指定clusters内的所有有效（不包括健康但权重为0）Host列表。
`static void`	`unlisten(String dom, com.taobao.vipserver.client.core.HostListener listener)`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - NamingService
```
public NamingService()
```
- 方法详细资料
  - srvHost
```
public static com.taobao.vipserver.client.core.Host srvHost(String dom)
                                                     throws Exception
```
    以轮询(RR)的方式返回域名的一个有效（不包括健康但权重为0）Host 返回结果受权重大小影响。注意：所有的错误将会以异常的形式给出
    
    参数:
    
    dom - 域名字符串，如"www.taobao.com"
    
    返回:
    
    一个Host对象，若想将 Host 转换成为 ip:port 的形式，可以使用 host#inetAddr()
    
    抛出:
    
    Exception - 找不到Host或者出现错误
  - srvHost
```
public static com.taobao.vipserver.client.core.Host srvHost(String dom,
                                                            String clusters)
                                                     throws Exception
```
    以轮询（RR）的方式返回域名对应clusters中的一个有效（不包括健康但权重为0）Host。返回结果受权重大小影响。注意：所有的错误将会以异常的形式给出
    
    参数:
    
    dom - 域名字符串，如"www.taobao.com"
    
    clusters - 指定的虚拟集群名称，可以是多个用英文逗号隔开，如 “http,tcp“
    
    返回:
    
    一个 Host 对象，若想将 Host 转换成为 ip:port 的形式，可以使用 host#inetAddr()
    
    抛出:
    
    Exception - 找不到Host或者出现错误
  - srvHosts
```
public static List<com.taobao.vipserver.client.core.Host> srvHosts(String dom)
                                                            throws Exception
```
    返回域名所有有效（不包括健康但权重为0）Host列表。注意：
    - 所有的错误将会以异常的形式给出
    - 这个接口会按weight对Host进行复制及过滤，weight如有小数则采用进一法归为自然数。
    参数:
    
    dom - 域名字符串，如"www.taobao.com"
    
    返回:
    
    一个 Host 对象列表，若想将 Host 转换成为 ip:port 的形式，可以使用 host#inetAddr()
    
    抛出:
    
    Exception - 操作失败
  - srvHosts
```
public static List<com.taobao.vipserver.client.core.Host> srvHosts(String dom,
                                                                   String clusters)
                                                            throws Exception
```
    返回域名指定clusters内的所有有效（不包括健康但权重为0）Host列表。注意：所有的错误将会以异常的形式给出这个接口会按weight对Host进行复制及过滤，weight如有小数则采用进一法归为自然数。
    
    参数:
    
    dom - 域名字符串，如"www.taobao.com"
    
    clusters - 指定的虚拟集群名称，可以是多个用英文逗号隔开，如 “http,tcp“
    
    返回:
    
    一个 Host 对象列表，若想将 Host 转换成为 ip:port 的形式，可以使用 host#inetAddr()
    
    抛出:
    
    Exception - 操作失败
  - getHosts
```
public static List<com.taobao.vipserver.client.core.Host> getHosts(String dom)
                                                            throws Exception
```
    返回域名符合对应userId单元的所有有效（不包括健康但权重为0）Host列表。
    注意：所有的错误将会以异常的形式给出这个接口不会按weight对Host进行复制及过滤，权重为0的也会返回，即服务端的原始数据
    
    参数:
    
    dom - 域名字符串，如"www.taobao.com"
    
    返回:
    
    一个 Host 对象列表，若想将 Host 转换成为 ip:port 的形式，可以使用 host#inetAddr()
    
    抛出:
    
    Exception - 操作失败
  - getHosts
```
public static List<com.taobao.vipserver.client.core.Host> getHosts(String dom,
                                                                   String clusters)
                                                            throws Exception
```
    抛出:
    
    Exception
  - listen
```
public static void listen(String dom,
                          com.taobao.vipserver.client.core.HostListener listener)
```
    监听一个域名Host变更，当Host变生变更时通知，并传入新的Host原生列表（未进行过滤操作，例如不会按权重将Host展开）
    
    参数:
    
    dom - 域名字符串，如"www.taobao.com"
    
    listener - 回调监听器
  - listen
```
public static void listen(String dom,
                          String clusters,
                          com.taobao.vipserver.client.core.HostListener listener)
```
    监听一个域名中所指定虚拟分组的Host变更，当Host变生变更时通知，并传入新的IP原生列表（未进行过滤操作，例如不会按权重将Host展开）
    
    参数:
    
    dom - 域名字符串，如"www.taobao.com"
    
    clusters - 虚拟集群列表，可以是多个，请使用英文逗号隔开，如：DEFAULT,TCP
    
    listener - 回调监听器
  - unlisten
```
public static void unlisten(String dom,
                            com.taobao.vipserver.client.core.HostListener listener)
```
  - regDom
```
public static void regDom(String serviceName,
                          String ip,
                          int port,
                          float weight,
                          String cluster)
                   throws Exception
```
    向ANS服务端注册服务，并且定时向服务端发送健康检查心跳。
    
    参数:
    
    serviceName - ANS服务名
    
    ip - 需要添加的IP，一般是本机IP
    
    port - 提供服务的端口
    
    weight - 本IP的权重
    
    cluster - 需要向哪个集群添加IP，如果没有自己配置特殊的集群，该字段可以为DEFAULT
    
    抛出:
    
    Exception - 操作失败
  - regDom
```
public static void regDom(String serviceName,
                          String ip,
                          int port,
                          float weight,
                          String cluster,
                          List<com.taobao.vipserver.client.ipms.NodeReactor.Tag> tags)
                   throws Exception
```
    向ANS服务端注册服务，并且定时向服务端发送健康检查心跳。
    
    参数:
    
    serviceName - ANS服务名
    
    ip - 需要添加的IP，一般是本机IP
    
    port - 提供服务的端口
    
    weight - 本IP的权重
    
    cluster - 需要向哪个集群添加IP，如果没有自己配置特殊的集群，该字段可以为DEFAULT
    
    tags - 该IP的标签
    
    抛出:
    
    Exception - 操作失败
  - deRegDom
```
public static void deRegDom(String serviceNames,
                            String ip,
                            int port,
                            String cluster)
                     throws Exception
```
    注销IP
    
    参数:
    
    serviceNames - 服务名列表
    
    ip - 服务ip
    
    port - 服务端口
    
    cluster - 该IP所属集群
    
    抛出:
    
    Exception - 失败抛异常
  - getPublishes
```
public static Set<String> getPublishes()
```
    获取已发布的服务名
    
    返回:
    
    已发布的服务名
  - getDomsSubscribed
```
public static Set<String> getDomsSubscribed()
```
    获取订阅的服务名
    
    返回:
    
    订阅的服务名
  - setListenerExecutor
```
public static void setListenerExecutor(ExecutorService executor)
```

类 NamingService

构造器概要

方法概要

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

构造器详细资料

NamingService

方法详细资料

srvHost

srvHost

srvHosts

srvHosts

getHosts

getHosts

listen

listen

unlisten

regDom

regDom

deRegDom

getPublishes

getDomsSubscribed

setListenerExecutor