文档

常用数据结构接口

更新时间:
重要

本文中含有需要您注意的重要提示信息,忽略该信息可能对您的业务造成影响,请务必仔细阅读。

前言

本文档介绍HTTPDNS SDK内常用的数据结构及接口的定义。

HTTPDNSResult

域名解析返回的解析结果的数据类。

getHost

获取对应域名。

接口定义

String getHost()

所属类

HTTPDNSResult

返回说明

类型

说明

String

域名。

getIps

获取解析的IPv4地址。

接口定义

String[] getIps()

所属类

HTTPDNSResult

返回说明

类型

说明

String []

域名解析的IPv4地址。

getIpv6s

获取解析的IPv6地址。

接口定义

String[] getIpv6s()

所属类

HTTPDNSResult

返回说明

类型

说明

String []

域名解析的IPv6地址。

getExtras

获取解析的额外参数,只有自定义解析会有这部分数据。

接口定义

Map<String, String> getExtras()

所属类

HTTPDNSResult

返回说明

类型

说明

Map<String, String>

域名解析,后端返回的额外参数。

isExpired

解析结果是否已经过期,是否过期是根据解析结果获取时间和域名配置的TTL来计算。

接口定义

boolean isExpired()

所属类

HTTPDNSResult

返回说明

类型

说明

boolean

  • true,已经过期

  • false,未过期

HttpDnsCallback

异步域名解析接口和自定义域名解析接口中的回调接口。

onHttpDnsCompleted

解析结束后的回调函数,成功/失败都会回调该函数。

接口定义

void onHttpDnsCompleted(HTTPDNSResult result)

所属接口

HttpDnsCallback

参数说明

参数

类型

是否必填

说明

result

HTTPDNSResult

HTTPDNSResult

CacheTtlChanger

自定义域名解析结果TTL的接口。

changeCacheTtl

自定义TTL。

接口定义

int changeCacheTtl(String host, RequestIpType type, int ttl)

所属接口

CacheTtlChanger

参数说明

参数

类型

是否必填

说明

host

String

域名

type

RequestIpType

IP类型。

ttl

int

原始的ttl。

返回说明

类型

说明

int

自定义后的ttl,如果不需要自定义,请返回原始的ttl。

NotUseHttpDnsFilter

不使用HTTPDNS解析的域名过滤接口。

说明

2.4.0版本新增的接口。

notUseHttpDns

配置不使用HttpDns解析的域名。

接口定义

boolean notUseHttpDns(String host)

所属接口

NotUseHttpDnsFilter

参数说明

参数

类型

是否必填

说明

host

String

域名

返回说明

类型

说明

boolean

  • true,过滤当前域名,当前域名不走httpdns的云端解析。

  • false,不过滤当前域名,当前域名走httpdns的云端解析。

DegradationFilter

不使用HTTPDNS解析的域名过滤接口。

警告

2.4.0版本废弃了该接口,请使用NotUseHttpDnsFilter

shouldDegradeHttpDNS

配置不使用HttpDns解析的域名。

接口定义

boolean shouldDegradeHttpDNS(String host)

所属接口

DegradationFilter

参数说明

参数

类型

是否必填

说明

host

String

域名

返回说明

类型

说明

boolean

  • true,过滤当前域名,当前域名不走httpdns的云端解析。

  • false,不过滤当前域名,当前域名走httpdns的云端解析。

ILogger

日志接口。

log

日志方法。

接口定义

void log(String msg)

所属接口

ILogger

参数说明

参数

类型

是否必填

说明

msg

String

日志。

Region

枚举类型。

DEFAULT

中国内地,默认值。

HK

中国香港。

SG

新加坡。

DE

德国。

US

美国。