Files
okhttp/3.x/okhttp-dnsoverhttps/okhttp3/dnsoverhttps/DnsOverHttps.html

422 lines
16 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Mar 14 00:10:07 EDT 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DnsOverHttps (OkHttp DNS over HTTPS 3.14.0 API)</title>
<meta name="date" content="2019-03-14">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
<link rel="canonical" href="https://square.github.io/okhttp/4.x/okhttp-dnsoverhttps/okhttp3.dnsoverhttps/-dns-over-https/"/>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DnsOverHttps (OkHttp DNS over HTTPS 3.14.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../okhttp3/dnsoverhttps/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DnsOverHttps.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../okhttp3/dnsoverhttps/DnsOverHttps.Builder.html" title="class in okhttp3.dnsoverhttps"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?okhttp3/dnsoverhttps/DnsOverHttps.html" target="_top">Frames</a></li>
<li><a href="DnsOverHttps.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">okhttp3.dnsoverhttps</div>
<h2 title="Class DnsOverHttps" class="title">Class DnsOverHttps</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>okhttp3.dnsoverhttps.DnsOverHttps</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://github.com/square/okhttp/okhttp/apidocs/okhttp3/Dns.html?is-external=true" title="class or interface in okhttp3">Dns</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">DnsOverHttps</span>
extends java.lang.Object
implements <a href="https://github.com/square/okhttp/okhttp/apidocs/okhttp3/Dns.html?is-external=true" title="class or interface in okhttp3">Dns</a></pre>
<div class="block">DNS over HTTPS implementation.
Implementation of https://tools.ietf.org/html/draft-ietf-doh-dns-over-https-13
<blockquote>A DNS API client encodes a single DNS query into an HTTP request
using either the HTTP GET or POST method and the other requirements
of this section. The DNS API server defines the URI used by the
request through the use of a URI Template.</blockquote>
<h3>Warning: This is a non-final API.</h3>
<p><strong>As of OkHttp 3.11, this feature is an unstable preview: the API is subject to change,
and the implementation is incomplete. We expect that OkHttp 3.12 or 3.13 will finalize this API.
Until then, expect API and behavior changes when you update your OkHttp dependency.</strong></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../okhttp3/dnsoverhttps/DnsOverHttps.Builder.html" title="class in okhttp3.dnsoverhttps">DnsOverHttps.Builder</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://github.com/square/okhttp/okhttp/apidocs/okhttp3/MediaType.html?is-external=true" title="class or interface in okhttp3">MediaType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../okhttp3/dnsoverhttps/DnsOverHttps.html#DNS_MESSAGE">DNS_MESSAGE</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../okhttp3/dnsoverhttps/DnsOverHttps.html#MAX_RESPONSE_SIZE">MAX_RESPONSE_SIZE</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.okhttp3.Dns">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;okhttp3.<a href="https://github.com/square/okhttp/okhttp/apidocs/okhttp3/Dns.html?is-external=true" title="class or interface in okhttp3">Dns</a></h3>
<code><a href="https://github.com/square/okhttp/okhttp/apidocs/okhttp3/Dns.html?is-external=true#SYSTEM" title="class or interface in okhttp3">SYSTEM</a></code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="https://github.com/square/okhttp/okhttp/apidocs/okhttp3/OkHttpClient.html?is-external=true" title="class or interface in okhttp3">OkHttpClient</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../okhttp3/dnsoverhttps/DnsOverHttps.html#client--">client</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../okhttp3/dnsoverhttps/DnsOverHttps.html#includeIPv6--">includeIPv6</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.List&lt;java.net.InetAddress&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../okhttp3/dnsoverhttps/DnsOverHttps.html#lookup-java.lang.String-">lookup</a></span>(java.lang.String&nbsp;hostname)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../okhttp3/dnsoverhttps/DnsOverHttps.html#post--">post</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../okhttp3/dnsoverhttps/DnsOverHttps.html#resolvePrivateAddresses--">resolvePrivateAddresses</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../okhttp3/dnsoverhttps/DnsOverHttps.html#resolvePublicAddresses--">resolvePublicAddresses</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://github.com/square/okhttp/okhttp/apidocs/okhttp3/HttpUrl.html?is-external=true" title="class or interface in okhttp3">HttpUrl</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../okhttp3/dnsoverhttps/DnsOverHttps.html#url--">url</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DNS_MESSAGE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DNS_MESSAGE</h4>
<pre>public static final&nbsp;<a href="https://github.com/square/okhttp/okhttp/apidocs/okhttp3/MediaType.html?is-external=true" title="class or interface in okhttp3">MediaType</a> DNS_MESSAGE</pre>
</li>
</ul>
<a name="MAX_RESPONSE_SIZE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MAX_RESPONSE_SIZE</h4>
<pre>public static final&nbsp;int MAX_RESPONSE_SIZE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#okhttp3.dnsoverhttps.DnsOverHttps.MAX_RESPONSE_SIZE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="url--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>url</h4>
<pre>public&nbsp;<a href="https://github.com/square/okhttp/okhttp/apidocs/okhttp3/HttpUrl.html?is-external=true" title="class or interface in okhttp3">HttpUrl</a>&nbsp;url()</pre>
</li>
</ul>
<a name="post--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>post</h4>
<pre>public&nbsp;boolean&nbsp;post()</pre>
</li>
</ul>
<a name="includeIPv6--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>includeIPv6</h4>
<pre>public&nbsp;boolean&nbsp;includeIPv6()</pre>
</li>
</ul>
<a name="client--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>client</h4>
<pre>public&nbsp;<a href="https://github.com/square/okhttp/okhttp/apidocs/okhttp3/OkHttpClient.html?is-external=true" title="class or interface in okhttp3">OkHttpClient</a>&nbsp;client()</pre>
</li>
</ul>
<a name="resolvePrivateAddresses--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resolvePrivateAddresses</h4>
<pre>public&nbsp;boolean&nbsp;resolvePrivateAddresses()</pre>
</li>
</ul>
<a name="resolvePublicAddresses--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resolvePublicAddresses</h4>
<pre>public&nbsp;boolean&nbsp;resolvePublicAddresses()</pre>
</li>
</ul>
<a name="lookup-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>lookup</h4>
<pre>public&nbsp;java.util.List&lt;java.net.InetAddress&gt;&nbsp;lookup(java.lang.String&nbsp;hostname)
throws java.net.UnknownHostException</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://github.com/square/okhttp/okhttp/apidocs/okhttp3/Dns.html?is-external=true#lookup-java.lang.String-" title="class or interface in okhttp3">lookup</a></code>&nbsp;in interface&nbsp;<code><a href="https://github.com/square/okhttp/okhttp/apidocs/okhttp3/Dns.html?is-external=true" title="class or interface in okhttp3">Dns</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.net.UnknownHostException</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../okhttp3/dnsoverhttps/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DnsOverHttps.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../okhttp3/dnsoverhttps/DnsOverHttps.Builder.html" title="class in okhttp3.dnsoverhttps"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?okhttp3/dnsoverhttps/DnsOverHttps.html" target="_top">Frames</a></li>
<li><a href="DnsOverHttps.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2019. All Rights Reserved.</small></p>
</body>
</html>