2016-01-07 17:49:15 +01:00
|
|
|
/*
|
|
|
|
* Copyright 2016 The Netty Project
|
|
|
|
*
|
|
|
|
* The Netty Project licenses this file to you under the Apache License,
|
|
|
|
* version 2.0 (the "License"); you may not use this file except in compliance
|
|
|
|
* with the License. You may obtain a copy of the License at:
|
|
|
|
*
|
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
*
|
|
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
|
|
* License for the specific language governing permissions and limitations
|
|
|
|
* under the License.
|
|
|
|
*/
|
|
|
|
package io.netty.resolver.dns;
|
|
|
|
|
|
|
|
import io.netty.channel.EventLoop;
|
2016-07-29 10:30:08 +02:00
|
|
|
import io.netty.handler.codec.dns.DnsRecord;
|
2016-04-12 14:22:41 +02:00
|
|
|
import io.netty.util.internal.UnstableApi;
|
2016-01-07 17:49:15 +01:00
|
|
|
|
|
|
|
import java.net.InetAddress;
|
|
|
|
import java.util.List;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* A cache for DNS resolution entries.
|
|
|
|
*/
|
2016-04-12 14:22:41 +02:00
|
|
|
@UnstableApi
|
2016-01-07 17:49:15 +01:00
|
|
|
public interface DnsCache {
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Clears all the resolved addresses cached by this resolver.
|
|
|
|
*
|
|
|
|
* @see #clear(String)
|
|
|
|
*/
|
|
|
|
void clear();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Clears the resolved addresses of the specified host name from the cache of this resolver.
|
|
|
|
*
|
|
|
|
* @return {@code true} if and only if there was an entry for the specified host name in the cache and
|
|
|
|
* it has been removed by this method
|
|
|
|
*/
|
|
|
|
boolean clear(String hostname);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Return the cached entries for the given hostname.
|
|
|
|
* @param hostname the hostname
|
2016-07-29 10:30:08 +02:00
|
|
|
* @param additionals the additional records
|
2016-01-07 17:49:15 +01:00
|
|
|
* @return the cached entries
|
|
|
|
*/
|
2017-08-19 04:16:51 +02:00
|
|
|
List<? extends DnsCacheEntry> get(String hostname, DnsRecord[] additionals);
|
2016-01-07 17:49:15 +01:00
|
|
|
|
|
|
|
/**
|
2017-08-19 04:16:51 +02:00
|
|
|
* Create a new {@link DnsCacheEntry} and cache a resolved address for a given hostname.
|
2016-01-07 17:49:15 +01:00
|
|
|
* @param hostname the hostname
|
2016-07-29 10:30:08 +02:00
|
|
|
* @param additionals the additional records
|
2017-04-19 22:37:03 +02:00
|
|
|
* @param address the resolved address
|
2016-01-07 17:49:15 +01:00
|
|
|
* @param originalTtl the TLL as returned by the DNS server
|
|
|
|
* @param loop the {@link EventLoop} used to register the TTL timeout
|
2017-08-19 04:16:51 +02:00
|
|
|
* @return The {@link DnsCacheEntry} corresponding to this cache entry.
|
2016-01-07 17:49:15 +01:00
|
|
|
*/
|
2017-08-19 04:16:51 +02:00
|
|
|
DnsCacheEntry cache(String hostname, DnsRecord[] additionals, InetAddress address, long originalTtl,
|
|
|
|
EventLoop loop);
|
2016-01-07 17:49:15 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Cache the resolution failure for a given hostname.
|
|
|
|
* @param hostname the hostname
|
2016-07-29 10:30:08 +02:00
|
|
|
* @param additionals the additional records
|
2016-01-07 17:49:15 +01:00
|
|
|
* @param cause the resolution failure
|
|
|
|
* @param loop the {@link EventLoop} used to register the TTL timeout
|
2017-08-19 04:16:51 +02:00
|
|
|
* @return The {@link DnsCacheEntry} corresponding to this cache entry, or {@code null} if this cache doesn't
|
|
|
|
* support caching failed responses.
|
2016-01-07 17:49:15 +01:00
|
|
|
*/
|
2017-08-19 04:16:51 +02:00
|
|
|
DnsCacheEntry cache(String hostname, DnsRecord[] additionals, Throwable cause, EventLoop loop);
|
2016-01-07 17:49:15 +01:00
|
|
|
}
|